blob: cf4cc23cd376c6d628c31b1e504a6250c5890628 [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
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010022#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010023
24#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030025
John Durkop07cc04a2020-11-16 22:08:34 -080026#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
27#include "check_crypto_config.h"
28#endif
29
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010031#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010032
Ronald Crond6d28882020-12-14 14:56:02 +010033#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010034#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010035#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020036#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010037#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010038#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010039#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010040#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010041#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010042#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020044#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020045#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010046#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010047/* Include internal declarations that are useful for implementing persistently
48 * stored keys. */
49#include "psa_crypto_storage.h"
50
Gilles Peskineb2b64d32020-12-14 16:43:58 +010051#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010052
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include <stdlib.h>
54#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010056
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010057#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020058#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000059#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020060#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020062#include "mbedtls/chacha20.h"
63#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/cipher.h"
65#include "mbedtls/ccm.h"
66#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020068#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010070#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/error.h"
72#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010074#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000075#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010076#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010078#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000079#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010080#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010081#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/sha1.h"
83#include "mbedtls/sha256.h"
84#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020085#include "md_psa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010086
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020087#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
88 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
89 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020090#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020091#endif
92
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010093/****************************************************************/
94/* Global data, support functions and library management */
95/****************************************************************/
96
Gilles Peskine449bd832023-01-11 14:50:10 +010097static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020098{
Gilles Peskine449bd832023-01-11 14:50:10 +010099 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200100}
101
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100102/* Values for psa_global_data_t::rng_state */
103#define RNG_NOT_INITIALIZED 0
104#define RNG_INITIALIZED 1
105#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100106
Gilles Peskine449bd832023-01-11 14:50:10 +0100107typedef struct {
Gilles Peskinec6b69072018-11-20 21:42:52 +0100108 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100109 unsigned rng_state : 2;
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100110 unsigned drivers_initialized : 1;
Gilles Peskine2d8a1822021-11-08 22:20:03 +0100111 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100112} psa_global_data_t;
113
114static psa_global_data_t global_data;
115
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100116#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
117mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
118 &global_data.rng.drbg;
119#endif
120
itayzafrir0adf0fc2018-09-06 16:24:41 +0300121#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 if (global_data.initialized == 0) \
123 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100125int psa_can_do_hash(psa_algorithm_t hash_alg)
126{
127 (void) hash_alg;
128 return global_data.drivers_initialized;
129}
Valerio Setti8bb57632023-05-26 13:48:07 +0200130#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200131 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Setti8bb57632023-05-26 13:48:07 +0200132 defined(MBEDTLS_PSA_WANT_KEY_TYPE_DH_KEY_PAIR_LEGACY)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200133static int psa_is_dh_key_size_valid(size_t bits)
134{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200135 if (bits != 2048 && bits != 3072 && bits != 4096 &&
136 bits != 6144 && bits != 8192) {
137 return 0;
138 }
139
140 return 1;
141}
Valerio Setti8bb57632023-05-26 13:48:07 +0200142#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200143 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Setti8bb57632023-05-26 13:48:07 +0200144 MBEDTLS_PSA_WANT_KEY_TYPE_DH_KEY_PAIR_LEGACY */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100147{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100148 /* Mbed TLS error codes can combine a high-level error code and a
149 * low-level error code. The low-level error usually reflects the
150 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 int low_level_ret = -(-ret & 0x007f);
152 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100153 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100155
156 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
157 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
160 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
161 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
162 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
163 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200165 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200167 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskine9a944802018-06-21 09:35:35 +0200169
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000171 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100175
176 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100177 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100178 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine26869f22019-05-06 15:25:00 +0200181 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100182 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine26869f22019-05-06 15:25:00 +0200183
184 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;
Gilles Peskine26869f22019-05-06 15:25:00 +0200188
Gilles Peskinea5905292018-02-07 20:59:33 +0100189 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100191 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100193 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100195 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100203
Gilles Peskine449bd832023-01-11 14:50:10 +0100204#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
205 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100206 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
207 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100208 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100210 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
211 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100213 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100215#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100216
217 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100219
Gilles Peskinee59236f2018-01-27 23:32:46 +0100220 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
221 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
222 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100224
225 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200227 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100229 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100231
Gilles Peskine82e57d12020-11-13 21:31:17 +0100232#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100234 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
235 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100236 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100238 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
239 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100241 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100243#endif
244
Gilles Peskinea5905292018-02-07 20:59:33 +0100245 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100247 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100249 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100251 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100272 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200294 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100296
Gilles Peskineff2d2002019-05-06 15:26:23 +0200297 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200299 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200301
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100304 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100306 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100308 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100310 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
311 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100313 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100315 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100317 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200319
itayzafrir5c753392018-05-08 11:18:38 +0300320 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300321 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300323 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300325 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300327 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
328 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300330 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100332 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100334
Paul Elliott588f8ed2022-12-02 18:10:26 +0000335 case MBEDTLS_ERR_ECP_IN_PROGRESS:
336 return PSA_OPERATION_INCOMPLETE;
337
Janos Follatha13b9052019-11-22 12:48:59 +0000338 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300340
Gilles Peskinee59236f2018-01-27 23:32:46 +0100341 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100343 }
344}
345
Paul Elliottdc42ca82023-02-24 18:11:59 +0000346/**
347 * \brief For output buffers which contain "tags"
348 * (outputs that may be checked for validity like
349 * hashes, MACs and signatures), fill the unused
350 * part of the output buffer (the whole buffer on
351 * error, the trailing part on success) with
352 * something that isn't a valid tag (barring an
353 * attack on the tag and deliberately-crafted
354 * input), in case the caller doesn't check the
355 * return status properly.
356 *
357 * \param output_buffer Pointer to buffer to wipe. May not be NULL
358 * unless \p output_buffer_size is zero.
359 * \param status Status of function called to generate
360 * output_buffer originally
361 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
362 * could be NULL.
363 * \param output_buffer_length Length of data written to output_buffer, must be
364 * less than \p output_buffer_size
365 */
366static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000367 size_t output_buffer_size, size_t output_buffer_length)
368{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000369 size_t offset = 0;
370
371 if (output_buffer_size == 0) {
372 /* If output_buffer_size is 0 then we have nothing to do. We must not
373 call memset because output_buffer may be NULL in this case */
374 return;
375 }
376
377 if (status == PSA_SUCCESS) {
378 offset = output_buffer_length;
379 }
380
381 memset(output_buffer + offset, '!', output_buffer_size - offset);
382}
383
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200384
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200385
386
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100387/****************************************************************/
388/* Key management */
389/****************************************************************/
390
Valerio Settia9aab1a2023-06-19 13:39:54 +0200391#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200392psa_ecc_family_t mbedtls_ecc_group_to_psa(mbedtls_ecp_group_id grpid,
393 size_t *bits)
394{
395 switch (grpid) {
396 case MBEDTLS_ECP_DP_SECP192R1:
397 *bits = 192;
398 return PSA_ECC_FAMILY_SECP_R1;
399 case MBEDTLS_ECP_DP_SECP224R1:
400 *bits = 224;
401 return PSA_ECC_FAMILY_SECP_R1;
402 case MBEDTLS_ECP_DP_SECP256R1:
403 *bits = 256;
404 return PSA_ECC_FAMILY_SECP_R1;
405 case MBEDTLS_ECP_DP_SECP384R1:
406 *bits = 384;
407 return PSA_ECC_FAMILY_SECP_R1;
408 case MBEDTLS_ECP_DP_SECP521R1:
409 *bits = 521;
410 return PSA_ECC_FAMILY_SECP_R1;
411 case MBEDTLS_ECP_DP_BP256R1:
412 *bits = 256;
413 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
414 case MBEDTLS_ECP_DP_BP384R1:
415 *bits = 384;
416 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
417 case MBEDTLS_ECP_DP_BP512R1:
418 *bits = 512;
419 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
420 case MBEDTLS_ECP_DP_CURVE25519:
421 *bits = 255;
422 return PSA_ECC_FAMILY_MONTGOMERY;
423 case MBEDTLS_ECP_DP_SECP192K1:
424 *bits = 192;
425 return PSA_ECC_FAMILY_SECP_K1;
426 case MBEDTLS_ECP_DP_SECP224K1:
427 *bits = 224;
428 return PSA_ECC_FAMILY_SECP_K1;
429 case MBEDTLS_ECP_DP_SECP256K1:
430 *bits = 256;
431 return PSA_ECC_FAMILY_SECP_K1;
432 case MBEDTLS_ECP_DP_CURVE448:
433 *bits = 448;
434 return PSA_ECC_FAMILY_MONTGOMERY;
435 default:
436 *bits = 0;
437 return 0;
438 }
439}
440
Gilles Peskine449bd832023-01-11 14:50:10 +0100441mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
442 size_t bits,
443 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200444{
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100446 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100448#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100449 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100451#endif
452#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100453 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100455#endif
456#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100457 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100459#endif
460#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100461 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100463#endif
464#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100465 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100467 case 528:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 if (bits_is_sloppy) {
469 return MBEDTLS_ECP_DP_SECP521R1;
470 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100471 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100472#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100473 }
474 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100475
Paul Elliott8ff510a2020-06-02 17:19:28 +0100476 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100478#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100479 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100481#endif
482#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100483 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100485#endif
486#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100487 case 512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100489#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100490 }
491 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100492
Paul Elliott8ff510a2020-06-02 17:19:28 +0100493 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100495#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100496 case 255:
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100498 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 if (bits_is_sloppy) {
500 return MBEDTLS_ECP_DP_CURVE25519;
501 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100502 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100503#endif
504#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100505 case 448:
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100507#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100508 }
509 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100510
Paul Elliott8ff510a2020-06-02 17:19:28 +0100511 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100513#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100514 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100516#endif
517#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100518 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100520#endif
521#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100522 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100524#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100525 }
526 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200527 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100528
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100529 (void) bits_is_sloppy;
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200531}
Valerio Settia9aab1a2023-06-19 13:39:54 +0200532#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200533
Gilles Peskine449bd832023-01-11 14:50:10 +0100534psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
535 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200536{
537 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200539 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200540 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200541 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200542 case PSA_KEY_TYPE_PASSWORD:
543 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200544 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100545#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200546 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 if (bits != 128 && bits != 192 && bits != 256) {
548 return PSA_ERROR_INVALID_ARGUMENT;
549 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200550 break;
551#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200552#if defined(PSA_WANT_KEY_TYPE_ARIA)
553 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 if (bits != 128 && bits != 192 && bits != 256) {
555 return PSA_ERROR_INVALID_ARGUMENT;
556 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200557 break;
558#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100559#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200560 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 if (bits != 128 && bits != 192 && bits != 256) {
562 return PSA_ERROR_INVALID_ARGUMENT;
563 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200564 break;
565#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100566#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200567 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 if (bits != 64 && bits != 128 && bits != 192) {
569 return PSA_ERROR_INVALID_ARGUMENT;
570 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200571 break;
572#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100573#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200574 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 if (bits != 256) {
576 return PSA_ERROR_INVALID_ARGUMENT;
577 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200578 break;
579#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200580 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200582 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 if (bits % 8 != 0) {
584 return PSA_ERROR_INVALID_ARGUMENT;
585 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200586
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200588}
589
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100590/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100591 *
Steven Cooremancd640932021-03-08 12:00:27 +0100592 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
593 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100594 *
595 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100596 * \param[in] key_type The key type of the key to be used with the
597 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100598 *
599 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100600 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100601 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100602 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100603 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100604MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100605 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100607{
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 if (PSA_ALG_IS_HMAC(algorithm)) {
609 if (key_type == PSA_KEY_TYPE_HMAC) {
610 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100611 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100612 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100613
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
615 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
616 * key. */
617 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
618 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
619 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
620 * the block length (larger than 1) for block ciphers. */
621 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
622 return PSA_SUCCESS;
623 }
624 }
625 }
626
627 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100628}
629
Gilles Peskine449bd832023-01-11 14:50:10 +0100630psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
631 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200632{
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 if (slot->key.data != NULL) {
634 return PSA_ERROR_ALREADY_EXISTS;
635 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200636
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 slot->key.data = mbedtls_calloc(1, buffer_length);
638 if (slot->key.data == NULL) {
639 return PSA_ERROR_INSUFFICIENT_MEMORY;
640 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200641
Ronald Cronea0f8a62020-11-25 17:52:23 +0100642 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200644}
645
Gilles Peskine449bd832023-01-11 14:50:10 +0100646psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
647 const uint8_t *data,
648 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200649{
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 psa_status_t status = psa_allocate_buffer_to_slot(slot,
651 data_length);
652 if (status != PSA_SUCCESS) {
653 return status;
654 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200655
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 memcpy(slot->key.data, data, data_length);
657 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200658}
659
Ronald Crona0fe59f2020-11-29 11:14:53 +0100660psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100661 const psa_key_attributes_t *attributes,
662 const uint8_t *data, size_t data_length,
663 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100665{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
667 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100668
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200669 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 if (data_length == 0) {
671 return PSA_ERROR_NOT_SUPPORTED;
672 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 if (key_type_is_raw_bytes(type)) {
675 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
678 *bits);
679 if (status != PSA_SUCCESS) {
680 return status;
681 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200682
Ronald Crondd04d422020-11-28 15:14:42 +0100683 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100685 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200687
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return PSA_SUCCESS;
689 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Setti8bb57632023-05-26 13:48:07 +0200690#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200691 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100692 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200693 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100694 return PSA_ERROR_INVALID_ARGUMENT;
695 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200696 return mbedtls_psa_ffdh_import_key(attributes,
697 data, data_length,
698 key_buffer, key_buffer_size,
699 key_buffer_length,
700 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100701 }
Valerio Setti8bb57632023-05-26 13:48:07 +0200702#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200703 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti8bb57632023-05-26 13:48:07 +0200704#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_LEGACY) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
706 if (PSA_KEY_TYPE_IS_ECC(type)) {
707 return mbedtls_psa_ecp_import_key(attributes,
708 data, data_length,
709 key_buffer, key_buffer_size,
710 key_buffer_length,
711 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100712 }
Valerio Setti8bb57632023-05-26 13:48:07 +0200713#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_LEGACY) ||
John Durkop9814fa22020-11-04 12:28:15 -0800714 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Setti8bb57632023-05-26 13:48:07 +0200715#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
717 if (PSA_KEY_TYPE_IS_RSA(type)) {
718 return mbedtls_psa_rsa_import_key(attributes,
719 data, data_length,
720 key_buffer, key_buffer_size,
721 key_buffer_length,
722 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200723 }
Valerio Setti8bb57632023-05-26 13:48:07 +0200724#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) ||
John Durkop9814fa22020-11-04 12:28:15 -0800725 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100726 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100729}
730
Gilles Peskinef603c712019-01-19 13:40:11 +0100731/** Calculate the intersection of two algorithm usage policies.
732 *
733 * Return 0 (which allows no operation) on incompatibility.
734 */
735static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100736 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100737 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100739{
Gilles Peskine549ea862019-05-22 11:45:59 +0200740 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 if (alg1 == alg2) {
742 return alg1;
743 }
Steven Cooreman03488022021-02-18 12:07:20 +0100744 /* If the policies are from the same hash-and-sign family, check
745 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
747 PSA_ALG_IS_SIGN_HASH(alg2) &&
748 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
749 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
750 return alg2;
751 }
752 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
753 return alg1;
754 }
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100757 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100758 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
760 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
761 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
762 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
763 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100764 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100765
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100766 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
768 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
769 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
770 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100771 }
772 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
774 (alg1_len <= alg2_len)) {
775 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100776 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
778 (alg2_len <= alg1_len)) {
779 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100780 }
781 }
782 /* If the policies are from the same MAC family, check whether one
783 * of them is a minimum-MAC-length policy. Calculate the most
784 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
786 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
787 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100788 /* Validate the combination of key type and algorithm. Since the base
789 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
791 return 0;
792 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100793
Steven Cooreman31a876d2021-03-03 20:47:40 +0100794 /* Get the (exact or at-least) output lengths for both sides of the
795 * requested intersection. None of the currently supported algorithms
796 * have an output length dependent on the actual key size, so setting it
797 * to a bogus value of 0 is currently OK.
798 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100799 * Note that for at-least-this-length wildcard algorithms, the output
800 * length is set to the shortest allowed length, which allows us to
801 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
803 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100804 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100805
Steven Cooremana1d83222021-02-25 10:20:29 +0100806 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
808 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
809 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100810 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811
812 /* If only one is an at-least-this-length policy, the intersection would
813 * be the other (fixed-length) policy as long as said fixed length is
814 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
816 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100817 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
819 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100820 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100821
Steven Cooremancd640932021-03-08 12:00:27 +0100822 /* If none of them are wildcards, check whether they define the same tag
823 * length. This is still possible here when one is default-length and
824 * the other specific-length. Ensure to always return the
825 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 if (alg1_len == alg2_len) {
827 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
828 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100829 }
830 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100831 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100832}
833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834static int psa_key_algorithm_permits(psa_key_type_t key_type,
835 psa_algorithm_t policy_alg,
836 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200837{
Gilles Peskine549ea862019-05-22 11:45:59 +0200838 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 if (requested_alg == policy_alg) {
840 return 1;
841 }
Steven Cooreman03488022021-02-18 12:07:20 +0100842 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
843 * and requested_alg is the same hash-and-sign family with any hash,
844 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
846 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
847 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
848 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100849 }
850 /* If policy_alg is a wildcard AEAD algorithm of the same base as
851 * the requested algorithm, check the requested tag length to be
852 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 if (PSA_ALG_IS_AEAD(policy_alg) &&
854 PSA_ALG_IS_AEAD(requested_alg) &&
855 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
856 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
857 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
858 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
859 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100860 }
Steven Cooremancd640932021-03-08 12:00:27 +0100861 /* If policy_alg is a MAC algorithm of the same base as the requested
862 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 if (PSA_ALG_IS_MAC(policy_alg) &&
864 PSA_ALG_IS_MAC(requested_alg) &&
865 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
866 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100867 /* Validate the combination of key type and algorithm. Since the policy
868 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
870 return 0;
871 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100872
Steven Cooreman31a876d2021-03-03 20:47:40 +0100873 /* Get both the requested output length for the algorithm which is to be
874 * verified, and the default output length for the base algorithm.
875 * Note that none of the currently supported algorithms have an output
876 * length dependent on actual key size, so setting it to a bogus value
877 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100878 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100880 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 key_type, 0,
882 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100883
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100884 /* If the policy is default-length, only allow an algorithm with
885 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
887 return requested_output_length == default_output_length;
888 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100889
890 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100891 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
893 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
894 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100895 }
896
Steven Cooremancd640932021-03-08 12:00:27 +0100897 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
898 * check for the requested MAC length to be equal to or longer than the
899 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
901 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
902 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100903 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200904 }
Steven Cooremance48e852020-10-05 16:02:45 +0200905 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200906 * a key derivation with that key agreement should also be allowed. This
907 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
909 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
910 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
911 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200912 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100913 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100914 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200915}
916
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100917/** Test whether a policy permits an algorithm.
918 *
919 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100920 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100921 * \note This function requires providing the key type for which the policy is
922 * being validated, since some algorithm policy definitions (e.g. MAC)
923 * have different properties depending on what kind of cipher it is
924 * combined with.
925 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100926 * \retval PSA_SUCCESS When \p alg is a specific algorithm
927 * allowed by the \p policy.
928 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
929 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
930 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100931 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100932static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
933 psa_key_type_t key_type,
934 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100935{
Steven Cooremand788fab2021-02-25 11:29:17 +0100936 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 if (alg == 0) {
938 return PSA_ERROR_INVALID_ARGUMENT;
939 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100940
Steven Cooreman7e39f052021-02-23 14:18:32 +0100941 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 if (PSA_ALG_IS_WILDCARD(alg)) {
943 return PSA_ERROR_INVALID_ARGUMENT;
944 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100945
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
947 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
948 return PSA_SUCCESS;
949 } else {
950 return PSA_ERROR_NOT_PERMITTED;
951 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100952}
953
Gilles Peskinef603c712019-01-19 13:40:11 +0100954/** Restrict a key policy based on a constraint.
955 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100956 * \note This function requires providing the key type for which the policy is
957 * being restricted, since some algorithm policy definitions (e.g. MAC)
958 * have different properties depending on what kind of cipher it is
959 * combined with.
960 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100961 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100962 * \param[in,out] policy The policy to restrict.
963 * \param[in] constraint The policy constraint to apply.
964 *
965 * \retval #PSA_SUCCESS
966 * \c *policy contains the intersection of the original value of
967 * \c *policy and \c *constraint.
968 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100969 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100970 * \c *policy is unchanged.
971 */
972static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100973 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100974 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100976{
977 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 psa_key_policy_algorithm_intersection(key_type, policy->alg,
979 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200980 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
982 constraint->alg2);
983 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
984 return PSA_ERROR_INVALID_ARGUMENT;
985 }
986 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
987 return PSA_ERROR_INVALID_ARGUMENT;
988 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100989 policy->usage &= constraint->usage;
990 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200991 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100993}
994
Przemek Stekiel061f6942022-11-30 10:51:35 +0100995/** Get the description of a key given its identifier and policy constraints
996 * and lock it.
997 *
998 * The key must have allow all the usage flags set in \p usage. If \p alg is
999 * nonzero, the key must allow operations with this algorithm. If \p alg is
1000 * zero, the algorithm is not checked.
1001 *
1002 * In case of a persistent key, the function loads the description of the key
1003 * into a key slot if not already done.
1004 *
1005 * On success, the returned key slot is locked. It is the responsibility of
1006 * the caller to unlock the key slot when it does not access it anymore.
1007 */
1008static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001009 mbedtls_svc_key_id_t key,
1010 psa_key_slot_t **p_slot,
1011 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001013{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001014 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001015 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 status = psa_get_and_lock_key_slot(key, p_slot);
1018 if (status != PSA_SUCCESS) {
1019 return status;
1020 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001021 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001022
1023 /* Enforce that usage policy for the key slot contains all the flags
1024 * required by the usage parameter. There is one exception: public
1025 * keys can always be exported, so we treat public key objects as
1026 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001028 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001032 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001033 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001034 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001035
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001036 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 if (alg != 0) {
1038 status = psa_key_policy_permits(&slot->attr.policy,
1039 slot->attr.type,
1040 alg);
1041 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001042 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001044 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001045
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001047
1048error:
1049 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001051
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001053}
Darryl Green940d72c2018-07-13 13:18:51 +01001054
Ronald Cron5c522922020-11-14 16:35:34 +01001055/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001056 *
1057 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001058 * available, as opposed to a key in a secure element and/or to be used
1059 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001060 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001061 * This is a temporary function that may be used instead of
1062 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1063 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001064 *
Ronald Cron5c522922020-11-14 16:35:34 +01001065 * On success, the returned key slot is locked. It is the responsibility of the
1066 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001067 */
Ronald Cron5c522922020-11-14 16:35:34 +01001068static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1069 mbedtls_svc_key_id_t key,
1070 psa_key_slot_t **p_slot,
1071 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001073{
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1075 usage, alg);
1076 if (status != PSA_SUCCESS) {
1077 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001078 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1081 psa_unlock_key_slot(*p_slot);
1082 *p_slot = NULL;
1083 return PSA_ERROR_NOT_SUPPORTED;
1084 }
1085
1086 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001087}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001088
Gilles Peskine449bd832023-01-11 14:50:10 +01001089psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001090{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001091 /* Data pointer will always be either a valid pointer or NULL in an
1092 * initialized slot, so we can just free it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 if (slot->key.data != NULL) {
1094 mbedtls_platform_zeroize(slot->key.data, slot->key.bytes);
1095 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 mbedtls_free(slot->key.data);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001098 slot->key.data = NULL;
1099 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001102}
1103
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001104/** Completely wipe a slot in memory, including its policy.
1105 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001106psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001107{
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 /*
1111 * As the return error code may not be handled in case of multiple errors,
1112 * do our best to report an unexpected lock counter. Assert with
1113 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1114 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1115 * function is called as part of the execution of a test suite, the
1116 * execution of the test suite is stopped in error if the assertion fails.
1117 */
1118 if (slot->lock_count != 1) {
1119 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001120 status = PSA_ERROR_CORRUPTION_DETECTED;
1121 }
1122
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001123 /* Multipart operations may still be using the key. This is safe
1124 * because all multipart operation objects are independent from
1125 * the key slot: if they need to access the key after the setup
1126 * phase, they have a copy of the key. Note that this means that
1127 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001128 /* At this point, key material and other type-specific content has
1129 * been wiped. Clear remaining metadata. We can call memset and not
1130 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 memset(slot, 0, sizeof(*slot));
1132 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001133}
1134
Gilles Peskine449bd832023-01-11 14:50:10 +01001135psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001136{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001137 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001138 psa_status_t status; /* status of the last operation */
1139 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001140#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1141 psa_se_drv_table_entry_t *driver;
1142#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (mbedtls_svc_key_id_is_null(key)) {
1145 return PSA_SUCCESS;
1146 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001147
Ronald Cronf2911112020-10-29 17:51:10 +01001148 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001149 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001150 * key, this will load the key description from persistent memory if not
1151 * done yet. We cannot avoid this loading as without it we don't know if
1152 * the key is operated by an SE or not and this information is needed by
1153 * the current implementation.
1154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 status = psa_get_and_lock_key_slot(key, &slot);
1156 if (status != PSA_SUCCESS) {
1157 return status;
1158 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001159
Ronald Cronf2911112020-10-29 17:51:10 +01001160 /*
1161 * If the key slot containing the key description is under access by the
1162 * library (apart from the present access), the key cannot be destroyed
1163 * yet. For the time being, just return in error. Eventually (to be
1164 * implemented), the key should be destroyed when all accesses have
1165 * stopped.
1166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 if (slot->lock_count > 1) {
1168 psa_unlock_key_slot(slot);
1169 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001170 }
1171
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001173 /* Refuse the destruction of a read-only key (which may or may not work
1174 * if we attempt it, depending on whether the key is merely read-only
1175 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001176 * Just do the best we can, which is to wipe the copy in memory
1177 * (done in this function's cleanup code). */
1178 overall_status = PSA_ERROR_NOT_PERMITTED;
1179 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001180 }
1181
Gilles Peskine354f7672019-07-12 23:46:38 +02001182#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1184 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001185 /* For a key in a secure element, we need to do three things:
1186 * remove the key file in internal storage, destroy the
1187 * key inside the secure element, and update the driver's
1188 * persistent data. Start a transaction that will encompass these
1189 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001191 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001193 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 status = psa_crypto_save_transaction();
1195 if (status != PSA_SUCCESS) {
1196 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001197 /* We should still try to destroy the key in the secure
1198 * element and the key metadata in storage. This is especially
1199 * important if the error is that the storage is full.
1200 * But how to do it exactly without risking an inconsistent
1201 * state after a reset?
1202 * https://github.com/ARMmbed/mbed-crypto/issues/215
1203 */
1204 overall_status = status;
1205 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001206 }
1207
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 status = psa_destroy_se_key(driver,
1209 psa_key_slot_get_slot_number(slot));
1210 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001211 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001213 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001214#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1215
Darryl Greend49a4992018-06-18 17:27:26 +01001216#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1218 status = psa_destroy_persistent_key(slot->attr.id);
1219 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001220 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001222
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001223 /* TODO: other slots may have a copy of the same key. We should
1224 * invalidate them.
1225 * https://github.com/ARMmbed/mbed-crypto/issues/214
1226 */
Darryl Greend49a4992018-06-18 17:27:26 +01001227 }
1228#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001229
Gilles Peskinefc762652019-07-22 19:30:34 +02001230#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 if (driver != NULL) {
1232 status = psa_save_se_persistent_data(driver);
1233 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001234 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 }
1236 status = psa_crypto_stop_transaction();
1237 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001238 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001240 }
1241#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1242
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001243exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001245 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001246 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001247 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 }
1249 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001250}
1251
Valerio Setti8bb57632023-05-26 13:48:07 +02001252#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) || \
John Durkop0e005192020-10-31 22:06:54 -07001253 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001254static psa_status_t psa_get_rsa_public_exponent(
1255 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001257{
1258 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001259 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001260 uint8_t *buffer = NULL;
1261 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001263
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1265 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 }
1268 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001269 /* It's the default value, which is reported as an empty string,
1270 * so there's nothing to do. */
1271 goto exit;
1272 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 buflen = mbedtls_mpi_size(&mpi);
1275 buffer = mbedtls_calloc(1, buflen);
1276 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001277 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1278 goto exit;
1279 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1281 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001284 attributes->domain_parameters = buffer;
1285 attributes->domain_parameters_size = buflen;
1286
1287exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 mbedtls_mpi_free(&mpi);
1289 if (ret != 0) {
1290 mbedtls_free(buffer);
1291 }
1292 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001293}
Valerio Setti8bb57632023-05-26 13:48:07 +02001294#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) ||
John Durkop9814fa22020-11-04 12:28:15 -08001295 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001296
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001297/** Retrieve all the publicly-accessible attributes of a key.
1298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001299psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1300 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001301{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001303 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001304 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001305
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001307
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1309 if (status != PSA_SUCCESS) {
1310 return status;
1311 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001312
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001313 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1315 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001316
1317#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1319 psa_set_key_slot_number(attributes,
1320 psa_key_slot_get_slot_number(slot));
1321 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001322#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 switch (slot->attr.type) {
Valerio Setti8bb57632023-05-26 13:48:07 +02001325#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) || \
John Durkop0e005192020-10-31 22:06:54 -07001326 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001327 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001328 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001329 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001330 * is not yet implemented.
1331 * https://github.com/ARMmbed/mbed-crypto/issues/216
1332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001334 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001335
Ronald Cron90857082020-11-25 14:58:33 +01001336 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 slot->attr.type,
1338 slot->key.data,
1339 slot->key.bytes,
1340 &rsa);
1341 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001342 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 status = psa_get_rsa_public_exponent(rsa,
1346 attributes);
1347 mbedtls_rsa_free(rsa);
1348 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001349 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001350 break;
Valerio Setti8bb57632023-05-26 13:48:07 +02001351#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) ||
John Durkop9814fa22020-11-04 12:28:15 -08001352 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001353 default:
1354 /* Nothing else to do. */
1355 break;
1356 }
1357
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 if (status != PSA_SUCCESS) {
1359 psa_reset_key_attributes(attributes);
1360 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001361
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001365}
1366
Gilles Peskinec8000c02019-08-02 20:15:51 +02001367#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1368psa_status_t psa_get_key_slot_number(
1369 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001371{
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001373 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 return PSA_SUCCESS;
1375 } else {
1376 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001377 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001378}
1379#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1380
Gilles Peskine449bd832023-01-11 14:50:10 +01001381static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1382 size_t key_buffer_size,
1383 uint8_t *data,
1384 size_t data_size,
1385 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001386{
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 if (key_buffer_size > data_size) {
1388 return PSA_ERROR_BUFFER_TOO_SMALL;
1389 }
1390 memcpy(data, key_buffer, key_buffer_size);
1391 memset(data + key_buffer_size, 0,
1392 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001393 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001395}
1396
Ronald Cron7285cda2020-11-26 14:46:37 +01001397psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001398 const psa_key_attributes_t *attributes,
1399 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001401{
Ronald Crond18b5f82020-11-25 16:46:05 +01001402 psa_key_type_t type = attributes->core.type;
1403
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 if (key_type_is_raw_bytes(type) ||
1405 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001406 PSA_KEY_TYPE_IS_ECC(type) ||
1407 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 return psa_export_key_buffer_internal(
1409 key_buffer, key_buffer_size,
1410 data, data_size, data_length);
1411 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001412 /* This shouldn't happen in the reference implementation, but
1413 it is valid for a special-purpose implementation to omit
1414 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001416 }
1417}
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1420 uint8_t *data,
1421 size_t data_size,
1422 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001423{
1424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1425 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1426 psa_key_slot_t *slot;
1427
Ronald Crone907e552021-01-18 13:22:38 +01001428 /* Reject a zero-length output buffer now, since this can never be a
1429 * valid key representation. This way we know that data must be a valid
1430 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 if (data_size == 0) {
1432 return PSA_ERROR_BUFFER_TOO_SMALL;
1433 }
Ronald Crone907e552021-01-18 13:22:38 +01001434
Ronald Cron9486f9d2020-11-26 13:36:23 +01001435 /* Set the key to empty now, so that even when there are errors, we always
1436 * set data_length to a value between 0 and data_size. On error, setting
1437 * the key to empty is a good choice because an empty key representation is
1438 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001439 *data_length = 0;
1440
Ronald Cron9486f9d2020-11-26 13:36:23 +01001441 /* Export requires the EXPORT flag. There is an exception for public keys,
1442 * which don't require any flag, but
1443 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1446 PSA_KEY_USAGE_EXPORT, 0);
1447 if (status != PSA_SUCCESS) {
1448 return status;
1449 }
mohammad160306e79202018-03-28 13:17:44 +03001450
Ronald Crond18b5f82020-11-25 16:46:05 +01001451 psa_key_attributes_t attributes = {
1452 .core = slot->attr
1453 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 status = psa_driver_wrapper_export_key(&attributes,
1455 slot->key.data, slot->key.bytes,
1456 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001459
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001461}
1462
Ronald Cron7285cda2020-11-26 14:46:37 +01001463psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001464 const psa_key_attributes_t *attributes,
1465 const uint8_t *key_buffer,
1466 size_t key_buffer_size,
1467 uint8_t *data,
1468 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001470{
Ronald Crond18b5f82020-11-25 16:46:05 +01001471 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001472
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001473 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001474 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1475 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001476 /* Exporting public -> public */
1477 return psa_export_key_buffer_internal(
1478 key_buffer, key_buffer_size,
1479 data, data_size, data_length);
1480 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Setti8bb57632023-05-26 13:48:07 +02001481#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001482 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1483 return mbedtls_psa_rsa_export_public_key(attributes,
1484 key_buffer,
1485 key_buffer_size,
1486 data,
1487 data_size,
1488 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001489#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001490 /* We don't know how to convert a private RSA key to public. */
1491 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti8bb57632023-05-26 13:48:07 +02001492#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) ||
John Durkop9814fa22020-11-04 12:28:15 -08001493 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001494 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti8bb57632023-05-26 13:48:07 +02001495#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_LEGACY) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001496 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1497 return mbedtls_psa_ecp_export_public_key(attributes,
1498 key_buffer,
1499 key_buffer_size,
1500 data,
1501 data_size,
1502 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001503#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001504 /* We don't know how to convert a private ECC key to public */
1505 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti8bb57632023-05-26 13:48:07 +02001506#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_LEGACY) ||
John Durkop9814fa22020-11-04 12:28:15 -08001507 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001508 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Setti8bb57632023-05-26 13:48:07 +02001509#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001510 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001511 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001512 key_buffer,
1513 key_buffer_size,
1514 data, data_size,
1515 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001516#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001517 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti8bb57632023-05-26 13:48:07 +02001518#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001519 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001521 (void) key_buffer;
1522 (void) key_buffer_size;
1523 (void) data;
1524 (void) data_size;
1525 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001527 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001528}
Ronald Crond18b5f82020-11-25 16:46:05 +01001529
Gilles Peskine449bd832023-01-11 14:50:10 +01001530psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1531 uint8_t *data,
1532 size_t data_size,
1533 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001534{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001535 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001536 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001537 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001538 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001539
Ronald Crone907e552021-01-18 13:22:38 +01001540 /* Reject a zero-length output buffer now, since this can never be a
1541 * valid key representation. This way we know that data must be a valid
1542 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 if (data_size == 0) {
1544 return PSA_ERROR_BUFFER_TOO_SMALL;
1545 }
Ronald Crone907e552021-01-18 13:22:38 +01001546
Darryl Greendd8fb772018-11-07 16:00:44 +00001547 /* Set the key to empty now, so that even when there are errors, we always
1548 * set data_length to a value between 0 and data_size. On error, setting
1549 * the key to empty is a good choice because an empty key representation is
1550 * unlikely to be accepted anywhere. */
1551 *data_length = 0;
1552
1553 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1555 if (status != PSA_SUCCESS) {
1556 return status;
1557 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001558
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1560 status = PSA_ERROR_INVALID_ARGUMENT;
1561 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001562 }
1563
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001564 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001565 .core = slot->attr
1566 };
Ronald Cron67227982020-11-26 15:16:05 +01001567 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001568 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001570
1571exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001573
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001575}
1576
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001577MBEDTLS_STATIC_ASSERT(
1578 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1579 "One or more key attribute flag is listed as both external-only and dual-use")
1580MBEDTLS_STATIC_ASSERT(
1581 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1582 "One or more key attribute flag is listed as both internal-only and dual-use")
1583MBEDTLS_STATIC_ASSERT(
1584 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1585 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001586
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001587/** Validate that a key policy is internally well-formed.
1588 *
1589 * This function only rejects invalid policies. It does not validate the
1590 * consistency of the policy with respect to other attributes of the key
1591 * such as the key type.
1592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001593static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001594{
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1596 PSA_KEY_USAGE_COPY |
1597 PSA_KEY_USAGE_ENCRYPT |
1598 PSA_KEY_USAGE_DECRYPT |
1599 PSA_KEY_USAGE_SIGN_MESSAGE |
1600 PSA_KEY_USAGE_VERIFY_MESSAGE |
1601 PSA_KEY_USAGE_SIGN_HASH |
1602 PSA_KEY_USAGE_VERIFY_HASH |
1603 PSA_KEY_USAGE_VERIFY_DERIVATION |
1604 PSA_KEY_USAGE_DERIVE)) != 0) {
1605 return PSA_ERROR_INVALID_ARGUMENT;
1606 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001607
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001609}
1610
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001611/** Validate the internal consistency of key attributes.
1612 *
1613 * This function only rejects invalid attribute values. If does not
1614 * validate the consistency of the attributes with any key data that may
1615 * be involved in the creation of the key.
1616 *
1617 * Call this function early in the key creation process.
1618 *
1619 * \param[in] attributes Key attributes for the new key.
1620 * \param[out] p_drv On any return, the driver for the key, if any.
1621 * NULL for a transparent key.
1622 *
1623 */
1624static psa_status_t psa_validate_key_attributes(
1625 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001627{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001628 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1630 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 status = psa_validate_key_location(lifetime, p_drv);
1633 if (status != PSA_SUCCESS) {
1634 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001635 }
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 status = psa_validate_key_persistence(lifetime);
1638 if (status != PSA_SUCCESS) {
1639 return status;
1640 }
1641
1642 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1643 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1644 return PSA_ERROR_INVALID_ARGUMENT;
1645 }
1646 } else {
1647 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1648 return PSA_ERROR_INVALID_ARGUMENT;
1649 }
1650 }
1651
1652 status = psa_validate_key_policy(&attributes->core.policy);
1653 if (status != PSA_SUCCESS) {
1654 return status;
1655 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001656
1657 /* Refuse to create overly large keys.
1658 * Note that this doesn't trigger on import if the attributes don't
1659 * explicitly specify a size (so psa_get_key_bits returns 0), so
1660 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1662 return PSA_ERROR_NOT_SUPPORTED;
1663 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001664
Gilles Peskine91e8c332019-08-02 19:19:39 +02001665 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1667 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1668 return PSA_ERROR_INVALID_ARGUMENT;
1669 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001672}
1673
Gilles Peskine4747d192019-04-17 15:05:45 +02001674/** Prepare a key slot to receive key material.
1675 *
1676 * This function allocates a key slot and sets its metadata.
1677 *
1678 * If this function fails, call psa_fail_key_creation().
1679 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001680 * This function is intended to be used as follows:
1681 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001682 * it with the specified attributes, and in case of a volatile key assign it
1683 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001684 * -# Populate the slot with the key material.
1685 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1686 * In case of failure at any step, stop the sequence and call
1687 * psa_fail_key_creation().
1688 *
Ronald Cron5c522922020-11-14 16:35:34 +01001689 * On success, the key slot is locked. It is the responsibility of the caller
1690 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001691 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001692 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001693 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001694 * \param[out] p_slot On success, a pointer to the prepared slot.
1695 * \param[out] p_drv On any return, the driver for the key, if any.
1696 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001697 *
1698 * \retval #PSA_SUCCESS
1699 * The key slot is ready to receive key material.
1700 * \return If this function fails, the key slot is an invalid state.
1701 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 */
1703static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001704 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001705 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001706 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001708{
1709 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001710 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001711 psa_key_slot_t *slot;
1712
Gilles Peskinedf179142019-07-15 22:02:14 +02001713 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001714 *p_drv = NULL;
1715
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 status = psa_validate_key_attributes(attributes, p_drv);
1717 if (status != PSA_SUCCESS) {
1718 return status;
1719 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001720
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1722 if (status != PSA_SUCCESS) {
1723 return status;
1724 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001725 slot = *p_slot;
1726
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001727 /* We're storing the declared bit-size of the key. It's up to each
1728 * creation mechanism to verify that this information is correct.
1729 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001730 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001731 * is optional (import, copy). In case of a volatile key, assign it the
1732 * volatile key identifier associated to the slot returned to contain its
1733 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001734
1735 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001737#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1738 slot->attr.id = volatile_key_id;
1739#else
1740 slot->attr.id.key_id = volatile_key_id;
1741#endif
1742 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001743
Gilles Peskine91e8c332019-08-02 19:19:39 +02001744 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001745 * external-only flags, query `attributes`. Thanks to the check
1746 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001747 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001748 * may have set. */
1749 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001750
Gilles Peskinecbaff462019-07-12 23:46:04 +02001751#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001752 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001753 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001754 * create the key file in internal storage, create the
1755 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001756 * persistent data. This is done by starting a transaction that will
1757 * encompass these three actions.
1758 * For registering a volatile key, we just need to find an appropriate
1759 * slot number inside the SE. Since the key is designated volatile, creating
1760 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001761 /* The first thing to do is to find a slot number for the new key.
1762 * We save the slot number in persistent storage as part of the
1763 * transaction data. It will be needed to recover if the power
1764 * fails during the key creation process, to clean up on the secure
1765 * element side after restarting. Obtaining a slot number from the
1766 * secure element driver updates its persistent state, but we do not yet
1767 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001768 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001770 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1772 &slot_number);
1773 if (status != PSA_SUCCESS) {
1774 return status;
1775 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001776
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1778 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001779 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001780 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001781 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 status = psa_crypto_save_transaction();
1783 if (status != PSA_SUCCESS) {
1784 (void) psa_crypto_stop_transaction();
1785 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001786 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001787 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001788
1789 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001791 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001792
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001794 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001796 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001797#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001800}
Gilles Peskine4747d192019-04-17 15:05:45 +02001801
1802/** Finalize the creation of a key once its key material has been set.
1803 *
1804 * This entails writing the key to persistent storage.
1805 *
1806 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001807 * See the documentation of psa_start_key_creation() for the intended use
1808 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001809 *
Ronald Cron5c522922020-11-14 16:35:34 +01001810 * If the finalization succeeds, the function unlocks the key slot (it was
1811 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1812 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001813 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001814 * \param[in,out] slot Pointer to the slot with key material.
1815 * \param[in] driver The secure element driver for the key,
1816 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001817 * \param[out] key On success, identifier of the key. Note that the
1818 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001819 *
1820 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001821 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001822 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1823 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1824 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1825 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1826 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1827 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001828 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001829 * \return If this function fails, the key slot is an invalid state.
1830 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001831 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001832static psa_status_t psa_finish_key_creation(
1833 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001834 psa_se_drv_table_entry_t *driver,
1835 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001836{
1837 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001838 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001839 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001840
1841#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001843#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001845 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001846 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001848
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001849 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1850 sizeof(data.slot_number),
1851 "Slot number size does not match psa_se_key_data_storage_t");
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1854 status = psa_save_persistent_key(&slot->attr,
1855 (uint8_t *) &data,
1856 sizeof(data));
1857 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001858#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1859 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001860 /* Key material is saved in export representation in the slot, so
1861 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 status = psa_save_persistent_key(&slot->attr,
1863 slot->key.data,
1864 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001865 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001866 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001867#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1868
Gilles Peskinecbaff462019-07-12 23:46:04 +02001869#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001870 /* Finish the transaction for a key creation. This does not
1871 * happen when registering an existing key. Detect this case
1872 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001873 * creation of a persistent key in a secure element requires a transaction,
1874 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 if (driver != NULL &&
1876 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1877 status = psa_save_se_persistent_data(driver);
1878 if (status != PSA_SUCCESS) {
1879 psa_destroy_persistent_key(slot->attr.id);
1880 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001881 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001883 }
1884#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001887 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 status = psa_unlock_key_slot(slot);
1889 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001890 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001892 }
Ronald Cron50972942020-11-14 11:28:25 +01001893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001895}
1896
1897/** Abort the creation of a key.
1898 *
1899 * You may call this function after calling psa_start_key_creation(),
1900 * or after psa_finish_key_creation() fails. In other circumstances, this
1901 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001902 * See the documentation of psa_start_key_creation() for the intended use
1903 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001904 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001905 * \param[in,out] slot Pointer to the slot with key material.
1906 * \param[in] driver The secure element driver for the key,
1907 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001909static void psa_fail_key_creation(psa_key_slot_t *slot,
1910 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001911{
Gilles Peskine011e4282019-06-26 18:34:38 +02001912 (void) driver;
1913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001915 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001917
1918#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001919 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001920 * element, and the failure happened later (when saving metadata
1921 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001922 * element.
1923 * https://github.com/ARMmbed/mbed-crypto/issues/217
1924 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001925
Gilles Peskined7729582019-08-05 15:55:54 +02001926 /* Abort the ongoing transaction if any (there may not be one if
1927 * the creation process failed before starting one, or if the
1928 * key creation is a registration of a key in a secure element).
1929 * Earlier functions must already have done what it takes to undo any
1930 * partial creation. All that's left is to update the transaction data
1931 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001933#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001936}
1937
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001938/** Validate optional attributes during key creation.
1939 *
1940 * Some key attributes are optional during key creation. If they are
1941 * specified in the attributes structure, check that they are consistent
1942 * with the data in the slot.
1943 *
1944 * This function should be called near the end of key creation, after
1945 * the slot in memory is fully populated but before saving persistent data.
1946 */
1947static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001948 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001950{
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 if (attributes->core.type != 0) {
1952 if (attributes->core.type != slot->attr.type) {
1953 return PSA_ERROR_INVALID_ARGUMENT;
1954 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955 }
1956
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (attributes->domain_parameters_size != 0) {
Valerio Setti8bb57632023-05-26 13:48:07 +02001958#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1960 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001961 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001962 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001963 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001964
Ronald Cron90857082020-11-25 14:58:33 +01001965 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 slot->attr.type,
1967 slot->key.data,
1968 slot->key.bytes,
1969 &rsa);
1970 if (status != PSA_SUCCESS) {
1971 return status;
1972 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 mbedtls_mpi_init(&actual);
1975 mbedtls_mpi_init(&required);
1976 ret = mbedtls_rsa_export(rsa,
1977 NULL, NULL, NULL, NULL, &actual);
1978 mbedtls_rsa_free(rsa);
1979 mbedtls_free(rsa);
1980 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001981 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 }
1983 ret = mbedtls_mpi_read_binary(&required,
1984 attributes->domain_parameters,
1985 attributes->domain_parameters_size);
1986 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001987 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 }
1989 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001990 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 }
1992rsa_exit:
1993 mbedtls_mpi_free(&actual);
1994 mbedtls_mpi_free(&required);
1995 if (ret != 0) {
1996 return mbedtls_to_psa_error(ret);
1997 }
1998 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02001999#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) ||
John Durkop9814fa22020-11-04 12:28:15 -08002000 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002001 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002003 }
2004 }
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 if (attributes->core.bits != 0) {
2007 if (attributes->core.bits != slot->attr.bits) {
2008 return PSA_ERROR_INVALID_ARGUMENT;
2009 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002010 }
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002013}
2014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2016 const uint8_t *data,
2017 size_t data_length,
2018 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002019{
2020 psa_status_t status;
2021 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002022 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002023 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302024 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002025
Ronald Cron81709fc2020-11-14 12:10:32 +01002026 *key = MBEDTLS_SVC_KEY_ID_INIT;
2027
Gilles Peskine0f84d622019-09-12 19:03:13 +02002028 /* Reject zero-length symmetric keys (including raw data key objects).
2029 * This also rejects any key which might be encoded as an empty string,
2030 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 if (data_length == 0) {
2032 return PSA_ERROR_INVALID_ARGUMENT;
2033 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002034
Archana449608b2021-09-08 15:36:05 +05302035 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (data_length > SIZE_MAX / 8) {
2037 return PSA_ERROR_NOT_SUPPORTED;
2038 }
Archana6ed4bda2021-08-04 10:47:15 +05302039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2041 &slot, &driver);
2042 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002043 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002045
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002046 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302047 * storage ( thus not in the case of importing a key in a secure element
2048 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2049 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 if (slot->key.data == NULL) {
2051 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302052 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 attributes, data, data_length, &storage_size);
2054 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302055 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 }
Archanad8a83dc2021-06-14 10:04:16 +05302057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 status = psa_allocate_buffer_to_slot(slot, storage_size);
2059 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002060 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002062 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002063
2064 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 status = psa_driver_wrapper_import_key(attributes,
2066 data, data_length,
2067 slot->key.data,
2068 slot->key.bytes,
2069 &slot->key.bytes, &bits);
2070 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002071 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002075 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002077 status = PSA_ERROR_INVALID_ARGUMENT;
2078 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002079 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002080
Archana6ed4bda2021-08-04 10:47:15 +05302081 /* Enforce a size limit, and in particular ensure that the bit
2082 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302084 status = PSA_ERROR_NOT_SUPPORTED;
2085 goto exit;
2086 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 status = psa_validate_optional_attributes(slot, attributes);
2088 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002089 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002091
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002093exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 if (status != PSA_SUCCESS) {
2095 psa_fail_key_creation(slot, driver);
2096 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002099}
2100
Gilles Peskined7729582019-08-05 15:55:54 +02002101#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2102psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002104{
2105 psa_status_t status;
2106 psa_key_slot_t *slot = NULL;
2107 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002108 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002109
2110 /* Leaving attributes unspecified is not currently supported.
2111 * It could make sense to query the key type and size from the
2112 * secure element, but not all secure elements support this
2113 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2115 return PSA_ERROR_NOT_SUPPORTED;
2116 }
2117 if (psa_get_key_bits(attributes) == 0) {
2118 return PSA_ERROR_NOT_SUPPORTED;
2119 }
Gilles Peskined7729582019-08-05 15:55:54 +02002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2122 &slot, &driver);
2123 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002124 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 }
Gilles Peskined7729582019-08-05 15:55:54 +02002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002128
2129exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 if (status != PSA_SUCCESS) {
2131 psa_fail_key_creation(slot, driver);
2132 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002133
Gilles Peskined7729582019-08-05 15:55:54 +02002134 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 psa_close_key(key);
2136 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002137}
2138#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2141 const psa_key_attributes_t *specified_attributes,
2142 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002143{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002144 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002145 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002146 psa_key_slot_t *source_slot = NULL;
2147 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002148 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002149 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302150 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002151
Ronald Cron81709fc2020-11-14 12:10:32 +01002152 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2153
Archana8a180362021-07-05 02:18:48 +05302154 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2156 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002157 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002159
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 status = psa_validate_optional_attributes(source_slot,
2161 specified_attributes);
2162 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002163 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002165
Archana9d17bf42021-09-10 06:22:44 +05302166 /* The target key type and number of bits have been validated by
2167 * psa_validate_optional_attributes() to be either equal to zero or
2168 * equal to the ones of the source key. So it is safe to inherit
2169 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302170 * */
Archana9d17bf42021-09-10 06:22:44 +05302171 actual_attributes.core.bits = source_slot->attr.bits;
2172 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302173
2174
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 status = psa_restrict_key_policy(source_slot->attr.type,
2176 &actual_attributes.core.policy,
2177 &source_slot->attr.policy);
2178 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002179 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2183 &target_slot, &driver);
2184 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002185 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 }
2187 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2188 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302189 /*
Archana9d17bf42021-09-10 06:22:44 +05302190 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302191 * the source key would need to be exported as plaintext and re-imported
2192 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302193 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302194 * appropriate API invocations from the application, if needed.
2195 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002196 status = PSA_ERROR_NOT_SUPPORTED;
2197 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002198 }
Archana8a180362021-07-05 02:18:48 +05302199 /*
2200 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302201 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302202 * - For opaque keys this translates to an invocation of the drivers'
2203 * copy_key entry point through the dispatch layer.
2204 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2206 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2207 &storage_size);
2208 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302209 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 }
Archana374fe5b2021-09-08 15:50:28 +05302211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2213 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302214 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 }
Archana374fe5b2021-09-08 15:50:28 +05302216
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 status = psa_driver_wrapper_copy_key(&actual_attributes,
2218 source_slot->key.data,
2219 source_slot->key.bytes,
2220 target_slot->key.data,
2221 target_slot->key.bytes,
2222 &target_slot->key.bytes);
2223 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302224 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 }
2226 } else {
2227 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302228 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 source_slot->key.bytes);
2230 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302231 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 }
Archana8a180362021-07-05 02:18:48 +05302233 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002235exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 if (status != PSA_SUCCESS) {
2237 psa_fail_key_creation(target_slot, driver);
2238 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002243}
2244
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002245
2246
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002247/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002248/* Message digests */
2249/****************************************************************/
2250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002252{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002253 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 if (operation->id == 0) {
2255 return PSA_SUCCESS;
2256 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002259 operation->id = 0;
2260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002262}
2263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2265 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002266{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002267 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002268
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002269 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002271 status = PSA_ERROR_BAD_STATE;
2272 goto exit;
2273 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002274
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002276 status = PSA_ERROR_INVALID_ARGUMENT;
2277 goto exit;
2278 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002279
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002280 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2281 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002285
2286exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if (status != PSA_SUCCESS) {
2288 psa_hash_abort(operation);
2289 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002290
2291 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002292}
2293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2295 const uint8_t *input,
2296 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002297{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002301 status = PSA_ERROR_BAD_STATE;
2302 goto exit;
2303 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002304
Steven Cooremanc8288352021-03-04 14:02:19 +01002305 /* Don't require hash implementations to behave correctly on a
2306 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 if (input_length == 0) {
2308 return PSA_SUCCESS;
2309 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002312
2313exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if (status != PSA_SUCCESS) {
2315 psa_hash_abort(operation);
2316 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319}
2320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2322 uint8_t *hash,
2323 size_t hash_size,
2324 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002326 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 if (operation->id == 0) {
2328 return PSA_ERROR_BAD_STATE;
2329 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002330
Steven Cooreman1e582352021-02-18 17:24:37 +01002331 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 operation, hash, hash_size, hash_length);
2333 psa_hash_abort(operation);
2334 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002335}
2336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2338 const uint8_t *hash,
2339 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002340{
Ronald Cron69a63422021-10-18 09:47:58 +02002341 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002342 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002343 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 operation,
2345 actual_hash, sizeof(actual_hash),
2346 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002349 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002353 status = PSA_ERROR_INVALID_SIGNATURE;
2354 goto exit;
2355 }
2356
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002358 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002360
2361exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2363 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002364 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002366
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002368}
2369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370psa_status_t psa_hash_compute(psa_algorithm_t alg,
2371 const uint8_t *input, size_t input_length,
2372 uint8_t *hash, size_t hash_size,
2373 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002374{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002375 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (!PSA_ALG_IS_HASH(alg)) {
2377 return PSA_ERROR_INVALID_ARGUMENT;
2378 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2381 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002382}
2383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384psa_status_t psa_hash_compare(psa_algorithm_t alg,
2385 const uint8_t *input, size_t input_length,
2386 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002387{
Ronald Cron69a63422021-10-18 09:47:58 +02002388 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002389 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (!PSA_ALG_IS_HASH(alg)) {
2392 return PSA_ERROR_INVALID_ARGUMENT;
2393 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002394
Steven Cooreman1e582352021-02-18 17:24:37 +01002395 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 alg, input, input_length,
2397 actual_hash, sizeof(actual_hash),
2398 &actual_hash_length);
2399 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002400 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 }
2402 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002403 status = PSA_ERROR_INVALID_SIGNATURE;
2404 goto exit;
2405 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002407 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002409
2410exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2412 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002413}
2414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2416 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002417{
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 if (source_operation->id == 0 ||
2419 target_operation->id != 0) {
2420 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002421 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002422
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2424 target_operation);
2425 if (status != PSA_SUCCESS) {
2426 psa_hash_abort(target_operation);
2427 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002428
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002430}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002431
2432
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002433/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002434/* MAC */
2435/****************************************************************/
2436
Gilles Peskine449bd832023-01-11 14:50:10 +01002437psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002438{
Steven Cooremane6804192021-03-19 18:28:56 +01002439 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 if (operation->id == 0) {
2441 return PSA_SUCCESS;
2442 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002445 operation->mac_size = 0;
2446 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002447 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002450}
2451
Ronald Cron2dff3b22021-06-17 16:33:22 +02002452static psa_status_t psa_mac_finalize_alg_and_key_validation(
2453 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002454 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002456{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 psa_key_type_t key_type = psa_get_key_type(attributes);
2459 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 if (!PSA_ALG_IS_MAC(alg)) {
2462 return PSA_ERROR_INVALID_ARGUMENT;
2463 }
Steven Cooremane6804192021-03-19 18:28:56 +01002464
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002465 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 status = psa_mac_key_can_do(alg, key_type);
2467 if (status != PSA_SUCCESS) {
2468 return status;
2469 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002470
Steven Cooremand1a68f12021-05-10 11:13:41 +02002471 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002475 /* A very short MAC is too short for security since it can be
2476 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2477 * so we make this our minimum, even though 32 bits is still
2478 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002480 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2483 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002484 /* It's impossible to "truncate" to a larger length than the full length
2485 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002487 }
2488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002490 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2491 * that is disabled in the compile-time configuration. The result can
2492 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2493 * configuration into account. In this case, force a return of
2494 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2495 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2496 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2497 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2498 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002500 }
2501
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002503}
2504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2506 mbedtls_svc_key_id_t key,
2507 psa_algorithm_t alg,
2508 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002509{
2510 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2511 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002512 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002513 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002514
2515 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002517 status = PSA_ERROR_BAD_STATE;
2518 goto exit;
2519 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002520
2521 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 key,
2523 &slot,
2524 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2525 alg);
2526 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002527 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002529
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002530 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531 .core = slot->attr
2532 };
2533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2535 &operation->mac_size);
2536 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002537 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002539
2540 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002541 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (is_sign) {
2543 status = psa_driver_wrapper_mac_sign_setup(operation,
2544 &attributes,
2545 slot->key.data,
2546 slot->key.bytes,
2547 alg);
2548 } else {
2549 status = psa_driver_wrapper_mac_verify_setup(operation,
2550 &attributes,
2551 slot->key.data,
2552 slot->key.bytes,
2553 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002554 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002555
Gilles Peskinefbfac682018-07-08 20:51:54 +02002556exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 if (status != PSA_SUCCESS) {
2558 psa_mac_abort(operation);
2559 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002564}
2565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2567 mbedtls_svc_key_id_t key,
2568 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002569{
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002571}
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2574 mbedtls_svc_key_id_t key,
2575 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002576{
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002578}
2579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2581 const uint8_t *input,
2582 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002583{
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (operation->id == 0) {
2585 return PSA_ERROR_BAD_STATE;
2586 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002587
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002588 /* Don't require hash implementations to behave correctly on a
2589 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (input_length == 0) {
2591 return PSA_SUCCESS;
2592 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2595 input, input_length);
2596 if (status != PSA_SUCCESS) {
2597 psa_mac_abort(operation);
2598 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002601}
2602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2604 uint8_t *mac,
2605 size_t mac_size,
2606 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002607{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002608 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2609 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002612 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002613 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002614 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002617 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002618 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002619 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002620
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002621 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2622 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002624 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002625 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002626 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002627
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002629 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002630 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002631 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 status = psa_driver_wrapper_mac_sign_finish(operation,
2634 mac, operation->mac_size,
2635 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002636
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002637exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002638 /* In case of success, set the potential excess room in the output buffer
2639 * to an invalid value, to avoid potentially leaking a longer MAC.
2640 * In case of error, set the output length and content to a safe default,
2641 * such that in case the caller misses an error check, the output would be
2642 * an unachievable MAC.
2643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002645 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002646 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002647 }
mohammad16036df908f2018-04-02 08:34:15 -07002648
Paul Elliottdc42ca82023-02-24 18:11:59 +00002649 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002654}
2655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2657 const uint8_t *mac,
2658 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002659{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002660 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2661 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002664 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002665 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002666 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002669 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002670 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002671 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002674 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002675 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002676 }
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 status = psa_driver_wrapper_mac_verify_finish(operation,
2679 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002680
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002681exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002685}
2686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2688 psa_algorithm_t alg,
2689 const uint8_t *input,
2690 size_t input_length,
2691 uint8_t *mac,
2692 size_t mac_size,
2693 size_t *mac_length,
2694 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002695{
2696 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002697 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2698 psa_key_slot_t *slot;
2699 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002700 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002701
Ronald Cron51131b52021-06-17 17:17:20 +02002702 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 key,
2704 &slot,
2705 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2706 alg);
2707 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002708 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002710
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002711 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002712 .core = slot->attr
2713 };
2714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2716 &operation_mac_size);
2717 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002718 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002722 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002723 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002724 }
2725
2726 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 &attributes,
2728 slot->key.data, slot->key.bytes,
2729 alg,
2730 input, input_length,
2731 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002732
2733exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002734 /* In case of success, set the potential excess room in the output buffer
2735 * to an invalid value, to avoid potentially leaking a longer MAC.
2736 * In case of error, set the output length and content to a safe default,
2737 * such that in case the caller misses an error check, the output would be
2738 * an unachievable MAC.
2739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002741 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002742 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002743 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002744
2745 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002750}
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002753 psa_algorithm_t alg,
2754 const uint8_t *input,
2755 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 uint8_t *mac,
2757 size_t mac_size,
2758 size_t *mac_length)
2759{
2760 return psa_mac_compute_internal(key, alg,
2761 input, input_length,
2762 mac, mac_size, mac_length, 1);
2763}
2764
2765psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2766 psa_algorithm_t alg,
2767 const uint8_t *input,
2768 size_t input_length,
2769 const uint8_t *mac,
2770 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002771{
2772 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002773 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2774 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 status = psa_mac_compute_internal(key, alg,
2777 input, input_length,
2778 actual_mac, sizeof(actual_mac),
2779 &actual_mac_length, 0);
2780 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002781 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002785 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002786 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002787 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002789 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002790 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002791 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002792
2793exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002797}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002798
Gilles Peskinee59236f2018-01-27 23:32:46 +01002799/****************************************************************/
2800/* Asymmetric cryptography */
2801/****************************************************************/
2802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2804 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002805{
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 if (input_is_message) {
2807 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2808 return PSA_ERROR_INVALID_ARGUMENT;
2809 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2812 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2813 return PSA_ERROR_INVALID_ARGUMENT;
2814 }
2815 }
2816 } else {
2817 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2818 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002819 }
2820 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002821
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002823}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2826 int input_is_message,
2827 psa_algorithm_t alg,
2828 const uint8_t *input,
2829 size_t input_length,
2830 uint8_t *signature,
2831 size_t signature_size,
2832 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002833{
2834 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2835 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2836 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002837 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002838
2839 *signature_length = 0;
2840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 status = psa_sign_verify_check_alg(input_is_message, alg);
2842 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002843 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002845
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002846 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002847 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002848 * buffer can in principle be empty since it doesn't actually have
2849 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (signature_size == 0) {
2851 return PSA_ERROR_BUFFER_TOO_SMALL;
2852 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002853
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002854 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 key, &slot,
2856 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2857 PSA_KEY_USAGE_SIGN_HASH,
2858 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002861 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002865 status = PSA_ERROR_INVALID_ARGUMENT;
2866 goto exit;
2867 }
2868
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002869 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002871 };
2872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002874 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002875 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002876 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 signature, signature_size, signature_length);
2878 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002879
2880 status = psa_driver_wrapper_sign_hash(
2881 &attributes, slot->key.data, slot->key.bytes,
2882 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002884 }
2885
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002886
2887exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002888 psa_wipe_tag_output_buffer(signature, status, signature_size,
2889 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002894}
2895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2897 int input_is_message,
2898 psa_algorithm_t alg,
2899 const uint8_t *input,
2900 size_t input_length,
2901 const uint8_t *signature,
2902 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002903{
2904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2905 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2906 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 status = psa_sign_verify_check_alg(input_is_message, alg);
2909 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002910 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002912
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002913 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 key, &slot,
2915 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2916 PSA_KEY_USAGE_VERIFY_HASH,
2917 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 if (status != PSA_SUCCESS) {
2920 return status;
2921 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002922
2923 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002925 };
2926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002928 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002929 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002930 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 signature, signature_length);
2932 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002933 status = psa_driver_wrapper_verify_hash(
2934 &attributes, slot->key.data, slot->key.bytes,
2935 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002937 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002942
2943}
2944
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002945psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002946 const psa_key_attributes_t *attributes,
2947 const uint8_t *key_buffer,
2948 size_t key_buffer_size,
2949 psa_algorithm_t alg,
2950 const uint8_t *input,
2951 size_t input_length,
2952 uint8_t *signature,
2953 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002955{
2956 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002959 size_t hash_length;
2960 uint8_t hash[PSA_HASH_MAX_SIZE];
2961
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002962 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 PSA_ALG_SIGN_GET_HASH(alg),
2964 input, input_length,
2965 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002968 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002970
2971 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 attributes, key_buffer, key_buffer_size,
2973 alg, hash, hash_length,
2974 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002975 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002978}
2979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2981 psa_algorithm_t alg,
2982 const uint8_t *input,
2983 size_t input_length,
2984 uint8_t *signature,
2985 size_t signature_size,
2986 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002987{
2988 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002989 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002991}
2992
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002993psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002994 const psa_key_attributes_t *attributes,
2995 const uint8_t *key_buffer,
2996 size_t key_buffer_size,
2997 psa_algorithm_t alg,
2998 const uint8_t *input,
2999 size_t input_length,
3000 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003002{
3003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003006 size_t hash_length;
3007 uint8_t hash[PSA_HASH_MAX_SIZE];
3008
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003009 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 PSA_ALG_SIGN_GET_HASH(alg),
3011 input, input_length,
3012 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003015 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003017
3018 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 attributes, key_buffer, key_buffer_size,
3020 alg, hash, hash_length,
3021 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003022 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003025}
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3028 psa_algorithm_t alg,
3029 const uint8_t *input,
3030 size_t input_length,
3031 const uint8_t *signature,
3032 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003033{
3034 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003035 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003037}
3038
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003039psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003040 const psa_key_attributes_t *attributes,
3041 const uint8_t *key_buffer, size_t key_buffer_size,
3042 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003044{
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3046 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3047 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003048#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3050 return mbedtls_psa_rsa_sign_hash(
3051 attributes,
3052 key_buffer, key_buffer_size,
3053 alg, hash, hash_length,
3054 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003055#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3056 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 } else {
3058 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003059 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3061 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003062#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3064 return mbedtls_psa_ecdsa_sign_hash(
3065 attributes,
3066 key_buffer, key_buffer_size,
3067 alg, hash, hash_length,
3068 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003069#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3070 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 } else {
3072 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003073 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003074 }
Ronald Cron4501c982021-03-19 20:09:32 +01003075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 (void) key_buffer;
3077 (void) key_buffer_size;
3078 (void) hash;
3079 (void) hash_length;
3080 (void) signature;
3081 (void) signature_size;
3082 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003085}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3088 psa_algorithm_t alg,
3089 const uint8_t *hash,
3090 size_t hash_length,
3091 uint8_t *signature,
3092 size_t signature_size,
3093 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003094{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003095 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003096 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003098}
3099
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003100psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003101 const psa_key_attributes_t *attributes,
3102 const uint8_t *key_buffer, size_t key_buffer_size,
3103 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003105{
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3107 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3108 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003109#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3111 return mbedtls_psa_rsa_verify_hash(
3112 attributes,
3113 key_buffer, key_buffer_size,
3114 alg, hash, hash_length,
3115 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003116#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3117 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 } else {
3119 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003120 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3122 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003123#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3125 return mbedtls_psa_ecdsa_verify_hash(
3126 attributes,
3127 key_buffer, key_buffer_size,
3128 alg, hash, hash_length,
3129 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003130#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3131 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 } else {
3133 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003134 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003135 }
Ronald Cron4501c982021-03-19 20:09:32 +01003136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 (void) key_buffer;
3138 (void) key_buffer_size;
3139 (void) hash;
3140 (void) hash_length;
3141 (void) signature;
3142 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003145}
3146
Gilles Peskine449bd832023-01-11 14:50:10 +01003147psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3148 psa_algorithm_t alg,
3149 const uint8_t *hash,
3150 size_t hash_length,
3151 const uint8_t *signature,
3152 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003153{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003154 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003155 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003157}
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3160 psa_algorithm_t alg,
3161 const uint8_t *input,
3162 size_t input_length,
3163 const uint8_t *salt,
3164 size_t salt_length,
3165 uint8_t *output,
3166 size_t output_size,
3167 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003169 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003170 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003171 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003172 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003173
Darryl Green5cc689a2018-07-24 15:34:10 +01003174 (void) input;
3175 (void) input_length;
3176 (void) salt;
3177 (void) output;
3178 (void) output_size;
3179
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003180 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3183 return PSA_ERROR_INVALID_ARGUMENT;
3184 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003185
Ronald Cron5c522922020-11-14 16:35:34 +01003186 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3188 if (status != PSA_SUCCESS) {
3189 return status;
3190 }
3191 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3192 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003193 status = PSA_ERROR_INVALID_ARGUMENT;
3194 goto exit;
3195 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003196
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003197 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003199 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003200
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003201 status = psa_driver_wrapper_asymmetric_encrypt(
3202 &attributes, slot->key.data, slot->key.bytes,
3203 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003205exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003207
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003209}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210
Gilles Peskine449bd832023-01-11 14:50:10 +01003211psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3212 psa_algorithm_t alg,
3213 const uint8_t *input,
3214 size_t input_length,
3215 const uint8_t *salt,
3216 size_t salt_length,
3217 uint8_t *output,
3218 size_t output_size,
3219 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003220{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003222 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003223 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003224 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003225
Darryl Green5cc689a2018-07-24 15:34:10 +01003226 (void) input;
3227 (void) input_length;
3228 (void) salt;
3229 (void) output;
3230 (void) output_size;
3231
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003232 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3235 return PSA_ERROR_INVALID_ARGUMENT;
3236 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003237
Ronald Cron5c522922020-11-14 16:35:34 +01003238 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3240 if (status != PSA_SUCCESS) {
3241 return status;
3242 }
3243 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003244 status = PSA_ERROR_INVALID_ARGUMENT;
3245 goto exit;
3246 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003247
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003248 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003250 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003251
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003252 status = psa_driver_wrapper_asymmetric_decrypt(
3253 &attributes, slot->key.data, slot->key.bytes,
3254 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003256
3257exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003259
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003261}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003262
Paul Elliott9fe12f62022-11-30 19:16:02 +00003263/****************************************************************/
3264/* Asymmetric interruptible cryptography */
3265/****************************************************************/
3266
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003267static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3268
Paul Elliott9fe12f62022-11-30 19:16:02 +00003269void psa_interruptible_set_max_ops(uint32_t max_ops)
3270{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003271 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003272}
3273
3274uint32_t psa_interruptible_get_max_ops(void)
3275{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003276 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003277}
3278
Paul Elliott9fe12f62022-11-30 19:16:02 +00003279uint32_t psa_sign_hash_get_num_ops(
3280 const psa_sign_hash_interruptible_operation_t *operation)
3281{
Paul Elliott296ede92022-12-15 17:00:30 +00003282 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003283}
3284
3285uint32_t psa_verify_hash_get_num_ops(
3286 const psa_verify_hash_interruptible_operation_t *operation)
3287{
Paul Elliott296ede92022-12-15 17:00:30 +00003288 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003289}
3290
Paul Elliott59ad9452022-12-18 15:09:02 +00003291static psa_status_t psa_sign_hash_abort_internal(
3292 psa_sign_hash_interruptible_operation_t *operation)
3293{
3294 if (operation->id == 0) {
3295 /* The object has (apparently) been initialized but it is not (yet)
3296 * in use. It's ok to call abort on such an object, and there's
3297 * nothing to do. */
3298 return PSA_SUCCESS;
3299 }
3300
3301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3302
3303 status = psa_driver_wrapper_sign_hash_abort(operation);
3304
3305 operation->id = 0;
3306
Paul Elliotte6145dc2023-02-07 12:51:21 +00003307 /* Do not clear either the error_occurred or num_ops elements here as they
3308 * only want to be cleared by the application calling abort, not by abort
3309 * being called at completion of an operation. */
3310
Paul Elliott59ad9452022-12-18 15:09:02 +00003311 return status;
3312}
3313
Paul Elliott9fe12f62022-11-30 19:16:02 +00003314psa_status_t psa_sign_hash_start(
3315 psa_sign_hash_interruptible_operation_t *operation,
3316 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3317 const uint8_t *hash, size_t hash_length)
3318{
3319 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3320 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3321 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003322 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003323
Paul Elliottc9774412023-02-06 15:14:07 +00003324 /* Check that start has not been previously called, or operation has not
3325 * previously errored. */
3326 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003327 return PSA_ERROR_BAD_STATE;
3328 }
3329
Paul Elliott9fe12f62022-11-30 19:16:02 +00003330 status = psa_sign_verify_check_alg(0, alg);
3331 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003332 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003333 return status;
3334 }
3335
3336 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3337 PSA_KEY_USAGE_SIGN_HASH,
3338 alg);
3339
3340 if (status != PSA_SUCCESS) {
3341 goto exit;
3342 }
3343
3344 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3345 status = PSA_ERROR_INVALID_ARGUMENT;
3346 goto exit;
3347 }
3348
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003349 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003350 .core = slot->attr
3351 };
3352
Paul Elliott296ede92022-12-15 17:00:30 +00003353 /* Ensure ops count gets reset, in case of operation re-use. */
3354 operation->num_ops = 0;
3355
Paul Elliott9fe12f62022-11-30 19:16:02 +00003356 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3357 slot->key.data,
3358 slot->key.bytes, alg,
3359 hash, hash_length);
3360exit:
3361
3362 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003363 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003364 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003365 }
3366
3367 unlock_status = psa_unlock_key_slot(slot);
3368
Paul Elliottc9774412023-02-06 15:14:07 +00003369 if (unlock_status != PSA_SUCCESS) {
3370 operation->error_occurred = 1;
3371 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003372
Paul Elliottc9774412023-02-06 15:14:07 +00003373 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003374}
3375
3376
3377psa_status_t psa_sign_hash_complete(
3378 psa_sign_hash_interruptible_operation_t *operation,
3379 uint8_t *signature, size_t signature_size,
3380 size_t *signature_length)
3381{
3382 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3383
3384 *signature_length = 0;
3385
Paul Elliottc9774412023-02-06 15:14:07 +00003386 /* Check that start has been called first, and that operation has not
3387 * previously errored. */
3388 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003389 status = PSA_ERROR_BAD_STATE;
3390 goto exit;
3391 }
3392
Paul Elliott096abc42023-02-03 18:33:23 +00003393 /* Immediately reject a zero-length signature buffer. This guarantees that
3394 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003395 if (signature_size == 0) {
3396 status = PSA_ERROR_BUFFER_TOO_SMALL;
3397 goto exit;
3398 }
3399
3400 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3401 signature_size,
3402 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003403
Paul Elliott296ede92022-12-15 17:00:30 +00003404 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003405 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003406
Paul Elliottebe225c2023-02-10 14:32:53 +00003407exit:
3408
Paul Elliott59200a22023-02-21 15:07:40 +00003409 psa_wipe_tag_output_buffer(signature, status, signature_size,
3410 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003411
Paul Elliott53bb3122023-02-10 14:22:22 +00003412 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003413 if (status != PSA_SUCCESS) {
3414 operation->error_occurred = 1;
3415 }
3416
Paul Elliott59ad9452022-12-18 15:09:02 +00003417 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003418 }
3419
3420 return status;
3421}
3422
3423psa_status_t psa_sign_hash_abort(
3424 psa_sign_hash_interruptible_operation_t *operation)
3425{
Paul Elliott59ad9452022-12-18 15:09:02 +00003426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3427
3428 status = psa_sign_hash_abort_internal(operation);
3429
3430 /* We clear the number of ops done here, so that it is not cleared when
3431 * the operation fails or succeeds, only on manual abort. */
3432 operation->num_ops = 0;
3433
Paul Elliottc9774412023-02-06 15:14:07 +00003434 /* Likewise, failure state. */
3435 operation->error_occurred = 0;
3436
Paul Elliott59ad9452022-12-18 15:09:02 +00003437 return status;
3438}
3439
3440static psa_status_t psa_verify_hash_abort_internal(
3441 psa_verify_hash_interruptible_operation_t *operation)
3442{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003443 if (operation->id == 0) {
3444 /* The object has (apparently) been initialized but it is not (yet)
3445 * in use. It's ok to call abort on such an object, and there's
3446 * nothing to do. */
3447 return PSA_SUCCESS;
3448 }
3449
Paul Elliott59ad9452022-12-18 15:09:02 +00003450 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3451
3452 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003453
3454 operation->id = 0;
3455
Paul Elliotte6145dc2023-02-07 12:51:21 +00003456 /* Do not clear either the error_occurred or num_ops elements here as they
3457 * only want to be cleared by the application calling abort, not by abort
3458 * being called at completion of an operation. */
3459
Paul Elliott59ad9452022-12-18 15:09:02 +00003460 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003461}
3462
3463psa_status_t psa_verify_hash_start(
3464 psa_verify_hash_interruptible_operation_t *operation,
3465 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3466 const uint8_t *hash, size_t hash_length,
3467 const uint8_t *signature, size_t signature_length)
3468{
3469 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3470 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3471 psa_key_slot_t *slot;
3472
Paul Elliottc9774412023-02-06 15:14:07 +00003473 /* Check that start has not been previously called, or operation has not
3474 * previously errored. */
3475 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003476 return PSA_ERROR_BAD_STATE;
3477 }
3478
3479 status = psa_sign_verify_check_alg(0, alg);
3480 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003481 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003482 return status;
3483 }
3484
3485 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3486 PSA_KEY_USAGE_VERIFY_HASH,
3487 alg);
3488
3489 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003490 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003491 return status;
3492 }
3493
3494 psa_key_attributes_t attributes = {
3495 .core = slot->attr
3496 };
3497
Paul Elliott296ede92022-12-15 17:00:30 +00003498 /* Ensure ops count gets reset, in case of operation re-use. */
3499 operation->num_ops = 0;
3500
Paul Elliott9fe12f62022-11-30 19:16:02 +00003501 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3502 slot->key.data,
3503 slot->key.bytes,
3504 alg, hash, hash_length,
3505 signature, signature_length);
3506
3507 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003508 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003509 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003510 }
3511
3512 unlock_status = psa_unlock_key_slot(slot);
3513
Paul Elliottc9774412023-02-06 15:14:07 +00003514 if (unlock_status != PSA_SUCCESS) {
3515 operation->error_occurred = 1;
3516 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003517
Paul Elliottc9774412023-02-06 15:14:07 +00003518 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003519}
3520
3521psa_status_t psa_verify_hash_complete(
3522 psa_verify_hash_interruptible_operation_t *operation)
3523{
3524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3525
Paul Elliottc9774412023-02-06 15:14:07 +00003526 /* Check that start has been called first, and that operation has not
3527 * previously errored. */
3528 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003529 status = PSA_ERROR_BAD_STATE;
3530 goto exit;
3531 }
3532
3533 status = psa_driver_wrapper_verify_hash_complete(operation);
3534
Paul Elliott296ede92022-12-15 17:00:30 +00003535 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003536 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003537 operation);
3538
Paul Elliottebe225c2023-02-10 14:32:53 +00003539exit:
3540
Paul Elliott9fe12f62022-11-30 19:16:02 +00003541 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003542 if (status != PSA_SUCCESS) {
3543 operation->error_occurred = 1;
3544 }
3545
Paul Elliott59ad9452022-12-18 15:09:02 +00003546 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003547 }
3548
3549 return status;
3550}
3551
3552psa_status_t psa_verify_hash_abort(
3553 psa_verify_hash_interruptible_operation_t *operation)
3554{
Paul Elliott59ad9452022-12-18 15:09:02 +00003555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003556
Paul Elliott59ad9452022-12-18 15:09:02 +00003557 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003558
Paul Elliott59ad9452022-12-18 15:09:02 +00003559 /* We clear the number of ops done here, so that it is not cleared when
3560 * the operation fails or succeeds, only on manual abort. */
3561 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003562
Paul Elliottc9774412023-02-06 15:14:07 +00003563 /* Likewise, failure state. */
3564 operation->error_occurred = 0;
3565
Paul Elliott59ad9452022-12-18 15:09:02 +00003566 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003567}
3568
Paul Elliott588f8ed2022-12-02 18:10:26 +00003569/****************************************************************/
3570/* Asymmetric interruptible cryptography internal */
3571/* implementations */
3572/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003573
Paul Elliott588f8ed2022-12-02 18:10:26 +00003574void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3575{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003576
Paul Elliott588f8ed2022-12-02 18:10:26 +00003577#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3578 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3579 defined(MBEDTLS_ECP_RESTARTABLE)
3580
3581 /* Internal implementation uses zero to indicate infinite number max ops,
3582 * therefore avoid this value, and set to minimum possible. */
3583 if (max_ops == 0) {
3584 max_ops = 1;
3585 }
3586
Paul Elliott588f8ed2022-12-02 18:10:26 +00003587 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003588#else
3589 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003590#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3591 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3592 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3593}
3594
Paul Elliott588f8ed2022-12-02 18:10:26 +00003595uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003596 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003597{
3598#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3599 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3600 defined(MBEDTLS_ECP_RESTARTABLE)
3601
Paul Elliott93d9ca82023-02-15 18:14:21 +00003602 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003603#else
3604 (void) operation;
3605 return 0;
3606#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3607 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3608 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3609}
3610
3611uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003612 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003613{
3614 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3615 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3616 defined(MBEDTLS_ECP_RESTARTABLE)
3617
Paul Elliott93d9ca82023-02-15 18:14:21 +00003618 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003619#else
3620 (void) operation;
3621 return 0;
3622#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3623 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3624 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3625}
3626
3627psa_status_t mbedtls_psa_sign_hash_start(
3628 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3629 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3630 size_t key_buffer_size, psa_algorithm_t alg,
3631 const uint8_t *hash, size_t hash_length)
3632{
3633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003634 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003635
Paul Elliott068fe072023-01-16 13:59:15 +00003636 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3637 return PSA_ERROR_NOT_SUPPORTED;
3638 }
3639
3640 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003641 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003642 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003643
3644#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003645 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3646 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003647
Paul Elliotta1c94092023-02-15 16:38:04 +00003648 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3649
Paul Elliott93d9ca82023-02-15 18:14:21 +00003650 /* Ensure num_ops is zero'ed in case of context re-use. */
3651 operation->num_ops = 0;
3652
Paul Elliott068fe072023-01-16 13:59:15 +00003653 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3654 attributes->core.bits,
3655 key_buffer,
3656 key_buffer_size,
3657 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003658
Paul Elliott068fe072023-01-16 13:59:15 +00003659 if (status != PSA_SUCCESS) {
3660 return status;
3661 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003662
Paul Elliott1bc59df2023-02-05 13:41:57 +00003663 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003664 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003665
Paul Elliott068fe072023-01-16 13:59:15 +00003666 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003667 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003668 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003669
Paul Elliott0290a762023-02-09 14:30:24 +00003670 /* We only need to store the same length of hash as the private key size
3671 * here, it would be truncated by the internal implementation anyway. */
3672 required_hash_length = (hash_length < operation->coordinate_bytes ?
3673 hash_length : operation->coordinate_bytes);
3674
Paul Elliottba70ad42023-02-15 18:23:53 +00003675 if (required_hash_length > sizeof(operation->hash)) {
3676 /* Shouldn't happen, but better safe than sorry. */
3677 return PSA_ERROR_CORRUPTION_DETECTED;
3678 }
3679
Paul Elliott0290a762023-02-09 14:30:24 +00003680 memcpy(operation->hash, hash, required_hash_length);
3681 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003682
3683 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003684
3685#else
Paul Elliott068fe072023-01-16 13:59:15 +00003686 (void) operation;
3687 (void) key_buffer;
3688 (void) key_buffer_size;
3689 (void) alg;
3690 (void) hash;
3691 (void) hash_length;
3692 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003693 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003694
Paul Elliott068fe072023-01-16 13:59:15 +00003695 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003696#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3697 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3698 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003699}
3700
3701psa_status_t mbedtls_psa_sign_hash_complete(
3702 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3703 uint8_t *signature, size_t signature_size,
3704 size_t *signature_length)
3705{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003706#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3707 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3708 defined(MBEDTLS_ECP_RESTARTABLE)
3709
Paul Elliotta1c94092023-02-15 16:38:04 +00003710 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003711 mbedtls_mpi r;
3712 mbedtls_mpi s;
3713
Paul Elliott46845252023-02-03 14:59:11 +00003714 mbedtls_mpi_init(&r);
3715 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003716
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003717 /* Ensure max_ops is set to the current value (or default). */
3718 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3719
Paul Elliotta1c94092023-02-15 16:38:04 +00003720 if (signature_size < 2 * operation->coordinate_bytes) {
3721 status = PSA_ERROR_BUFFER_TOO_SMALL;
3722 goto exit;
3723 }
3724
Paul Elliott588f8ed2022-12-02 18:10:26 +00003725 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003726
Paul Elliott588f8ed2022-12-02 18:10:26 +00003727#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3728 status = mbedtls_to_psa_error(
3729 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003730 &r,
3731 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003732 &operation->ctx->d,
3733 operation->hash,
3734 operation->hash_length,
3735 operation->md_alg,
3736 mbedtls_psa_get_random,
3737 MBEDTLS_PSA_RANDOM_STATE,
3738 &operation->restart_ctx));
3739#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003740 status = PSA_ERROR_NOT_SUPPORTED;
3741 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003742#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3743 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003744 status = mbedtls_to_psa_error(
3745 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003746 &r,
3747 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003748 &operation->ctx->d,
3749 operation->hash,
3750 operation->hash_length,
3751 mbedtls_psa_get_random,
3752 MBEDTLS_PSA_RANDOM_STATE,
3753 mbedtls_psa_get_random,
3754 MBEDTLS_PSA_RANDOM_STATE,
3755 &operation->restart_ctx));
3756 }
3757
Paul Elliottf8e5b562023-02-19 18:43:45 +00003758 /* Hide the fact that the restart context only holds a delta of number of
3759 * ops done during the last operation, not an absolute value. */
3760 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3761
Paul Elliott724bd252023-02-08 12:35:08 +00003762 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003763 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003764 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003766 operation->coordinate_bytes)
3767 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003768
3769 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003770 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003771 }
3772
3773 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003774 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003776 operation->coordinate_bytes,
3777 operation->coordinate_bytes)
3778 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003779
3780 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003781 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003782 }
3783
Paul Elliott1bc59df2023-02-05 13:41:57 +00003784 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003785
Paul Elliott724bd252023-02-08 12:35:08 +00003786 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003787 }
Paul Elliott724bd252023-02-08 12:35:08 +00003788
3789exit:
3790
3791 mbedtls_mpi_free(&r);
3792 mbedtls_mpi_free(&s);
3793 return status;
3794
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795 #else
3796
3797 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003798 (void) signature;
3799 (void) signature_size;
3800 (void) signature_length;
3801
3802 return PSA_ERROR_NOT_SUPPORTED;
3803
3804#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3805 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3806 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3807}
3808
3809psa_status_t mbedtls_psa_sign_hash_abort(
3810 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3811{
3812
3813#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3814 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3815 defined(MBEDTLS_ECP_RESTARTABLE)
3816
3817 if (operation->ctx) {
3818 mbedtls_ecdsa_free(operation->ctx);
3819 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003820 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821 }
3822
3823 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3824
Paul Elliott93d9ca82023-02-15 18:14:21 +00003825 operation->num_ops = 0;
3826
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827 return PSA_SUCCESS;
3828
3829#else
3830
3831 (void) operation;
3832
3833 return PSA_ERROR_NOT_SUPPORTED;
3834
3835#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3836 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3837 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3838}
3839
3840psa_status_t mbedtls_psa_verify_hash_start(
3841 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3842 const psa_key_attributes_t *attributes,
3843 const uint8_t *key_buffer, size_t key_buffer_size,
3844 psa_algorithm_t alg,
3845 const uint8_t *hash, size_t hash_length,
3846 const uint8_t *signature, size_t signature_length)
3847{
3848 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003849 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003850 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003851
Paul Elliott068fe072023-01-16 13:59:15 +00003852 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3853 return PSA_ERROR_NOT_SUPPORTED;
3854 }
3855
3856 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003857 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003858 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003859
3860#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003861 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3862 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003863
Paul Elliotta1c94092023-02-15 16:38:04 +00003864 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3865 mbedtls_mpi_init(&operation->r);
3866 mbedtls_mpi_init(&operation->s);
3867
Paul Elliott93d9ca82023-02-15 18:14:21 +00003868 /* Ensure num_ops is zero'ed in case of context re-use. */
3869 operation->num_ops = 0;
3870
Paul Elliott068fe072023-01-16 13:59:15 +00003871 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3872 attributes->core.bits,
3873 key_buffer,
3874 key_buffer_size,
3875 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003876
Paul Elliott068fe072023-01-16 13:59:15 +00003877 if (status != PSA_SUCCESS) {
3878 return status;
3879 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003880
Paul Elliottc569fc22023-02-10 13:02:54 +00003881 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003882
Paul Elliott1bc59df2023-02-05 13:41:57 +00003883 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003884 return PSA_ERROR_INVALID_SIGNATURE;
3885 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003886
Paul Elliott068fe072023-01-16 13:59:15 +00003887 status = mbedtls_to_psa_error(
3888 mbedtls_mpi_read_binary(&operation->r,
3889 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003890 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891
Paul Elliott068fe072023-01-16 13:59:15 +00003892 if (status != PSA_SUCCESS) {
3893 return status;
3894 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003895
Paul Elliott068fe072023-01-16 13:59:15 +00003896 status = mbedtls_to_psa_error(
3897 mbedtls_mpi_read_binary(&operation->s,
3898 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003899 coordinate_bytes,
3900 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003901
Paul Elliott068fe072023-01-16 13:59:15 +00003902 if (status != PSA_SUCCESS) {
3903 return status;
3904 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003905
Paul Elliott2c9843f2023-02-15 17:32:42 +00003906 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907
Paul Elliott2c9843f2023-02-15 17:32:42 +00003908 if (status != PSA_SUCCESS) {
3909 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003910 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003911
Paul Elliott0290a762023-02-09 14:30:24 +00003912 /* We only need to store the same length of hash as the private key size
3913 * here, it would be truncated by the internal implementation anyway. */
3914 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3915 coordinate_bytes);
3916
Paul Elliottba70ad42023-02-15 18:23:53 +00003917 if (required_hash_length > sizeof(operation->hash)) {
3918 /* Shouldn't happen, but better safe than sorry. */
3919 return PSA_ERROR_CORRUPTION_DETECTED;
3920 }
3921
Paul Elliott0290a762023-02-09 14:30:24 +00003922 memcpy(operation->hash, hash, required_hash_length);
3923 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003924
3925 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003926#else
Paul Elliott068fe072023-01-16 13:59:15 +00003927 (void) operation;
3928 (void) key_buffer;
3929 (void) key_buffer_size;
3930 (void) alg;
3931 (void) hash;
3932 (void) hash_length;
3933 (void) signature;
3934 (void) signature_length;
3935 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003936 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003937 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003938
Paul Elliott068fe072023-01-16 13:59:15 +00003939 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003940#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3941 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3942 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943}
3944
3945psa_status_t mbedtls_psa_verify_hash_complete(
3946 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3947{
3948
3949#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3950 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3951 defined(MBEDTLS_ECP_RESTARTABLE)
3952
Paul Elliottf8e5b562023-02-19 18:43:45 +00003953 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3954
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003955 /* Ensure max_ops is set to the current value (or default). */
3956 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3957
Paul Elliottf8e5b562023-02-19 18:43:45 +00003958 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003959 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3960 operation->hash,
3961 operation->hash_length,
3962 &operation->ctx->Q,
3963 &operation->r,
3964 &operation->s,
3965 &operation->restart_ctx));
3966
Paul Elliottf8e5b562023-02-19 18:43:45 +00003967 /* Hide the fact that the restart context only holds a delta of number of
3968 * ops done during the last operation, not an absolute value. */
3969 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3970
3971 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003972#else
3973 (void) operation;
3974
3975 return PSA_ERROR_NOT_SUPPORTED;
3976
3977#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3978 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3979 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3980}
3981
3982psa_status_t mbedtls_psa_verify_hash_abort(
3983 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3984{
3985
3986#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3987 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3988 defined(MBEDTLS_ECP_RESTARTABLE)
3989
3990 if (operation->ctx) {
3991 mbedtls_ecdsa_free(operation->ctx);
3992 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003993 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003994 }
3995
3996 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3997
Paul Elliott93d9ca82023-02-15 18:14:21 +00003998 operation->num_ops = 0;
3999
Paul Elliott588f8ed2022-12-02 18:10:26 +00004000 mbedtls_mpi_free(&operation->r);
4001 mbedtls_mpi_free(&operation->s);
4002
4003 return PSA_SUCCESS;
4004
4005#else
4006 (void) operation;
4007
4008 return PSA_ERROR_NOT_SUPPORTED;
4009
4010#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4011 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4012 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4013}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004014
mohammad1603503973b2018-03-12 15:59:30 +02004015/****************************************************************/
4016/* Symmetric cryptography */
4017/****************************************************************/
4018
Gilles Peskine449bd832023-01-11 14:50:10 +01004019static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4020 mbedtls_svc_key_id_t key,
4021 psa_algorithm_t alg,
4022 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004023{
4024 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4025 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004026 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4028 PSA_KEY_USAGE_ENCRYPT :
4029 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004030 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004031
4032 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004034 status = PSA_ERROR_BAD_STATE;
4035 goto exit;
4036 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004037
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004039 status = PSA_ERROR_INVALID_ARGUMENT;
4040 goto exit;
4041 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004042
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4044 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004045 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004047
Ronald Cron49fafa92021-03-10 08:34:23 +01004048 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004049 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004050 * so we only set it (in the driver wrapper) after resources have been
4051 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004052 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004054 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004056 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 }
4058 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004059
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004060 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004062 };
4063
Ronald Cronab99ac22020-10-01 16:38:28 +02004064 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 if (cipher_operation == MBEDTLS_ENCRYPT) {
4066 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4067 &attributes,
4068 slot->key.data,
4069 slot->key.bytes,
4070 alg);
4071 } else {
4072 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4073 &attributes,
4074 slot->key.data,
4075 slot->key.bytes,
4076 alg);
4077 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004078
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004079exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (status != PSA_SUCCESS) {
4081 psa_cipher_abort(operation);
4082 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004083
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004087}
4088
Gilles Peskine449bd832023-01-11 14:50:10 +01004089psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4090 mbedtls_svc_key_id_t key,
4091 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004092{
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004094}
4095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4097 mbedtls_svc_key_id_t key,
4098 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004099{
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004101}
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4104 uint8_t *iv,
4105 size_t iv_size,
4106 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004107{
Ronald Cron6d051732020-10-01 14:10:20 +02004108 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004109 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4110 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01004111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004113 status = PSA_ERROR_BAD_STATE;
4114 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004115 }
4116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004118 status = PSA_ERROR_BAD_STATE;
4119 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004120 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004121
Ronald Cron2fb90522021-07-05 12:31:44 +02004122 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004124 status = PSA_ERROR_BUFFER_TOO_SMALL;
4125 goto exit;
4126 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004129 status = PSA_ERROR_GENERIC_ERROR;
4130 goto exit;
4131 }
4132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 status = psa_generate_random(local_iv, default_iv_length);
4134 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004135 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 }
Ronald Cron5618a392021-03-26 09:52:26 +01004137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 status = psa_driver_wrapper_cipher_set_iv(operation,
4139 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004140
4141exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 if (status == PSA_SUCCESS) {
4143 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004144 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004145 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004147 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004149 }
Ronald Cron6d051732020-10-01 14:10:20 +02004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004152}
4153
Gilles Peskine449bd832023-01-11 14:50:10 +01004154psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4155 const uint8_t *iv,
4156 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004157{
Ronald Cron6d051732020-10-01 14:10:20 +02004158 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004159
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004161 status = PSA_ERROR_BAD_STATE;
4162 goto exit;
4163 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004166 status = PSA_ERROR_BAD_STATE;
4167 goto exit;
4168 }
Ronald Crona0d68172021-03-26 10:15:08 +01004169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004171 status = PSA_ERROR_INVALID_ARGUMENT;
4172 goto exit;
4173 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004174
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 status = psa_driver_wrapper_cipher_set_iv(operation,
4176 iv,
4177 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004178
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004179exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004181 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 } else {
4183 psa_cipher_abort(operation);
4184 }
4185 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004186}
4187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4189 const uint8_t *input,
4190 size_t input_length,
4191 uint8_t *output,
4192 size_t output_size,
4193 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004194{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004195 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004198 status = PSA_ERROR_BAD_STATE;
4199 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004200 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004201
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004203 status = PSA_ERROR_BAD_STATE;
4204 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004205 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 status = psa_driver_wrapper_cipher_update(operation,
4208 input,
4209 input_length,
4210 output,
4211 output_size,
4212 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004213
4214exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 if (status != PSA_SUCCESS) {
4216 psa_cipher_abort(operation);
4217 }
Ronald Cron6d051732020-10-01 14:10:20 +02004218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004220}
4221
Gilles Peskine449bd832023-01-11 14:50:10 +01004222psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4223 uint8_t *output,
4224 size_t output_size,
4225 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004226{
David Saadab4ecc272019-02-14 13:48:10 +02004227 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004230 status = PSA_ERROR_BAD_STATE;
4231 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004232 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004233
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004235 status = PSA_ERROR_BAD_STATE;
4236 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004237 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004238
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 status = psa_driver_wrapper_cipher_finish(operation,
4240 output,
4241 output_size,
4242 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004243
4244exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 if (status == PSA_SUCCESS) {
4246 return psa_cipher_abort(operation);
4247 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004248 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004252 }
mohammad1603503973b2018-03-12 15:59:30 +02004253}
4254
Gilles Peskine449bd832023-01-11 14:50:10 +01004255psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004256{
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004258 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004259 * in use. It's ok to call abort on such an object, and there's
4260 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004262 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004265
Ronald Cron49fafa92021-03-10 08:34:23 +01004266 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004267 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004268 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004271}
4272
Gilles Peskine449bd832023-01-11 14:50:10 +01004273psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4274 psa_algorithm_t alg,
4275 const uint8_t *input,
4276 size_t input_length,
4277 uint8_t *output,
4278 size_t output_size,
4279 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004280{
4281 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004282 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004283 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004284 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4285 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004286 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004289 status = PSA_ERROR_INVALID_ARGUMENT;
4290 goto exit;
4291 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004292
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4294 PSA_KEY_USAGE_ENCRYPT,
4295 alg);
4296 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004297 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004299
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004300 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004302 };
4303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4305 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004306 status = PSA_ERROR_GENERIC_ERROR;
4307 goto exit;
4308 }
4309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 if (default_iv_length > 0) {
4311 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004312 status = PSA_ERROR_BUFFER_TOO_SMALL;
4313 goto exit;
4314 }
4315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 status = psa_generate_random(local_iv, default_iv_length);
4317 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004318 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004320 }
4321
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004322 status = psa_driver_wrapper_cipher_encrypt(
4323 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004324 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004325 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004327
4328exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 unlock_status = psa_unlock_key_slot(slot);
4330 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004331 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004332 }
Ronald Cron23919522021-07-08 19:00:07 +02004333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 if (status == PSA_SUCCESS) {
4335 if (default_iv_length > 0) {
4336 memcpy(output, local_iv, default_iv_length);
4337 }
4338 *output_length += default_iv_length;
4339 } else {
4340 *output_length = 0;
4341 }
4342
4343 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004344}
4345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4347 psa_algorithm_t alg,
4348 const uint8_t *input,
4349 size_t input_length,
4350 uint8_t *output,
4351 size_t output_size,
4352 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004353{
4354 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004355 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004356 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004357 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004360 status = PSA_ERROR_INVALID_ARGUMENT;
4361 goto exit;
4362 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4365 PSA_KEY_USAGE_DECRYPT,
4366 alg);
4367 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004368 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004370
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004371 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004373 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4376 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004377 status = PSA_ERROR_INVALID_ARGUMENT;
4378 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004380 status = PSA_ERROR_INVALID_ARGUMENT;
4381 goto exit;
4382 }
4383
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004384 status = psa_driver_wrapper_cipher_decrypt(
4385 &attributes, slot->key.data, slot->key.bytes,
4386 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004388
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004389exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 unlock_status = psa_unlock_key_slot(slot);
4391 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004392 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004396 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 }
Ronald Cron23919522021-07-08 19:00:07 +02004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004400}
4401
4402
mohammad16035955c982018-04-26 00:53:03 +03004403/****************************************************************/
4404/* AEAD */
4405/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004406
Paul Elliottbaff51c2021-09-28 17:44:45 +01004407/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004409{
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004411}
4412
4413/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004414static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4415 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004416{
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004420#if defined(PSA_WANT_ALG_GCM)
4421 case PSA_ALG_GCM:
4422 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 * arbitrarily large nonces. Please note that we do not generally
4424 * recommend the usage of nonces of greater length than
4425 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4426 * size, which can then lead to collisions if you encrypt a very
4427 * large number of messages.*/
4428 if (nonce_length != 0) {
4429 return PSA_SUCCESS;
4430 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004431 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004432#endif /* PSA_WANT_ALG_GCM */
4433#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004434 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 if (nonce_length >= 7 && nonce_length <= 13) {
4436 return PSA_SUCCESS;
4437 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004438 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004439#endif /* PSA_WANT_ALG_CCM */
4440#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004441 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (nonce_length == 12) {
4443 return PSA_SUCCESS;
4444 } else if (nonce_length == 8) {
4445 return PSA_ERROR_NOT_SUPPORTED;
4446 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004447 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004448#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004449 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004450 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004452 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004455}
4456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004458{
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4460 return PSA_ERROR_INVALID_ARGUMENT;
4461 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004462
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004464}
4465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4467 psa_algorithm_t alg,
4468 const uint8_t *nonce,
4469 size_t nonce_length,
4470 const uint8_t *additional_data,
4471 size_t additional_data_length,
4472 const uint8_t *plaintext,
4473 size_t plaintext_length,
4474 uint8_t *ciphertext,
4475 size_t ciphertext_size,
4476 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004477{
Ronald Cron215633c2021-03-16 17:15:37 +01004478 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4479 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004480
mohammad1603f08a5502018-06-03 15:05:47 +03004481 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 status = psa_aead_check_algorithm(alg);
4484 if (status != PSA_SUCCESS) {
4485 return status;
4486 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004487
Ronald Cron9a986162021-03-26 12:40:07 +01004488 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4490 if (status != PSA_SUCCESS) {
4491 return status;
4492 }
mohammad16035955c982018-04-26 00:53:03 +03004493
Ronald Cron215633c2021-03-16 17:15:37 +01004494 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004496 };
mohammad16035955c982018-04-26 00:53:03 +03004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 status = psa_aead_check_nonce_length(alg, nonce_length);
4499 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004500 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004502
Ronald Cronde822812021-03-17 16:08:20 +01004503 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004504 &attributes, slot->key.data, slot->key.bytes,
4505 alg,
4506 nonce, nonce_length,
4507 additional_data, additional_data_length,
4508 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004510
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4512 memset(ciphertext, 0, ciphertext_size);
4513 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004514
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004515exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004519}
4520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4522 psa_algorithm_t alg,
4523 const uint8_t *nonce,
4524 size_t nonce_length,
4525 const uint8_t *additional_data,
4526 size_t additional_data_length,
4527 const uint8_t *ciphertext,
4528 size_t ciphertext_length,
4529 uint8_t *plaintext,
4530 size_t plaintext_size,
4531 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004532{
Ronald Cron215633c2021-03-16 17:15:37 +01004533 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4534 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004535
Gilles Peskineee652a32018-06-01 19:23:52 +02004536 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 status = psa_aead_check_algorithm(alg);
4539 if (status != PSA_SUCCESS) {
4540 return status;
4541 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004542
Ronald Cron9a986162021-03-26 12:40:07 +01004543 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4545 if (status != PSA_SUCCESS) {
4546 return status;
4547 }
mohammad16035955c982018-04-26 00:53:03 +03004548
Ronald Cron215633c2021-03-16 17:15:37 +01004549 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004551 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 status = psa_aead_check_nonce_length(alg, nonce_length);
4554 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004555 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004557
Ronald Cronde822812021-03-17 16:08:20 +01004558 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004559 &attributes, slot->key.data, slot->key.bytes,
4560 alg,
4561 nonce, nonce_length,
4562 additional_data, additional_data_length,
4563 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004565
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 if (status != PSA_SUCCESS && plaintext_size != 0) {
4567 memset(plaintext, 0, plaintext_size);
4568 }
mohammad160360a64d02018-06-03 17:20:42 +03004569
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004570exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 return status;
mohammad16035955c982018-04-26 00:53:03 +03004574}
4575
Gilles Peskine449bd832023-01-11 14:50:10 +01004576static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4577{
4578 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004581#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004583 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4585 return PSA_ERROR_INVALID_ARGUMENT;
4586 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004587 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004588#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004589
Przemek Stekiel86679c72022-10-06 17:06:56 +02004590#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004592 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4594 return PSA_ERROR_INVALID_ARGUMENT;
4595 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004596 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004597#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004598
Przemek Stekiel86679c72022-10-06 17:06:56 +02004599#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004601 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 if (tag_len != 16) {
4603 return PSA_ERROR_INVALID_ARGUMENT;
4604 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004605 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004606#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004607
4608 default:
4609 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004611 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004613}
4614
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004615/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004616static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4617 int is_encrypt,
4618 mbedtls_svc_key_id_t key,
4619 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004620{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004621 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4622 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4623 psa_key_slot_t *slot = NULL;
4624 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004625 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 status = psa_aead_check_algorithm(alg);
4628 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004629 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004633 status = PSA_ERROR_BAD_STATE;
4634 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004635 }
4636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (operation->nonce_set || operation->lengths_set ||
4638 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004639 status = PSA_ERROR_BAD_STATE;
4640 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004641 }
4642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004644 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004646 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4650 alg);
4651 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004652 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004654
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004655 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004656 .core = slot->attr
4657 };
4658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004660 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if (is_encrypt) {
4664 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4665 &attributes,
4666 slot->key.data,
4667 slot->key.bytes,
4668 alg);
4669 } else {
4670 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4671 &attributes,
4672 slot->key.data,
4673 slot->key.bytes,
4674 alg);
4675 }
4676 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004677 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004681
4682exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004686 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004688 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 } else {
4690 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004691 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004694}
4695
Paul Elliott302ff6b2021-04-20 18:10:30 +01004696/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004697psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4698 mbedtls_svc_key_id_t key,
4699 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004700{
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004702}
4703
4704/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004705psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4706 mbedtls_svc_key_id_t key,
4707 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004708{
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004710}
4711
4712/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4714 uint8_t *nonce,
4715 size_t nonce_size,
4716 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004717{
4718 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004719 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01004720 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004721
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004722 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004725 status = PSA_ERROR_BAD_STATE;
4726 goto exit;
4727 }
4728
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004730 status = PSA_ERROR_BAD_STATE;
4731 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004732 }
4733
Paul Elliotte193ea82021-10-01 13:00:16 +01004734 /* For CCM, this size may not be correct according to the PSA
4735 * specification. The PSA Crypto 1.0.1 specification states:
4736 *
4737 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4738 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4739 *
4740 * However this restriction that L has to be the smallest integer is not
4741 * applied in practice, and it is not implementable here since the
4742 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4744 operation->alg);
4745 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004746 status = PSA_ERROR_BUFFER_TOO_SMALL;
4747 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004748 }
4749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 status = psa_generate_random(local_nonce, required_nonce_size);
4751 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004752 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004756
Paul Elliott39dc6b82021-05-11 19:16:09 +01004757exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 if (status == PSA_SUCCESS) {
4759 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004760 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 } else {
4762 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004763 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004766}
4767
4768/* Set the nonce for a multipart authenticated encryption or decryption
4769 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004770psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4771 const uint8_t *nonce,
4772 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004773{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004774 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004777 status = PSA_ERROR_BAD_STATE;
4778 goto exit;
4779 }
4780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004782 status = PSA_ERROR_BAD_STATE;
4783 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004784 }
4785
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4787 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004788 status = PSA_ERROR_INVALID_ARGUMENT;
4789 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004790 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004791
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4793 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004794
Paul Elliott39dc6b82021-05-11 19:16:09 +01004795exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004797 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 } else {
4799 psa_aead_abort(operation);
4800 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004803}
4804
4805/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4807 size_t ad_length,
4808 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004809{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004810 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004813 status = PSA_ERROR_BAD_STATE;
4814 goto exit;
4815 }
4816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (operation->lengths_set || operation->ad_started ||
4818 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004819 status = PSA_ERROR_BAD_STATE;
4820 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004821 }
4822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004824#if defined(PSA_WANT_ALG_GCM)
4825 case PSA_ALG_GCM:
4826 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 * bits. Without the guard this code will generate warnings on 32bit
4828 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004829#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (((uint64_t) ad_length) >> 61 != 0 ||
4831 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004832 status = PSA_ERROR_INVALID_ARGUMENT;
4833 goto exit;
4834 }
Paul Elliott325d3742021-09-27 17:56:28 +01004835#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004836 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004837#endif /* PSA_WANT_ALG_GCM */
4838#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004839 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004841 status = PSA_ERROR_INVALID_ARGUMENT;
4842 goto exit;
4843 }
4844 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004845#endif /* PSA_WANT_ALG_CCM */
4846#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004847 case PSA_ALG_CHACHA20_POLY1305:
4848 /* No length restrictions for ChaChaPoly. */
4849 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004850#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004851 default:
4852 break;
4853 }
Paul Elliott325d3742021-09-27 17:56:28 +01004854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4856 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004857
Paul Elliott39dc6b82021-05-11 19:16:09 +01004858exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004860 operation->ad_remaining = ad_length;
4861 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004862 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 } else {
4864 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004865 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004868}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004869
4870/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004871psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4872 const uint8_t *input,
4873 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004874{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004875 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004878 status = PSA_ERROR_BAD_STATE;
4879 goto exit;
4880 }
4881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004883 status = PSA_ERROR_BAD_STATE;
4884 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004885 }
4886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (operation->lengths_set) {
4888 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004889 status = PSA_ERROR_INVALID_ARGUMENT;
4890 goto exit;
4891 }
4892
4893 operation->ad_remaining -= input_length;
4894 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004895#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004897 status = PSA_ERROR_BAD_STATE;
4898 goto exit;
4899 }
4900#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 status = psa_driver_wrapper_aead_update_ad(operation, input,
4903 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004904
Paul Elliott39dc6b82021-05-11 19:16:09 +01004905exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004907 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 } else {
4909 psa_aead_abort(operation);
4910 }
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/* Encrypt or decrypt a message fragment in an active multipart AEAD
4916 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004917psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4918 const uint8_t *input,
4919 size_t input_length,
4920 uint8_t *output,
4921 size_t output_size,
4922 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004923{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004924 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004925
4926 *output_length = 0;
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004929 status = PSA_ERROR_BAD_STATE;
4930 goto exit;
4931 }
4932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004934 status = PSA_ERROR_BAD_STATE;
4935 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004936 }
4937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004939 /* Additional data length was supplied, but not all the additional
4940 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004942 status = PSA_ERROR_INVALID_ARGUMENT;
4943 goto exit;
4944 }
4945
4946 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004948 status = PSA_ERROR_INVALID_ARGUMENT;
4949 goto exit;
4950 }
4951
4952 operation->body_remaining -= input_length;
4953 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004954#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004956 status = PSA_ERROR_BAD_STATE;
4957 goto exit;
4958 }
4959#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4962 output, output_size,
4963 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004964
Paul Elliott39dc6b82021-05-11 19:16:09 +01004965exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004967 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 } else {
4969 psa_aead_abort(operation);
4970 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004973}
4974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004976{
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 if (operation->id == 0 || !operation->nonce_set) {
4978 return PSA_ERROR_BAD_STATE;
4979 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4982 operation->body_remaining != 0)) {
4983 return PSA_ERROR_INVALID_ARGUMENT;
4984 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004985
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004987}
4988
Paul Elliott302ff6b2021-04-20 18:10:30 +01004989/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004990psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4991 uint8_t *ciphertext,
4992 size_t ciphertext_size,
4993 size_t *ciphertext_length,
4994 uint8_t *tag,
4995 size_t tag_size,
4996 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004997{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4999
Paul Elliott302ff6b2021-04-20 18:10:30 +01005000 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005001 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 status = psa_aead_final_checks(operation);
5004 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005005 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005009 status = PSA_ERROR_BAD_STATE;
5010 goto exit;
5011 }
5012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5014 ciphertext_size,
5015 ciphertext_length,
5016 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005017
Paul Elliott39dc6b82021-05-11 19:16:09 +01005018exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005019
5020
Paul Elliottf47b0952021-05-21 18:02:33 +01005021 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005022 * the zero tag size, make sure the tag is set to something implausible.
5023 * Even if the operation succeeds, make sure we clear the rest of the
5024 * buffer to prevent potential leakage of anything previously placed in
5025 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005026 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005031}
5032
5033/* Finish authenticating and decrypting a message in a multipart AEAD
5034 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005035psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5036 uint8_t *plaintext,
5037 size_t plaintext_size,
5038 size_t *plaintext_length,
5039 const uint8_t *tag,
5040 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005041{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005042 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5043
Paul Elliott302ff6b2021-04-20 18:10:30 +01005044 *plaintext_length = 0;
5045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 status = psa_aead_final_checks(operation);
5047 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005048 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005050
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005052 status = PSA_ERROR_BAD_STATE;
5053 goto exit;
5054 }
5055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5057 plaintext_size,
5058 plaintext_length,
5059 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005060
5061exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005065}
5066
5067/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005068psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005069{
5070 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5071
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005073 /* The object has (apparently) been initialized but it is not (yet)
5074 * in use. It's ok to call abort on such an object, and there's
5075 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005077 }
5078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005080
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005084}
5085
Gilles Peskinee59236f2018-01-27 23:32:46 +01005086/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005087/* Generators */
5088/****************************************************************/
5089
Przemek Stekiel69c46792022-06-10 12:59:51 +02005090#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005091 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005092 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305093 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
5094 defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
John Durkop07cc04a2020-11-16 22:08:34 -08005095#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005096#endif /* At least one builtin KDF */
5097
Przemek Stekiel69c46792022-06-10 12:59:51 +02005098#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005099 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5100 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5101static psa_status_t psa_key_derivation_start_hmac(
5102 psa_mac_operation_t *operation,
5103 psa_algorithm_t hash_alg,
5104 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005106{
5107 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5108 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5110 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5111 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005112
Steven Cooreman72f736a2021-05-07 14:14:37 +02005113 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005115
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 status = psa_driver_wrapper_mac_sign_setup(operation,
5117 &attributes,
5118 hmac_key, hmac_key_length,
5119 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 psa_reset_key_attributes(&attributes);
5122 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005123}
5124#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005125
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005126#define HKDF_STATE_INIT 0 /* no input yet */
5127#define HKDF_STATE_STARTED 1 /* got salt */
5128#define HKDF_STATE_KEYED 2 /* got key */
5129#define HKDF_STATE_OUTPUT 3 /* output started */
5130
Gilles Peskinecbe66502019-05-16 16:59:18 +02005131static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005133{
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5135 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5136 } else {
5137 return operation->alg;
5138 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005139}
5140
Gilles Peskine449bd832023-01-11 14:50:10 +01005141psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005142{
5143 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5145 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005146 /* The object has (apparently) been initialized but it is not
5147 * in use. It's ok to call abort on such an object, and there's
5148 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005150#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5152 mbedtls_free(operation->ctx.hkdf.info);
5153 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5154 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005155#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005156#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5157 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5159 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5160 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5161 if (operation->ctx.tls12_prf.secret != NULL) {
5162 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
5163 operation->ctx.tls12_prf.secret_length);
5164 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooremana6df6042021-04-29 19:32:25 +02005165 }
5166
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 if (operation->ctx.tls12_prf.seed != NULL) {
5168 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
5169 operation->ctx.tls12_prf.seed_length);
5170 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01005171 }
5172
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (operation->ctx.tls12_prf.label != NULL) {
5174 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
5175 operation->ctx.tls12_prf.label_length);
5176 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01005177 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005178#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 if (operation->ctx.tls12_prf.other_secret != NULL) {
5180 mbedtls_platform_zeroize(operation->ctx.tls12_prf.other_secret,
5181 operation->ctx.tls12_prf.other_secret_length);
5182 mbedtls_free(operation->ctx.tls12_prf.other_secret);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005183 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005184#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005185 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005186
5187 /* We leave the fields Ai and output_block to be erased safely by the
5188 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005190#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5191 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005192#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5194 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5195 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5196 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005197#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305198#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
5199 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305200 if (operation->ctx.pbkdf2.salt != NULL) {
5201 mbedtls_platform_zeroize(operation->ctx.pbkdf2.salt,
5202 operation->ctx.pbkdf2.salt_length);
5203 mbedtls_free(operation->ctx.pbkdf2.salt);
5204 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305205
5206 status = PSA_SUCCESS;
5207 } else
5208#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005209 {
5210 status = PSA_ERROR_BAD_STATE;
5211 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 mbedtls_platform_zeroize(operation, sizeof(*operation));
5213 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005214}
5215
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005216psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005218{
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005220 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005222 }
5223
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005224 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005226}
5227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5229 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005230{
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (operation->alg == 0) {
5232 return PSA_ERROR_BAD_STATE;
5233 }
5234 if (capacity > operation->capacity) {
5235 return PSA_ERROR_INVALID_ARGUMENT;
5236 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005237 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005239}
5240
Przemek Stekiel69c46792022-06-10 12:59:51 +02005241#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005242/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005243static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5244 psa_algorithm_t kdf_alg,
5245 uint8_t *output,
5246 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005247{
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5249 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005250 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005251 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005252#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005254#else
5255 const uint8_t last_block = 0xff;
5256#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005257
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 if (hkdf->state < HKDF_STATE_KEYED ||
5259 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005260#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005262#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 )) {
5264 return PSA_ERROR_BAD_STATE;
5265 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005266 hkdf->state = HKDF_STATE_OUTPUT;
5267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005269 /* Copy what remains of the current block */
5270 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005272 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 }
5274 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005275 output += n;
5276 output_length -= n;
5277 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005279 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005281 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005282 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005283 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005284 * object was corrupted or if this function is called directly
5285 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if (hkdf->block_number == last_block) {
5287 return PSA_ERROR_BAD_STATE;
5288 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005289
5290 /* We need a new block */
5291 ++hkdf->block_number;
5292 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005293
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5295 hash_alg,
5296 hkdf->prk,
5297 hash_length);
5298 if (status != PSA_SUCCESS) {
5299 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005300 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005301
5302 if (hkdf->block_number != 1) {
5303 status = psa_mac_update(&hkdf->hmac,
5304 hkdf->output_block,
5305 hash_length);
5306 if (status != PSA_SUCCESS) {
5307 return status;
5308 }
5309 }
5310 status = psa_mac_update(&hkdf->hmac,
5311 hkdf->info,
5312 hkdf->info_length);
5313 if (status != PSA_SUCCESS) {
5314 return status;
5315 }
5316 status = psa_mac_update(&hkdf->hmac,
5317 &hkdf->block_number, 1);
5318 if (status != PSA_SUCCESS) {
5319 return status;
5320 }
5321 status = psa_mac_sign_finish(&hkdf->hmac,
5322 hkdf->output_block,
5323 sizeof(hkdf->output_block),
5324 &hmac_output_length);
5325 if (status != PSA_SUCCESS) {
5326 return status;
5327 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005328 }
5329
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005331}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005332#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005333
John Durkop07cc04a2020-11-16 22:08:34 -08005334#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5335 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005336static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5337 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005339{
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5341 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005342 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5343 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005344 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005345
Janos Follath7742fee2019-06-17 12:58:10 +01005346 /* We can't be wanting more output after block 0xff, otherwise
5347 * the capacity check in psa_key_derivation_output_bytes() would have
5348 * prevented this call. It could happen only if the operation
5349 * object was corrupted or if this function is called directly
5350 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 if (tls12_prf->block_number == 0xff) {
5352 return PSA_ERROR_CORRUPTION_DETECTED;
5353 }
Janos Follath7742fee2019-06-17 12:58:10 +01005354
5355 /* We need a new block */
5356 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005357 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005358
5359 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5360 *
5361 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5362 *
5363 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5364 * HMAC_hash(secret, A(2) + seed) +
5365 * HMAC_hash(secret, A(3) + seed) + ...
5366 *
5367 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005368 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005369 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005370 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005371 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005372 * is currently extracted as `output_block` and where i is
5373 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005374 */
5375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 status = psa_key_derivation_start_hmac(&hmac,
5377 hash_alg,
5378 tls12_prf->secret,
5379 tls12_prf->secret_length);
5380 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005381 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005383
5384 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005386 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5387 * the variable seed and in this instance means it in the context of the
5388 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 status = psa_mac_update(&hmac,
5390 tls12_prf->label,
5391 tls12_prf->label_length);
5392 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005393 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 }
5395 status = psa_mac_update(&hmac,
5396 tls12_prf->seed,
5397 tls12_prf->seed_length);
5398 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005399 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 }
5401 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005402 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5404 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005405 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005407 }
5408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 status = psa_mac_sign_finish(&hmac,
5410 tls12_prf->Ai, hash_length,
5411 &hmac_output_length);
5412 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005413 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 }
5415 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005416 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005418
5419 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 status = psa_key_derivation_start_hmac(&hmac,
5421 hash_alg,
5422 tls12_prf->secret,
5423 tls12_prf->secret_length);
5424 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005425 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 }
5427 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5428 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005429 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 }
5431 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5432 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005433 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 }
5435 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5436 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005437 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 }
5439 status = psa_mac_sign_finish(&hmac,
5440 tls12_prf->output_block, hash_length,
5441 &hmac_output_length);
5442 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005443 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005445
Janos Follath7742fee2019-06-17 12:58:10 +01005446
5447cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 cleanup_status = psa_mac_abort(&hmac);
5449 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005450 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005452
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005454}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005455
Janos Follath844eb0e2019-06-19 12:10:49 +01005456static psa_status_t psa_key_derivation_tls12_prf_read(
5457 psa_tls12_prf_key_derivation_t *tls12_prf,
5458 psa_algorithm_t alg,
5459 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005461{
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5463 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005464 psa_status_t status;
5465 uint8_t offset, length;
5466
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005468 case PSA_TLS12_PRF_STATE_LABEL_SET:
5469 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5470 break;
5471 case PSA_TLS12_PRF_STATE_OUTPUT:
5472 break;
5473 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005475 }
5476
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005478 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 if (tls12_prf->left_in_block == 0) {
5480 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5481 alg);
5482 if (status != PSA_SUCCESS) {
5483 return status;
5484 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005485
5486 continue;
5487 }
5488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005490 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005492 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005494
5495 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005497 output += length;
5498 output_length -= length;
5499 tls12_prf->left_in_block -= length;
5500 }
5501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005503}
John Durkop07cc04a2020-11-16 22:08:34 -08005504#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5505 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005506
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005507#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5508static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5509 psa_tls12_ecjpake_to_pms_t *ecjpake,
5510 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005512{
5513 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005514 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005515
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (output_length != 32) {
5517 return PSA_ERROR_INVALID_ARGUMENT;
5518 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5521 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5522 &output_size);
5523 if (status != PSA_SUCCESS) {
5524 return status;
5525 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005526
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (output_size != output_length) {
5528 return PSA_ERROR_GENERIC_ERROR;
5529 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005532}
5533#endif
5534
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305535#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
5536static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5537 psa_pbkdf2_key_derivation_t *pbkdf2,
5538 psa_algorithm_t prf_alg,
5539 uint8_t prf_output_length,
5540 psa_key_attributes_t *attributes)
5541{
5542 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305543 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305544 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305545 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305546 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305547 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305548 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305549
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305550 mac_operation.is_sign = 1;
5551 mac_operation.mac_size = prf_output_length;
5552 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305553
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305554 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5555 attributes,
5556 pbkdf2->password,
5557 pbkdf2->password_length,
5558 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305559 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305560 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305561 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305562 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5563 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305564 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305565 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305566 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305567 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305568 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305569 }
5570 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5571 &mac_output_length);
5572 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305573 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305574 }
5575
5576 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305577 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305578 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305579 }
5580
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305581 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305582
5583 for (i = 1; i < pbkdf2->input_cost; i++) {
5584 status = psa_driver_wrapper_mac_compute(attributes,
5585 pbkdf2->password,
5586 pbkdf2->password_length,
5587 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305588 U_i, sizeof(U_i),
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305589 &mac_output_length);
5590 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305591 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305592 }
5593
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305594 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305595 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305596
5597cleanup:
5598 /* Zeroise buffers to clear sensitive data from memory. */
5599 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5600 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305601}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305602
5603static psa_status_t psa_key_derivation_pbkdf2_read(
5604 psa_pbkdf2_key_derivation_t *pbkdf2,
5605 psa_algorithm_t kdf_alg,
5606 uint8_t *output,
5607 size_t output_length)
5608{
5609 psa_status_t status;
5610 psa_algorithm_t prf_alg;
5611 uint8_t prf_output_length;
5612 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5613 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5614 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5615
5616 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5617 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5618 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5619 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305620 } else {
5621 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305622 }
5623
5624 switch (pbkdf2->state) {
5625 case PSA_PBKDF2_STATE_PASSWORD_SET:
5626 /* Initially we need a new block so bytes_used is equal to block size*/
5627 pbkdf2->bytes_used = prf_output_length;
5628 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5629 break;
5630 case PSA_PBKDF2_STATE_OUTPUT:
5631 break;
5632 default:
5633 return PSA_ERROR_BAD_STATE;
5634 }
5635
5636 while (output_length != 0) {
5637 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5638 if (n > output_length) {
5639 n = (uint8_t) output_length;
5640 }
5641 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5642 output += n;
5643 output_length -= n;
5644 pbkdf2->bytes_used += n;
5645
5646 if (output_length == 0) {
5647 break;
5648 }
5649
5650 /* We need a new block */
5651 pbkdf2->bytes_used = 0;
5652 pbkdf2->block_number++;
5653
5654 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5655 prf_output_length,
5656 &attributes);
5657 if (status != PSA_SUCCESS) {
5658 return status;
5659 }
5660 }
5661
5662 return PSA_SUCCESS;
5663}
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305664#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
5665
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005666psa_status_t psa_key_derivation_output_bytes(
5667 psa_key_derivation_operation_t *operation,
5668 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005670{
5671 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005673
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005675 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005677 }
5678
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005680 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005681 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005682 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005683 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005684 goto exit;
5685 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005687 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005688 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005689 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5690 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005691 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005692 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005694 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005695 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005696
Przemek Stekiel69c46792022-06-10 12:59:51 +02005697#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5699 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5700 output, output_length);
5701 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005702#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005703#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5704 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5706 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5707 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5708 kdf_alg, output,
5709 output_length);
5710 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005711#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5712 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005713#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005715 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5717 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005718#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305719#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
5720 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305721 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5722 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305723 } else
5724#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005725
Gilles Peskineeab56e42018-07-12 17:12:33 +02005726 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005727 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005729 }
5730
5731exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005733 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005734 * This allows us to differentiate between exhausted operations and
5735 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5736 * operations. */
5737 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005739 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005743}
5744
David Brown7807bf72021-02-09 16:28:23 -07005745#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005746static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005747{
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 if (data_size >= 8) {
5749 mbedtls_des_key_set_parity(data);
5750 }
5751 if (data_size >= 16) {
5752 mbedtls_des_key_set_parity(data + 8);
5753 }
5754 if (data_size >= 24) {
5755 mbedtls_des_key_set_parity(data + 16);
5756 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005757}
David Brown7807bf72021-02-09 16:28:23 -07005758#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005759
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005760/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 * ECC keys on a Weierstrass elliptic curve require the generation
5762 * of a private key which is an integer
5763 * in the range [1, N - 1], where N is the boundary of the private key domain:
5764 * N is the prime p for Diffie-Hellman, or the order of the
5765 * curve’s base point for ECC.
5766 *
5767 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5768 * This function generates the private key using the following process:
5769 *
5770 * 1. Draw a byte string of length ceiling(m/8) bytes.
5771 * 2. If m is not a multiple of 8, set the most significant
5772 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5773 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5774 * 4. If k > N - 2, discard the result and return to step 1.
5775 * 5. Output k + 1 as the private key.
5776 *
5777 * This method allows compliance to NIST standards, specifically the methods titled
5778 * Key-Pair Generation by Testing Candidates in the following publications:
5779 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5780 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5781 * Diffie-Hellman keys.
5782 *
5783 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5784 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5785 *
5786 * Note: Function allocates memory for *data buffer, so given *data should be
5787 * always NULL.
5788 */
Valerio Setti8bb57632023-05-26 13:48:07 +02005789#if defined(MBEDTLS_PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_LEGACY) || \
Joakim Anderssonbb576fe2023-03-01 11:23:02 +01005790 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) || \
Przemek Stekiel7fc07512022-03-04 14:41:11 +01005791 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
5792 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
5793 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005794static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005795 psa_key_slot_t *slot,
5796 size_t bits,
5797 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005798 uint8_t **data
5799 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005800{
Valerio Setti52789862023-04-07 12:13:11 +02005801#if defined(MBEDTLS_ECP_LIGHT)
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005802 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005803 mbedtls_mpi k;
5804 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005805 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005807 size_t m;
5808 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 mbedtls_mpi_init(&k);
5811 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005812
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005813 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005815 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005817
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005819 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005820 goto cleanup;
5821 }
5822
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005823 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005827
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005828 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005829 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005830 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005831
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005832 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005833
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005834 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005836
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005837 /* Note: This function is always called with *data == NULL and it
5838 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 *data = mbedtls_calloc(1, m_bytes);
5840 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005841 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005842 goto cleanup;
5843 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005846 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005848 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005850
5851 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005853 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005854 * (8 * ceiling(m/8) - m) bits of the first byte in
5855 * the string to zero.
5856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005858 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005859 }
5860
5861 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 * big-endian byte string.
5863 */
5864 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005865
5866 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 * Result of comparison is returned. When it indicates error
5868 * then this function is called again.
5869 */
5870 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005871 }
5872
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005873 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5875 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005876cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 if (ret != 0) {
5878 status = mbedtls_to_psa_error(ret);
5879 }
5880 if (status != PSA_SUCCESS) {
5881 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005882 *data = NULL;
5883 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 mbedtls_mpi_free(&k);
5885 mbedtls_mpi_free(&diff_N_2);
5886 return status;
Valerio Setti52789862023-04-07 12:13:11 +02005887#else /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard38316372023-03-17 12:18:32 +01005888 (void) slot;
5889 (void) bits;
5890 (void) operation;
5891 (void) data;
5892 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti52789862023-04-07 12:13:11 +02005893#endif /* MBEDTLS_ECP_LIGHT */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005894}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005895
5896/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5897 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5898 *
5899 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5900 * draw a 32-byte string and process it as specified in
5901 * Elliptic Curves for Security [RFC7748] §5.
5902 *
5903 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5904 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5905 *
5906 * Note: Function allocates memory for *data buffer, so given *data should be
5907 * always NULL.
5908 */
5909
5910static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5911 size_t bits,
5912 psa_key_derivation_operation_t *operation,
5913 uint8_t **data
5914 )
5915{
5916 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005917 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005920 case 255:
5921 output_length = 32;
5922 break;
5923 case 448:
5924 output_length = 56;
5925 break;
5926 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005928 break;
5929 }
5930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 if (*data == NULL) {
5934 return PSA_ERROR_INSUFFICIENT_MEMORY;
5935 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005938
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005940 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005942
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005944 case 255:
5945 (*data)[0] &= 248;
5946 (*data)[31] &= 127;
5947 (*data)[31] |= 64;
5948 break;
5949 case 448:
5950 (*data)[0] &= 252;
5951 (*data)[55] |= 128;
5952 break;
5953 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005955 break;
5956 }
5957
5958 return status;
5959}
Valerio Setti8bb57632023-05-26 13:48:07 +02005960#endif /* defined(MBEDTLS_PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_LEGACY) ||
Joakim Anderssonbb576fe2023-03-01 11:23:02 +01005961 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) ||
Przemek Stekiel7fc07512022-03-04 14:41:11 +01005962 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
5963 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
5964 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005965
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005966static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005967 psa_key_slot_t *slot,
5968 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005970{
5971 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305973 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005974 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005975 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5978 return PSA_ERROR_INVALID_ARGUMENT;
5979 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005980
Valerio Setti8bb57632023-05-26 13:48:07 +02005981#if defined(MBEDTLS_PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_LEGACY) || \
Joakim Anderssonbb576fe2023-03-01 11:23:02 +01005982 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) || \
Przemek Stekiel7fc07512022-03-04 14:41:11 +01005983 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
5984 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
5985 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5987 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5988 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005989 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5991 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005992 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 }
5994 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005995 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5997 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005998 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006000 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006001 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02006002#endif /* defined(MBEDTLS_PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_LEGACY) ||
Joakim Anderssonbb576fe2023-03-01 11:23:02 +01006003 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY) ||
Przemek Stekiel7fc07512022-03-04 14:41:11 +01006004 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
6005 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
6006 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 if (key_type_is_raw_bytes(slot->attr.type)) {
6008 if (bits % 8 != 0) {
6009 return PSA_ERROR_INVALID_ARGUMENT;
6010 }
6011 data = mbedtls_calloc(1, bytes);
6012 if (data == NULL) {
6013 return PSA_ERROR_INSUFFICIENT_MEMORY;
6014 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 status = psa_key_derivation_output_bytes(operation, data, bytes);
6017 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006018 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 }
David Brown12ca5032021-02-11 11:02:00 -07006020#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6022 psa_des_set_key_parity(data, bytes);
6023 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006024#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 } else {
6026 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006027 }
Ronald Crondd04d422020-11-28 15:14:42 +01006028
Ronald Cronbf33c932020-11-28 18:06:53 +01006029 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006030 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006032 };
6033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6035 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6036 &storage_size);
6037 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306038 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 }
Archanad8a83dc2021-06-14 10:04:16 +05306040 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 status = psa_allocate_buffer_to_slot(slot, storage_size);
6042 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306043 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 }
Archanad8a83dc2021-06-14 10:04:16 +05306045
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 status = psa_driver_wrapper_import_key(&attributes,
6047 data, bytes,
6048 slot->key.data,
6049 slot->key.bytes,
6050 &slot->key.bytes, &bits);
6051 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006052 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006054
6055exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 mbedtls_free(data);
6057 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006058}
6059
Gilles Peskine449bd832023-01-11 14:50:10 +01006060psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6061 psa_key_derivation_operation_t *operation,
6062 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006063{
6064 psa_status_t status;
6065 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006066 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006067
Ronald Cron81709fc2020-11-14 12:10:32 +01006068 *key = MBEDTLS_SVC_KEY_ID_INIT;
6069
Gilles Peskine0f84d622019-09-12 19:03:13 +02006070 /* Reject any attempt to create a zero-length key so that we don't
6071 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 if (psa_get_key_bits(attributes) == 0) {
6073 return PSA_ERROR_INVALID_ARGUMENT;
6074 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 if (operation->alg == PSA_ALG_NONE) {
6077 return PSA_ERROR_BAD_STATE;
6078 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 if (!operation->can_output_key) {
6081 return PSA_ERROR_NOT_PERMITTED;
6082 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006083
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6085 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006086#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006088 /* Deriving a key in a secure element is not implemented yet. */
6089 status = PSA_ERROR_NOT_SUPPORTED;
6090 }
6091#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if (status == PSA_SUCCESS) {
6093 status = psa_generate_derived_key_internal(slot,
6094 attributes->core.bits,
6095 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006096 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (status == PSA_SUCCESS) {
6098 status = psa_finish_key_creation(slot, driver, key);
6099 }
6100 if (status != PSA_SUCCESS) {
6101 psa_fail_key_creation(slot, driver);
6102 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006103
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006105}
6106
Gilles Peskineeab56e42018-07-12 17:12:33 +02006107
6108
6109/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006110/* Key derivation */
6111/****************************************************************/
6112
Steven Cooreman932ffb72021-02-15 12:14:32 +01006113#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006114static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006115{
6116#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6118 return 1;
6119 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006120#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006121#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6123 return 1;
6124 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006125#endif
6126#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6128 return 1;
6129 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006130#endif
6131#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6133 return 1;
6134 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006135#endif
6136#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6138 return 1;
6139 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006140#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006141#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6143 return 1;
6144 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006145#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306146#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6147 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6148 return 1;
6149 }
6150#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006152}
6153
Gilles Peskine449bd832023-01-11 14:50:10 +01006154static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006155{
6156 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 psa_status_t status = psa_hash_setup(&operation, alg);
6158 psa_hash_abort(&operation);
6159 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006160}
6161
Gilles Peskine969c5d62019-01-16 15:53:06 +01006162static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006163 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006165{
Janos Follath5fe19732019-06-20 15:09:30 +01006166 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6167 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006169
Gilles Peskine969c5d62019-01-16 15:53:06 +01006170 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 if (!is_kdf_alg_supported(kdf_alg)) {
6172 return PSA_ERROR_NOT_SUPPORTED;
6173 }
John Durkop07cc04a2020-11-16 22:08:34 -08006174
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006175 /* All currently supported key derivation algorithms (apart from
Andrzej Kurek702776f2022-09-16 06:22:44 -04006176 * ecjpake to pms) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6178 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
6179 if (kdf_alg != PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6180 if (hash_size == 0) {
6181 return PSA_ERROR_NOT_SUPPORTED;
6182 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006183
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006184 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6185 * we might fail later, which is somewhat unfriendly and potentially
6186 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 psa_status_t status = psa_hash_try_support(hash_alg);
6188 if (status != PSA_SUCCESS) {
6189 return status;
6190 }
6191 } else {
6192 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006193 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6196 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6197 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6198 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006199 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006200#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006201 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6203 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006204 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006206#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6207 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 operation->capacity = 255 * hash_size;
6209 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006210}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006211
Gilles Peskine449bd832023-01-11 14:50:10 +01006212static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006213{
6214#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 if (alg == PSA_ALG_ECDH) {
6216 return PSA_SUCCESS;
6217 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006218#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006219#if defined(PSA_WANT_ALG_FFDH)
6220 if (alg == PSA_ALG_FFDH) {
6221 return PSA_SUCCESS;
6222 }
6223#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006224 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006226}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006227
6228static int psa_key_derivation_allows_free_form_secret_input(
6229 psa_algorithm_t kdf_alg)
6230{
6231#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6232 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6233 return 0;
6234 }
6235#endif
6236 (void) kdf_alg;
6237 return 1;
6238}
John Durkop07cc04a2020-11-16 22:08:34 -08006239#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6242 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006243{
6244 psa_status_t status;
6245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 if (operation->alg != 0) {
6247 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006248 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6251 return PSA_ERROR_INVALID_ARGUMENT;
6252 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6253#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6254 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6255 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6256 status = psa_key_agreement_try_support(ka_alg);
6257 if (status != PSA_SUCCESS) {
6258 return status;
6259 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006260 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6261 return PSA_ERROR_INVALID_ARGUMENT;
6262 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6264#else
6265 return PSA_ERROR_NOT_SUPPORTED;
6266#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6267 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6268#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6269 status = psa_key_derivation_setup_kdf(operation, alg);
6270#else
6271 return PSA_ERROR_NOT_SUPPORTED;
6272#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6273 } else {
6274 return PSA_ERROR_INVALID_ARGUMENT;
6275 }
6276
6277 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006278 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 }
6280 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006281}
6282
Przemek Stekiel69c46792022-06-10 12:59:51 +02006283#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006284static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6285 psa_algorithm_t kdf_alg,
6286 psa_key_derivation_step_t step,
6287 const uint8_t *data,
6288 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006289{
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006291 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006293 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006294#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6296 return PSA_ERROR_INVALID_ARGUMENT;
6297 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006298#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 if (hkdf->state != HKDF_STATE_INIT) {
6300 return PSA_ERROR_BAD_STATE;
6301 } else {
6302 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6303 hash_alg,
6304 data, data_length);
6305 if (status != PSA_SUCCESS) {
6306 return status;
6307 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006308 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006310 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006311 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006312#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006314 /* We shouldn't be in different state as HKDF_EXPAND only allows
6315 * two inputs: SECRET (this case) and INFO which does not modify
6316 * the state. It could happen only if the hkdf
6317 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 if (hkdf->state != HKDF_STATE_INIT) {
6319 return PSA_ERROR_BAD_STATE;
6320 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006321
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006322 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6324 return PSA_ERROR_INVALID_ARGUMENT;
6325 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 memcpy(hkdf->prk, data, data_length);
6328 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006329#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006330 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006331 /* HKDF: If no salt was provided, use an empty salt.
6332 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006334#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6336 return PSA_ERROR_BAD_STATE;
6337 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006338#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6340 hash_alg,
6341 NULL, 0);
6342 if (status != PSA_SUCCESS) {
6343 return status;
6344 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006345 hkdf->state = HKDF_STATE_STARTED;
6346 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 if (hkdf->state != HKDF_STATE_STARTED) {
6348 return PSA_ERROR_BAD_STATE;
6349 }
6350 status = psa_mac_update(&hkdf->hmac,
6351 data, data_length);
6352 if (status != PSA_SUCCESS) {
6353 return status;
6354 }
6355 status = psa_mac_sign_finish(&hkdf->hmac,
6356 hkdf->prk,
6357 sizeof(hkdf->prk),
6358 &data_length);
6359 if (status != PSA_SUCCESS) {
6360 return status;
6361 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006362 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006363
Gilles Peskine2b522db2019-04-12 15:11:49 +02006364 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006365 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006366#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006368 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006370 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006372#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006373 {
6374 /* Block 0 is empty, and the next block will be
6375 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006377 }
6378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006380 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006381#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6383 return PSA_ERROR_INVALID_ARGUMENT;
6384 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006385#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006386#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6388 hkdf->state == HKDF_STATE_INIT) {
6389 return PSA_ERROR_BAD_STATE;
6390 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006391#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 if (hkdf->state == HKDF_STATE_OUTPUT) {
6393 return PSA_ERROR_BAD_STATE;
6394 }
6395 if (hkdf->info_set) {
6396 return PSA_ERROR_BAD_STATE;
6397 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006398 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (data_length != 0) {
6400 hkdf->info = mbedtls_calloc(1, data_length);
6401 if (hkdf->info == NULL) {
6402 return PSA_ERROR_INSUFFICIENT_MEMORY;
6403 }
6404 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006405 }
6406 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006408 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006410 }
6411}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006412#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006413
John Durkop07cc04a2020-11-16 22:08:34 -08006414#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6415 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006416static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6417 const uint8_t *data,
6418 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006419{
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6421 return PSA_ERROR_BAD_STATE;
6422 }
Janos Follathf08e2652019-06-13 09:05:41 +01006423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 if (data_length != 0) {
6425 prf->seed = mbedtls_calloc(1, data_length);
6426 if (prf->seed == NULL) {
6427 return PSA_ERROR_INSUFFICIENT_MEMORY;
6428 }
Janos Follathf08e2652019-06-13 09:05:41 +01006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006431 prf->seed_length = data_length;
6432 }
Janos Follathf08e2652019-06-13 09:05:41 +01006433
Gilles Peskine43f958b2020-12-13 14:55:14 +01006434 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006437}
6438
Gilles Peskine449bd832023-01-11 14:50:10 +01006439static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6440 const uint8_t *data,
6441 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006442{
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6444 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6445 return PSA_ERROR_BAD_STATE;
6446 }
Janos Follath81550542019-06-13 14:26:34 +01006447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 if (data_length != 0) {
6449 prf->secret = mbedtls_calloc(1, data_length);
6450 if (prf->secret == NULL) {
6451 return PSA_ERROR_INSUFFICIENT_MEMORY;
6452 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006455 prf->secret_length = data_length;
6456 }
Janos Follath81550542019-06-13 14:26:34 +01006457
Gilles Peskine43f958b2020-12-13 14:55:14 +01006458 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006459
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006461}
6462
Gilles Peskine449bd832023-01-11 14:50:10 +01006463static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6464 const uint8_t *data,
6465 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006466{
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6468 return PSA_ERROR_BAD_STATE;
6469 }
Janos Follath63028dd2019-06-13 09:15:47 +01006470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 if (data_length != 0) {
6472 prf->label = mbedtls_calloc(1, data_length);
6473 if (prf->label == NULL) {
6474 return PSA_ERROR_INSUFFICIENT_MEMORY;
6475 }
Janos Follath63028dd2019-06-13 09:15:47 +01006476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006478 prf->label_length = data_length;
6479 }
Janos Follath63028dd2019-06-13 09:15:47 +01006480
Gilles Peskine43f958b2020-12-13 14:55:14 +01006481 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006484}
6485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6487 psa_key_derivation_step_t step,
6488 const uint8_t *data,
6489 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006490{
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006492 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006494 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006496 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006498 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006500 }
6501}
John Durkop07cc04a2020-11-16 22:08:34 -08006502#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6503 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6504
6505#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6506static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6507 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006508 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006510{
6511 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6513 4 + data_length + prf->other_secret_length :
6514 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006515
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6517 return PSA_ERROR_INVALID_ARGUMENT;
6518 }
John Durkop07cc04a2020-11-16 22:08:34 -08006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 uint8_t *pms = mbedtls_calloc(1, pms_len);
6521 if (pms == NULL) {
6522 return PSA_ERROR_INSUFFICIENT_MEMORY;
6523 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006524 uint8_t *cur = pms;
6525
6526 /* pure-PSK:
6527 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006528 *
6529 * The premaster secret is formed as follows: if the PSK is N octets
6530 * long, concatenate a uint16 with the value N, N zero octets, a second
6531 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006532 *
6533 * mixed-PSK:
6534 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6535 * follows: concatenate a uint16 with the length of the other secret,
6536 * the other secret itself, uint16 with the length of PSK, and the
6537 * PSK itself.
6538 * For details please check:
6539 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6540 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6541 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006542 */
6543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6545 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6546 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6547 if (prf->other_secret_length != 0) {
6548 memcpy(cur, prf->other_secret, prf->other_secret_length);
6549 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006550 cur += prf->other_secret_length;
6551 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 } else {
6553 *cur++ = MBEDTLS_BYTE_1(data_length);
6554 *cur++ = MBEDTLS_BYTE_0(data_length);
6555 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006556 cur += data_length;
6557 }
6558
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 *cur++ = MBEDTLS_BYTE_1(data_length);
6560 *cur++ = MBEDTLS_BYTE_0(data_length);
6561 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006562 cur += data_length;
6563
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08006565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 mbedtls_platform_zeroize(pms, pms_len);
6567 mbedtls_free(pms);
6568 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006569}
Janos Follath6660f0e2019-06-17 08:44:03 +01006570
Przemek Stekiele47201b2022-04-19 13:53:28 +02006571static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6572 psa_tls12_prf_key_derivation_t *prf,
6573 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006575{
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6577 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006578 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006579
6580 if (data_length != 0) {
6581 prf->other_secret = mbedtls_calloc(1, data_length);
6582 if (prf->other_secret == NULL) {
6583 return PSA_ERROR_INSUFFICIENT_MEMORY;
6584 }
6585
6586 memcpy(prf->other_secret, data, data_length);
6587 prf->other_secret_length = data_length;
6588 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006589 prf->other_secret_length = 0;
6590 }
6591
6592 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6593
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006595}
6596
Janos Follath6660f0e2019-06-17 08:44:03 +01006597static psa_status_t psa_tls12_prf_psk_to_ms_input(
6598 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006599 psa_key_derivation_step_t step,
6600 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006602{
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006604 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 return psa_tls12_prf_psk_to_ms_set_key(prf,
6606 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006607 break;
6608 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6610 data,
6611 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006612 break;
6613 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006615 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006616
Przemek Stekiele47201b2022-04-19 13:53:28 +02006617 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006618}
John Durkop07cc04a2020-11-16 22:08:34 -08006619#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006620
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006621#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6622static psa_status_t psa_tls12_ecjpake_to_pms_input(
6623 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006624 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006625 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006627{
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6629 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6630 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006631 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006632
6633 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 if (data[0] != 0x04) {
6635 return PSA_ERROR_INVALID_ARGUMENT;
6636 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006637
6638 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006640
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006642}
6643#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306644
6645#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6646static psa_status_t psa_pbkdf2_set_input_cost(
6647 psa_pbkdf2_key_derivation_t *pbkdf2,
6648 psa_key_derivation_step_t step,
6649 uint64_t data)
6650{
6651 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6652 return PSA_ERROR_INVALID_ARGUMENT;
6653 }
6654
6655 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6656 return PSA_ERROR_BAD_STATE;
6657 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306658
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306659 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306660 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306661 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306662
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306663 if (data == 0) {
6664 return PSA_ERROR_INVALID_ARGUMENT;
6665 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306666
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306667 pbkdf2->input_cost = data;
6668 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6669
6670 return PSA_SUCCESS;
6671}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306672
6673static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6674 const uint8_t *data,
6675 size_t data_length)
6676{
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306677 if (pbkdf2->state != PSA_PBKDF2_STATE_INPUT_COST_SET &&
6678 pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6679 return PSA_ERROR_BAD_STATE;
6680 }
6681
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306682 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6683 pbkdf2->salt = mbedtls_calloc(1, data_length);
6684 if (pbkdf2->salt == NULL) {
6685 return PSA_ERROR_INSUFFICIENT_MEMORY;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306686 }
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306687
6688 memcpy(pbkdf2->salt, data, data_length);
6689 pbkdf2->salt_length = data_length;
6690 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306691 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306692
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306693 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6694 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306695 return PSA_ERROR_INSUFFICIENT_MEMORY;
6696 }
6697
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306698 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6699 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306700 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306701 mbedtls_free(pbkdf2->salt);
6702 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306703 }
6704
6705 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6706
6707 return PSA_SUCCESS;
6708}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306709
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306710static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306711 const uint8_t *input,
6712 size_t input_len,
6713 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306714 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306715{
6716 psa_status_t status = PSA_SUCCESS;
6717 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6718 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306719 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306720 } else {
6721 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306722 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306723 }
6724 return status;
6725}
6726
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306727static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306728 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306729 const uint8_t *data,
6730 size_t data_length)
6731{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306732 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306733 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6734 return PSA_ERROR_BAD_STATE;
6735 }
6736
6737 if (data_length != 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306738 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6739 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6740 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6741 pbkdf2->password,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306742 &pbkdf2->password_length);
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306743 }
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306744 }
6745
6746 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6747
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306748 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306749}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306750
6751static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306752 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306753 psa_key_derivation_step_t step,
6754 const uint8_t *data,
6755 size_t data_length)
6756{
6757 switch (step) {
6758 case PSA_KEY_DERIVATION_INPUT_SALT:
6759 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6760 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306761 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306762 default:
6763 return PSA_ERROR_INVALID_ARGUMENT;
6764 }
6765}
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306766#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6767
Gilles Peskineb8965192019-09-24 16:21:10 +02006768/** Check whether the given key type is acceptable for the given
6769 * input step of a key derivation.
6770 *
6771 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6772 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6773 * Both secret and non-secret inputs can alternatively have the type
6774 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6775 * that the input was passed as a buffer rather than via a key object.
6776 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006777static int psa_key_derivation_check_input_type(
6778 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006780{
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006782 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 if (key_type == PSA_KEY_TYPE_DERIVE) {
6784 return PSA_SUCCESS;
6785 }
6786 if (key_type == PSA_KEY_TYPE_NONE) {
6787 return PSA_SUCCESS;
6788 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006789 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006790 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 if (key_type == PSA_KEY_TYPE_DERIVE) {
6792 return PSA_SUCCESS;
6793 }
6794 if (key_type == PSA_KEY_TYPE_NONE) {
6795 return PSA_SUCCESS;
6796 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006797 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006798 case PSA_KEY_DERIVATION_INPUT_LABEL:
6799 case PSA_KEY_DERIVATION_INPUT_SALT:
6800 case PSA_KEY_DERIVATION_INPUT_INFO:
6801 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6803 return PSA_SUCCESS;
6804 }
6805 if (key_type == PSA_KEY_TYPE_NONE) {
6806 return PSA_SUCCESS;
6807 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006808 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306809 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6810 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6811 return PSA_SUCCESS;
6812 }
6813 if (key_type == PSA_KEY_TYPE_DERIVE) {
6814 return PSA_SUCCESS;
6815 }
6816 if (key_type == PSA_KEY_TYPE_NONE) {
6817 return PSA_SUCCESS;
6818 }
6819 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006820 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006822}
6823
Janos Follathb80a94e2019-06-12 15:54:46 +01006824static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006825 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006826 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006827 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006828 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006830{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006831 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006833
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 status = psa_key_derivation_check_input_type(step, key_type);
6835 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006836 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006838
Przemek Stekiel69c46792022-06-10 12:59:51 +02006839#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6841 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6842 step, data, data_length);
6843 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006844#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006845#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6847 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6848 step, data, data_length);
6849 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006850#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6851#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6853 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6854 step, data, data_length);
6855 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006856#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006857#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006859 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6861 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006862#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306863#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6864 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306865 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6866 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306867 } else
6868#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006869 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006870 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006871 (void) data;
6872 (void) data_length;
6873 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006875 }
6876
Gilles Peskine224b0d62019-09-23 18:13:17 +02006877exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 if (status != PSA_SUCCESS) {
6879 psa_key_derivation_abort(operation);
6880 }
6881 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006882}
6883
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306884static psa_status_t psa_key_derivation_input_integer_internal(
6885 psa_key_derivation_operation_t *operation,
6886 psa_key_derivation_step_t step,
6887 uint64_t value)
6888{
6889 psa_status_t status;
6890 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6891
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306892#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6893 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6894 status = psa_pbkdf2_set_input_cost(
6895 &operation->ctx.pbkdf2, step, value);
6896 } else
6897#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306898 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306899 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306900 (void) value;
6901 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306902 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306903 }
6904
6905 if (status != PSA_SUCCESS) {
6906 psa_key_derivation_abort(operation);
6907 }
6908 return status;
6909}
6910
Janos Follath51f4a0f2019-06-14 11:35:55 +01006911psa_status_t psa_key_derivation_input_bytes(
6912 psa_key_derivation_operation_t *operation,
6913 psa_key_derivation_step_t step,
6914 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006916{
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 return psa_key_derivation_input_internal(operation, step,
6918 PSA_KEY_TYPE_NONE,
6919 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006920}
6921
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306922psa_status_t psa_key_derivation_input_integer(
6923 psa_key_derivation_operation_t *operation,
6924 psa_key_derivation_step_t step,
6925 uint64_t value)
6926{
6927 return psa_key_derivation_input_integer_internal(operation, step, value);
6928}
6929
Janos Follath51f4a0f2019-06-14 11:35:55 +01006930psa_status_t psa_key_derivation_input_key(
6931 psa_key_derivation_operation_t *operation,
6932 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006934{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006935 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006936 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006937 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006938
Ronald Cron5c522922020-11-14 16:35:34 +01006939 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6941 if (status != PSA_SUCCESS) {
6942 psa_key_derivation_abort(operation);
6943 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006944 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006945
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306946 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6947 * permission to output to a key object. */
6948 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6949 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006950 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 status = psa_key_derivation_input_internal(operation,
6954 step, slot->attr.type,
6955 slot->key.data,
6956 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006957
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006961}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006962
6963
6964
6965/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006966/* Key agreement */
6967/****************************************************************/
6968
Gilles Peskine449bd832023-01-11 14:50:10 +01006969psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6970 const uint8_t *key_buffer,
6971 size_t key_buffer_size,
6972 psa_algorithm_t alg,
6973 const uint8_t *peer_key,
6974 size_t peer_key_length,
6975 uint8_t *shared_secret,
6976 size_t shared_secret_size,
6977 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006978{
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006980#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006981 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6983 key_buffer_size, alg,
6984 peer_key, peer_key_length,
6985 shared_secret,
6986 shared_secret_size,
6987 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006988#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006989
6990#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6991 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006992 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006993 peer_key,
6994 peer_key_length,
6995 key_buffer,
6996 key_buffer_size,
6997 shared_secret,
6998 shared_secret_size,
6999 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007000#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7001
Gilles Peskine01d718c2018-09-18 12:01:02 +02007002 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007003 (void) attributes;
7004 (void) key_buffer;
7005 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007006 (void) peer_key;
7007 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007008 (void) shared_secret;
7009 (void) shared_secret_size;
7010 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007012 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007013}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007014
Aditya Deshpande17845b82022-10-13 17:21:01 +01007015/** Internal function for raw key agreement
7016 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007017 * to the driver's implementation if a driver is present.
7018 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007019 * (psa_key_agreement_raw_builtin).
7020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007021static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7022 psa_key_slot_t *private_key,
7023 const uint8_t *peer_key,
7024 size_t peer_key_length,
7025 uint8_t *shared_secret,
7026 size_t shared_secret_size,
7027 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007028{
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7030 return PSA_ERROR_NOT_SUPPORTED;
7031 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007032
7033 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007035 };
7036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 return psa_driver_wrapper_key_agreement(&attributes,
7038 private_key->key.data,
7039 private_key->key.bytes, alg,
7040 peer_key, peer_key_length,
7041 shared_secret,
7042 shared_secret_size,
7043 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007044}
7045
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007046/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007047 * to potentially free embedded data structures and wipe confidential data.
7048 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007049static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7050 psa_key_derivation_step_t step,
7051 psa_key_slot_t *private_key,
7052 const uint8_t *peer_key,
7053 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007054{
7055 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007056 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007057 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007059
7060 /* Step 1: run the secret agreement algorithm to generate the shared
7061 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 status = psa_key_agreement_raw_internal(ka_alg,
7063 private_key,
7064 peer_key, peer_key_length,
7065 shared_secret,
7066 sizeof(shared_secret),
7067 &shared_secret_length);
7068 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007069 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007071
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007072 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007073 * the shared secret. A shared secret is permitted wherever a key
7074 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 status = psa_key_derivation_input_internal(operation, step,
7076 PSA_KEY_TYPE_DERIVE,
7077 shared_secret,
7078 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007079exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7081 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007082}
7083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7085 psa_key_derivation_step_t step,
7086 mbedtls_svc_key_id_t private_key,
7087 const uint8_t *peer_key,
7088 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007089{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007091 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007092 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7095 return PSA_ERROR_INVALID_ARGUMENT;
7096 }
Ronald Cron5c522922020-11-14 16:35:34 +01007097 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7099 if (status != PSA_SUCCESS) {
7100 return status;
7101 }
7102 status = psa_key_agreement_internal(operation, step,
7103 slot,
7104 peer_key, peer_key_length);
7105 if (status != PSA_SUCCESS) {
7106 psa_key_derivation_abort(operation);
7107 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007108 /* If a private key has been added as SECRET, we allow the derived
7109 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007111 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007113 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007114
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007118}
7119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7121 mbedtls_svc_key_id_t private_key,
7122 const uint8_t *peer_key,
7123 size_t peer_key_length,
7124 uint8_t *output,
7125 size_t output_size,
7126 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007127{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007128 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007129 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007130 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007131 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007134 status = PSA_ERROR_INVALID_ARGUMENT;
7135 goto exit;
7136 }
Ronald Cron5c522922020-11-14 16:35:34 +01007137 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7139 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007140 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007142
Gilles Peskine3e561302022-04-14 00:17:15 +02007143 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7144 * for the output size. The PSA specification only guarantees that this
7145 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7146 * but it might be nice to allow smaller buffers if the output fits.
7147 * At the time of writing this comment, with only ECDH implemented,
7148 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7149 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7150 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007151 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7153 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007154 status = PSA_ERROR_BUFFER_TOO_SMALL;
7155 goto exit;
7156 }
7157
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 status = psa_key_agreement_raw_internal(alg, slot,
7159 peer_key, peer_key_length,
7160 output, output_size,
7161 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007162
7163exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007165 /* If an error happens and is not handled properly, the output
7166 * may be used as a key to protect sensitive data. Arrange for such
7167 * a key to be random, which is likely to result in decryption or
7168 * verification errors. This is better than filling the buffer with
7169 * some constant data such as zeros, which would result in the data
7170 * being protected with a reproducible, easily knowable key.
7171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007173 *output_length = output_size;
7174 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007175
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007177
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007179}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007180
7181
Gilles Peskine30524eb2020-11-13 17:02:26 +01007182
Gilles Peskine86a440b2018-11-12 18:39:40 +01007183/****************************************************************/
7184/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007185/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007186
Gilles Peskine30524eb2020-11-13 17:02:26 +01007187/** Initialize the PSA random generator.
7188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007189static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007190{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007191#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007193#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7194
Gilles Peskine30524eb2020-11-13 17:02:26 +01007195 /* Set default configuration if
7196 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007198 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 }
7200 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007201 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007205#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7206 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7207 /* The PSA entropy injection feature depends on using NV seed as an entropy
7208 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 mbedtls_entropy_add_source(&rng->entropy,
7210 mbedtls_nv_seed_poll, NULL,
7211 MBEDTLS_ENTROPY_BLOCK_SIZE,
7212 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007213#endif
7214
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007216#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007217}
7218
7219/** Deinitialize the PSA random generator.
7220 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007221static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007222{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007223#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007225#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7227 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007228#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007229}
7230
7231/** Seed the PSA random generator.
7232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007233static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007234{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007235#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7236 /* Do nothing: the external RNG seeds itself. */
7237 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007239#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007240 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7242 drbg_seed, sizeof(drbg_seed) - 1);
7243 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007244#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007245}
7246
Gilles Peskine449bd832023-01-11 14:50:10 +01007247psa_status_t psa_generate_random(uint8_t *output,
7248 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007249{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007250 GUARD_MODULE_INITIALIZED;
7251
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007252#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7253
7254 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7256 output, output_size,
7257 &output_length);
7258 if (status != PSA_SUCCESS) {
7259 return status;
7260 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007261 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007262 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 if (output_length != output_size) {
7264 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7265 }
7266 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007267
7268#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7269
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007271 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7273 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7274 output_size);
7275 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7276 output, request_size);
7277 if (ret != 0) {
7278 return mbedtls_to_psa_error(ret);
7279 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007280 output_size -= request_size;
7281 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007282 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007284#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007285}
7286
Gilles Peskine8814fc42020-12-14 15:33:44 +01007287/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007288 *
7289 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7290 * `psa_generate_random(...)`. The state parameter is ignored since the
7291 * PSA API doesn't support passing an explicit state.
7292 *
7293 * In the non-external case, psa_generate_random() calls an
7294 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7295 * and semantics as mbedtls_psa_get_random(). As an optimization,
7296 * instead of doing this back-and-forth between the PSA API and the
7297 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7298 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007300#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7301int mbedtls_psa_get_random(void *p_rng,
7302 unsigned char *output,
7303 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007304{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007305 /* This function takes a pointer to the RNG state because that's what
7306 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7307 * its own state internally and doesn't let the caller access that state.
7308 * So we just ignore the state parameter, and in practice we'll pass
7309 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007310 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 psa_status_t status = psa_generate_random(output, output_size);
7312 if (status == PSA_SUCCESS) {
7313 return 0;
7314 } else {
7315 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7316 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007317}
7318#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7319
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007320#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00007321#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007322
Gilles Peskine449bd832023-01-11 14:50:10 +01007323psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7324 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007325{
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 if (global_data.initialized) {
7327 return PSA_ERROR_NOT_PERMITTED;
7328 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007329
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7331 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7332 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7333 return PSA_ERROR_INVALID_ARGUMENT;
7334 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007335
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007337}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007338#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007339
Ronald Cron3772afe2021-02-08 16:10:05 +01007340/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007341 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007342 * \param type The key type
7343 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007344 *
7345 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007346 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007347 * \retval #PSA_ERROR_INVALID_ARGUMENT
7348 * The size in bits of the key is not valid.
7349 * \retval #PSA_ERROR_NOT_SUPPORTED
7350 * The type and/or the size in bits of the key or the combination of
7351 * the two is not supported.
7352 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007353static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007355{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007356 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007357
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 if (key_type_is_raw_bytes(type)) {
7359 status = psa_validate_unstructured_key_bit_size(type, bits);
7360 if (status != PSA_SUCCESS) {
7361 return status;
7362 }
7363 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007364#if defined(MBEDTLS_PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_LEGACY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7366 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7367 return PSA_ERROR_NOT_SUPPORTED;
7368 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007369
Ronald Cron01b2aba2020-10-05 09:42:02 +02007370 /* Accept only byte-aligned keys, for the same reasons as
7371 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 if (bits % 8 != 0) {
7373 return PSA_ERROR_NOT_SUPPORTED;
7374 }
7375 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007376#endif /* defined(MBEDTLS_PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_LEGACY) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007377
Valerio Setti8bb57632023-05-26 13:48:07 +02007378#if defined(MBEDTLS_PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_LEGACY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007380 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 return PSA_SUCCESS;
7382 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007383#endif /* defined(MBEDTLS_PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_LEGACY) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007384
Valerio Setti8bb57632023-05-26 13:48:07 +02007385#if defined(MBEDTLS_PSA_WANT_KEY_TYPE_DH_KEY_PAIR_LEGACY)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007386 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007387 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007388 return PSA_ERROR_NOT_SUPPORTED;
7389 }
7390 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007391#endif /* defined(MBEDTLS_PSA_WANT_KEY_TYPE_DH_KEY_PAIR_LEGACY) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007392 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007394 }
7395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007397}
7398
Ronald Cron55ed0592020-10-05 10:30:40 +02007399psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007400 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007402{
7403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007404 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007405
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if ((attributes->domain_parameters == NULL) &&
7407 (attributes->domain_parameters_size != 0)) {
7408 return PSA_ERROR_INVALID_ARGUMENT;
7409 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 if (key_type_is_raw_bytes(type)) {
7412 status = psa_generate_random(key_buffer, key_buffer_size);
7413 if (status != PSA_SUCCESS) {
7414 return status;
7415 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007416
David Brown12ca5032021-02-11 11:02:00 -07007417#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (type == PSA_KEY_TYPE_DES) {
7419 psa_des_set_key_parity(key_buffer, key_buffer_size);
7420 }
David Brown8107e312021-02-12 08:08:46 -07007421#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007423
Valerio Setti8bb57632023-05-26 13:48:07 +02007424#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY) && \
Jaeden Amero424fa932021-05-14 08:34:32 +01007425 defined(MBEDTLS_GENPRIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7427 return mbedtls_psa_rsa_generate_key(attributes,
7428 key_buffer,
7429 key_buffer_size,
7430 key_buffer_length);
7431 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007432#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_LEGACY)
Jaeden Amero424fa932021-05-14 08:34:32 +01007433 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007434
Valerio Setti8bb57632023-05-26 13:48:07 +02007435#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_LEGACY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7437 return mbedtls_psa_ecp_generate_key(attributes,
7438 key_buffer,
7439 key_buffer_size,
7440 key_buffer_length);
7441 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007442#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_LEGACY) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007443
Valerio Setti8bb57632023-05-26 13:48:07 +02007444#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007445 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7446 return mbedtls_psa_ffdh_generate_key(attributes,
7447 key_buffer,
7448 key_buffer_size,
7449 key_buffer_length);
7450 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007451#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) */
Steven Cooreman29149862020-08-05 15:43:42 +02007452 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 (void) key_buffer_length;
7454 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007455 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007456
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007458}
Darryl Green0c6575a2018-11-07 16:05:30 +00007459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7461 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007462{
7463 psa_status_t status;
7464 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007465 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007466 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007467
Ronald Cron81709fc2020-11-14 12:10:32 +01007468 *key = MBEDTLS_SVC_KEY_ID_INIT;
7469
Gilles Peskine0f84d622019-09-12 19:03:13 +02007470 /* Reject any attempt to create a zero-length key so that we don't
7471 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 if (psa_get_key_bits(attributes) == 0) {
7473 return PSA_ERROR_INVALID_ARGUMENT;
7474 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007475
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007476 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7478 return PSA_ERROR_INVALID_ARGUMENT;
7479 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7482 &slot, &driver);
7483 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007484 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 }
Gilles Peskine11792082019-08-06 18:36:36 +02007486
Ronald Cron977c2472020-10-13 08:32:21 +02007487 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307488 * storage ( thus not in the case of generating a key in a secure element
7489 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7490 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 if (slot->key.data == NULL) {
7492 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7493 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007494 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 attributes->core.type, attributes->core.bits);
7496 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007497 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007499
7500 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 attributes->core.type,
7502 attributes->core.bits);
7503 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007504 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 attributes, &key_buffer_size);
7506 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007507 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 }
Ronald Cron977c2472020-10-13 08:32:21 +02007509 }
Ronald Cron977c2472020-10-13 08:32:21 +02007510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7512 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007513 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 }
Ronald Cron977c2472020-10-13 08:32:21 +02007515 }
7516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 status = psa_driver_wrapper_generate_key(attributes,
7518 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 if (status != PSA_SUCCESS) {
7521 psa_remove_key_data_from_memory(slot);
7522 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007523
Gilles Peskine11792082019-08-06 18:36:36 +02007524exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 if (status == PSA_SUCCESS) {
7526 status = psa_finish_key_creation(slot, driver, key);
7527 }
7528 if (status != PSA_SUCCESS) {
7529 psa_fail_key_creation(slot, driver);
7530 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007531
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007533}
7534
Gilles Peskinee59236f2018-01-27 23:32:46 +01007535/****************************************************************/
7536/* Module setup */
7537/****************************************************************/
7538
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007539#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007540psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 void (* entropy_init)(mbedtls_entropy_context *ctx),
7542 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007543{
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7545 return PSA_ERROR_BAD_STATE;
7546 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007547 global_data.rng.entropy_init = entropy_init;
7548 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007550}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007551#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007554{
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 psa_wipe_all_key_slots();
7556 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7557 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007558 }
7559 /* Wipe all remaining data, including configuration.
7560 * In particular, this sets all state indicator to the value
7561 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007563
7564 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007566}
7567
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007568#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7569/** Recover a transaction that was interrupted by a power failure.
7570 *
7571 * This function is called during initialization, before psa_crypto_init()
7572 * returns. If this function returns a failure status, the initialization
7573 * fails.
7574 */
7575static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007577{
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007579 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7580 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 /* TODO - fall through to the failure case until this
7582 * is implemented.
7583 * https://github.com/ARMmbed/mbed-crypto/issues/218
7584 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007585 default:
7586 /* We found an unsupported transaction in the storage.
7587 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007589 }
7590}
7591#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007594{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007595 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007596
Gilles Peskinec6b69072018-11-20 21:42:52 +01007597 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 if (global_data.initialized != 0) {
7599 return PSA_SUCCESS;
7600 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007601
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007602 /* Init drivers */
7603 status = psa_driver_wrapper_init();
7604 if (status != PSA_SUCCESS) {
7605 goto exit;
7606 }
7607 global_data.drivers_initialized = 1;
7608
Gilles Peskine30524eb2020-11-13 17:02:26 +01007609 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007611 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 status = mbedtls_psa_random_seed(&global_data.rng);
7613 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007614 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007616 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 status = psa_initialize_key_slots();
7619 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007620 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007622
Gilles Peskine4b734222019-07-24 15:56:31 +02007623#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 status = psa_crypto_load_transaction();
7625 if (status == PSA_SUCCESS) {
7626 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7627 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007628 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 }
7630 status = psa_crypto_stop_transaction();
7631 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007632 /* There's no transaction to complete. It's all good. */
7633 status = PSA_SUCCESS;
7634 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007635#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007636
Gilles Peskinec6b69072018-11-20 21:42:52 +01007637 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007638 global_data.initialized = 1;
7639
7640exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 if (status != PSA_SUCCESS) {
7642 mbedtls_psa_crypto_free();
7643 }
7644 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007645}
7646
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007647psa_status_t psa_crypto_driver_pake_get_password_len(
7648 const psa_crypto_driver_pake_inputs_t *inputs,
7649 size_t *password_len)
7650{
7651 if (inputs->password_len == 0) {
7652 return PSA_ERROR_BAD_STATE;
7653 }
7654
7655 *password_len = inputs->password_len;
7656
7657 return PSA_SUCCESS;
7658}
7659
7660psa_status_t psa_crypto_driver_pake_get_password(
7661 const psa_crypto_driver_pake_inputs_t *inputs,
7662 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7663{
7664 if (inputs->password_len == 0) {
7665 return PSA_ERROR_BAD_STATE;
7666 }
7667
7668 if (buffer_size < inputs->password_len) {
7669 return PSA_ERROR_BUFFER_TOO_SMALL;
7670 }
7671
7672 memcpy(buffer, inputs->password, inputs->password_len);
7673 *buffer_length = inputs->password_len;
7674
7675 return PSA_SUCCESS;
7676}
7677
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007678psa_status_t psa_crypto_driver_pake_get_user_len(
7679 const psa_crypto_driver_pake_inputs_t *inputs,
7680 size_t *user_len)
7681{
7682 if (inputs->user_len == 0) {
7683 return PSA_ERROR_BAD_STATE;
7684 }
7685
7686 *user_len = inputs->user_len;
7687
7688 return PSA_SUCCESS;
7689}
7690
7691psa_status_t psa_crypto_driver_pake_get_user(
7692 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007693 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007694{
7695 if (inputs->user_len == 0) {
7696 return PSA_ERROR_BAD_STATE;
7697 }
7698
Przemek Stekielc0e62502023-03-14 11:49:36 +01007699 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007700 return PSA_ERROR_BUFFER_TOO_SMALL;
7701 }
7702
Przemek Stekielc0e62502023-03-14 11:49:36 +01007703 memcpy(user_id, inputs->user, inputs->user_len);
7704 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007705
7706 return PSA_SUCCESS;
7707}
7708
7709psa_status_t psa_crypto_driver_pake_get_peer_len(
7710 const psa_crypto_driver_pake_inputs_t *inputs,
7711 size_t *peer_len)
7712{
7713 if (inputs->peer_len == 0) {
7714 return PSA_ERROR_BAD_STATE;
7715 }
7716
7717 *peer_len = inputs->peer_len;
7718
7719 return PSA_SUCCESS;
7720}
7721
7722psa_status_t psa_crypto_driver_pake_get_peer(
7723 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007724 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007725{
7726 if (inputs->peer_len == 0) {
7727 return PSA_ERROR_BAD_STATE;
7728 }
7729
Przemek Stekielc0e62502023-03-14 11:49:36 +01007730 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007731 return PSA_ERROR_BUFFER_TOO_SMALL;
7732 }
7733
Przemek Stekielc0e62502023-03-14 11:49:36 +01007734 memcpy(peer_id, inputs->peer, inputs->peer_len);
7735 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007736
7737 return PSA_SUCCESS;
7738}
7739
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007740psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7741 const psa_crypto_driver_pake_inputs_t *inputs,
7742 psa_pake_cipher_suite_t *cipher_suite)
7743{
7744 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7745 return PSA_ERROR_BAD_STATE;
7746 }
7747
7748 *cipher_suite = inputs->cipher_suite;
7749
7750 return PSA_SUCCESS;
7751}
7752
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01007753#if defined(PSA_WANT_ALG_SOME_PAKE)
Neil Armstronga7d08c32022-06-01 18:21:20 +02007754psa_status_t psa_pake_setup(
7755 psa_pake_operation_t *operation,
7756 const psa_pake_cipher_suite_t *cipher_suite)
7757{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007758 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007759
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007760 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007761 status = PSA_ERROR_BAD_STATE;
7762 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007763 }
7764
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007765 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007766 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007767 status = PSA_ERROR_INVALID_ARGUMENT;
7768 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007769 }
7770
Przemek Stekiel51eac532022-12-07 11:04:51 +01007771 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7772
Przemek Stekiele12ed362022-12-21 12:54:46 +01007773 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007774 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7775 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007776 operation->data.inputs.cipher_suite = *cipher_suite;
7777
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007778#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007779 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007780 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007781 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007782
David Horstmann16f01512023-06-14 17:21:07 +01007783 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007784 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007785 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007786#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007787 {
7788 status = PSA_ERROR_NOT_SUPPORTED;
7789 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007790 }
7791
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007792 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7793
Przemek Stekiel51eac532022-12-07 11:04:51 +01007794 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007795exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007796 psa_pake_abort(operation);
7797 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007798}
7799
7800psa_status_t psa_pake_set_password_key(
7801 psa_pake_operation_t *operation,
7802 mbedtls_svc_key_id_t password)
7803{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007805 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7806 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007807 psa_key_attributes_t attributes;
7808 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007809
Przemek Stekiel51eac532022-12-07 11:04:51 +01007810 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007811 status = PSA_ERROR_BAD_STATE;
7812 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007813 }
7814
Przemek Stekiel6c764412022-11-22 14:05:12 +01007815 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7816 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007817 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007818 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007819 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007820 }
7821
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007822 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007823 .core = slot->attr
7824 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007825
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007826 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007827
Przemek Stekiel51eac532022-12-07 11:04:51 +01007828 if (type != PSA_KEY_TYPE_PASSWORD &&
7829 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7830 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007831 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007832 }
7833
Przemek Stekiel51eac532022-12-07 11:04:51 +01007834 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7835 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007836 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007837 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007838 }
7839
7840 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7841 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007842 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007843exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007844 if (status != PSA_SUCCESS) {
7845 psa_pake_abort(operation);
7846 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007847 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007848 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007849}
7850
7851psa_status_t psa_pake_set_user(
7852 psa_pake_operation_t *operation,
7853 const uint8_t *user_id,
7854 size_t user_id_len)
7855{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007856 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007857
7858 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007859 status = PSA_ERROR_BAD_STATE;
7860 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007861 }
7862
Przemek Stekiel51eac532022-12-07 11:04:51 +01007863 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007864 status = PSA_ERROR_INVALID_ARGUMENT;
7865 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007866 }
7867
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007868 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007869 status = PSA_ERROR_BAD_STATE;
7870 goto exit;
7871 }
7872
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007873 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7874 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007875 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7876 goto exit;
7877 }
7878
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007879 memcpy(operation->data.inputs.user, user_id, user_id_len);
7880 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007881
7882 return PSA_SUCCESS;
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
7888psa_status_t psa_pake_set_peer(
7889 psa_pake_operation_t *operation,
7890 const uint8_t *peer_id,
7891 size_t peer_id_len)
7892{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007894
7895 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007896 status = PSA_ERROR_BAD_STATE;
7897 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007898 }
7899
Przemek Stekiel51eac532022-12-07 11:04:51 +01007900 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007901 status = PSA_ERROR_INVALID_ARGUMENT;
7902 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007903 }
7904
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007905 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007906 status = PSA_ERROR_BAD_STATE;
7907 goto exit;
7908 }
7909
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007910 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7911 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007912 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7913 goto exit;
7914 }
7915
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007916 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7917 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007918
7919 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007920exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007921 psa_pake_abort(operation);
7922 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007923}
7924
7925psa_status_t psa_pake_set_role(
7926 psa_pake_operation_t *operation,
7927 psa_pake_role_t role)
7928{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007929 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007930
Przemek Stekiel51eac532022-12-07 11:04:51 +01007931 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007932 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007933 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007934 }
7935
Przemek Stekiel09104b82023-03-06 14:11:51 +01007936 switch (operation->alg) {
7937#if defined(PSA_WANT_ALG_JPAKE)
7938 case PSA_ALG_JPAKE:
7939 if (role == PSA_PAKE_ROLE_NONE) {
7940 return PSA_SUCCESS;
7941 }
7942 status = PSA_ERROR_INVALID_ARGUMENT;
7943 break;
7944#endif
7945 default:
7946 (void) role;
7947 status = PSA_ERROR_NOT_SUPPORTED;
7948 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007949 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007950exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007951 psa_pake_abort(operation);
7952 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007953}
7954
David Horstmanne7f21e62023-05-12 18:17:21 +01007955/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007956#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007957static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007958 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007959{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007960 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007961 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007962 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007963
David Horstmann024e5c52023-06-14 15:48:21 +01007964 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007965 is_x1 = (stage->outputs < 1);
7966 } else {
7967 is_x1 = (stage->inputs < 1);
7968 }
7969
David Horstmann74a3d8c2023-06-14 18:28:19 +01007970 key_share_step = is_x1 ?
7971 PSA_JPAKE_X1_STEP_KEY_SHARE :
7972 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007973 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007974 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7975 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7976 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7977 } else {
7978 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007979 }
David Horstmann74a3d8c2023-06-14 18:28:19 +01007980 return key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007981}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007982#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007983
Przemek Stekiel2797d372022-12-22 11:19:22 +01007984static psa_status_t psa_pake_complete_inputs(
7985 psa_pake_operation_t *operation)
7986{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007987 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007988 /* Create copy of the inputs on stack as inputs share memory
7989 with the driver context which will be setup by the driver. */
7990 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007991
Przemek Stekielfde11282023-03-13 16:06:09 +01007992 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007993 return PSA_ERROR_BAD_STATE;
7994 }
7995
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007996 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007997 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7998 return PSA_ERROR_BAD_STATE;
7999 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008000 }
8001
Przemek Stekiel18620a32023-01-17 16:34:52 +01008002 /* Clear driver context */
8003 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8004
8005 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008006
8007 /* Driver is responsible for creating its own copy of the password. */
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008008 mbedtls_platform_zeroize(inputs.password, inputs.password_len);
8009 mbedtls_free(inputs.password);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008010
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008011 /* User and peer are translated to role. */
8012 mbedtls_free(inputs.user);
8013 mbedtls_free(inputs.peer);
8014
Przemek Stekiel2797d372022-12-22 11:19:22 +01008015 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008016#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008017 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008018 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008019 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008020#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008021 {
8022 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008023 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008024 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008025 return status;
8026}
8027
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008028#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008029static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008030 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008031 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008032 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008033{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008034 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8035 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8036 step != PSA_PAKE_STEP_ZK_PROOF) {
8037 return PSA_ERROR_INVALID_ARGUMENT;
8038 }
8039
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008040 psa_jpake_computation_stage_t *computation_stage =
8041 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008042
David Horstmann5da95602023-06-08 15:37:12 +01008043 if (computation_stage->round != PSA_JPAKE_FIRST &&
8044 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008045 return PSA_ERROR_BAD_STATE;
8046 }
8047
David Horstmanne7f21e62023-05-12 18:17:21 +01008048 /* Check that the step we are given is the one we were expecting */
8049 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008050 return PSA_ERROR_BAD_STATE;
8051 }
8052
David Horstmanne7f21e62023-05-12 18:17:21 +01008053 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8054 computation_stage->inputs == 0 &&
8055 computation_stage->outputs == 0) {
8056 /* Start of the round, so function decides whether we are inputting
8057 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008058 computation_stage->io_mode = io_mode;
8059 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008060 /* Middle of the round so the mode we are in must match the function
8061 * called by the user */
8062 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008063 }
8064
8065 return PSA_SUCCESS;
8066}
8067
David Horstmanne7f21e62023-05-12 18:17:21 +01008068static psa_status_t psa_jpake_epilogue(
8069 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008070 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008071{
David Horstmanne7f21e62023-05-12 18:17:21 +01008072 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008073 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008074
David Horstmanne7f21e62023-05-12 18:17:21 +01008075 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8076 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008077 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008078 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008079 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008080 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008081 }
8082 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008083 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008084 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008085 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008086 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008087 }
8088 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008089 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8090 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008091 /* End of a round, move to the next round */
8092 stage->inputs = 0;
8093 stage->outputs = 0;
8094 stage->round++;
8095 }
8096 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008097 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008098 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008099 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008100 return PSA_SUCCESS;
8101}
David Horstmanne7f21e62023-05-12 18:17:21 +01008102
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008103#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008104
Neil Armstronga7d08c32022-06-01 18:21:20 +02008105psa_status_t psa_pake_output(
8106 psa_pake_operation_t *operation,
8107 psa_pake_step_t step,
8108 uint8_t *output,
8109 size_t output_size,
8110 size_t *output_length)
8111{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008112 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008113 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008114 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008115
8116 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008117 status = psa_pake_complete_inputs(operation);
8118 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008119 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008120 }
8121 }
8122
8123 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008124 status = PSA_ERROR_BAD_STATE;
8125 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008126 }
8127
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008128 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008129 status = PSA_ERROR_INVALID_ARGUMENT;
8130 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008131 }
8132
Przemek Stekiele12ed362022-12-21 12:54:46 +01008133 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008134#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008135 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008136 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008137 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008138 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008139 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008140 driver_step = convert_jpake_computation_stage_to_driver_step(
8141 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008142 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008143#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008144 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008145 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008146 status = PSA_ERROR_NOT_SUPPORTED;
8147 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008148 }
8149
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008150 status = psa_driver_wrapper_pake_output(operation, driver_step,
8151 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008152
8153 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008154 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008155 }
8156
8157 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008158#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008159 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008160 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008161 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008162 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008163 }
8164 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008165#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008166 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008167 status = PSA_ERROR_NOT_SUPPORTED;
8168 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008169 }
8170
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008171 return PSA_SUCCESS;
8172exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008173 psa_pake_abort(operation);
8174 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008175}
8176
8177psa_status_t psa_pake_input(
8178 psa_pake_operation_t *operation,
8179 psa_pake_step_t step,
8180 const uint8_t *input,
8181 size_t input_length)
8182{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008184 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008185 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8186 operation->primitive,
8187 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008188
8189 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008190 status = psa_pake_complete_inputs(operation);
8191 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008192 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008193 }
8194 }
8195
8196 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008197 status = PSA_ERROR_BAD_STATE;
8198 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008199 }
8200
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008201 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008202 status = PSA_ERROR_INVALID_ARGUMENT;
8203 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008204 }
8205
Przemek Stekiele12ed362022-12-21 12:54:46 +01008206 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008207#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008208 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008209 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008210 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008211 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008212 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008213 driver_step = convert_jpake_computation_stage_to_driver_step(
8214 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008216#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008217 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008218 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008219 status = PSA_ERROR_NOT_SUPPORTED;
8220 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008221 }
8222
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008223 status = psa_driver_wrapper_pake_input(operation, driver_step,
8224 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008225
8226 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008227 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008228 }
8229
8230 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008231#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008232 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008233 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008234 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008235 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008236 }
8237 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008238#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008239 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008240 status = PSA_ERROR_NOT_SUPPORTED;
8241 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008242 }
8243
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008244 return PSA_SUCCESS;
8245exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008246 psa_pake_abort(operation);
8247 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008248}
8249
8250psa_status_t psa_pake_get_implicit_key(
8251 psa_pake_operation_t *operation,
8252 psa_key_derivation_operation_t *output)
8253{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008255 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008256 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008257 size_t shared_key_len = 0;
8258
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008259 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008260 status = PSA_ERROR_BAD_STATE;
8261 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008262 }
8263
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008264#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008265 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008266 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008267 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008268 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008269 status = PSA_ERROR_BAD_STATE;
8270 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008271 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008272 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008273#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008274 {
8275 status = PSA_ERROR_NOT_SUPPORTED;
8276 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008277 }
8278
Przemek Stekiel0c781802022-11-29 14:53:13 +01008279 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8280 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008281 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008282 &shared_key_len);
8283
8284 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008285 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008286 }
8287
8288 status = psa_key_derivation_input_bytes(output,
8289 PSA_KEY_DERIVATION_INPUT_SECRET,
8290 shared_key,
8291 shared_key_len);
8292
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008293 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008294exit:
8295 abort_status = psa_pake_abort(operation);
8296 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008297}
8298
8299psa_status_t psa_pake_abort(
8300 psa_pake_operation_t *operation)
8301{
Przemek Stekield69dca92023-01-31 19:59:20 +01008302 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008303
Przemek Stekield69dca92023-01-31 19:59:20 +01008304 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008305 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008306 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008307
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008308 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8309 if (operation->data.inputs.password != NULL) {
8310 mbedtls_platform_zeroize(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008311 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008312 mbedtls_free(operation->data.inputs.password);
8313 }
8314 if (operation->data.inputs.user != NULL) {
8315 mbedtls_free(operation->data.inputs.user);
8316 }
8317 if (operation->data.inputs.peer != NULL) {
8318 mbedtls_free(operation->data.inputs.peer);
8319 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008320 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008321 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008322
Przemek Stekield69dca92023-01-31 19:59:20 +01008323 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008324}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008325#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008326
Gilles Peskinee59236f2018-01-27 23:32:46 +01008327#endif /* MBEDTLS_PSA_CRYPTO_C */