blob: bfb368588d44f116797360997b3c32699198750e [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 Setti27c501a2023-06-27 16:58:52 +0200704#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
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 Setti27c501a2023-06-27 16:58:52 +0200713#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800714 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settib2bcedb2023-07-10 11:24:00 +0200715#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) || \
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 Settib2bcedb2023-07-10 11:24:00 +0200724#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) ||
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 Settib2bcedb2023-07-10 11:24:00 +02001252#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
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 Settib2bcedb2023-07-10 11:24:00 +02001294#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
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 Settib2bcedb2023-07-10 11:24:00 +02001325#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1326 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001327 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001328 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001329 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001330 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001331 * is not yet implemented.
1332 * https://github.com/ARMmbed/mbed-crypto/issues/216
1333 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001335 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001336
Ronald Cron90857082020-11-25 14:58:33 +01001337 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 slot->attr.type,
1339 slot->key.data,
1340 slot->key.bytes,
1341 &rsa);
1342 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001343 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001345
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 status = psa_get_rsa_public_exponent(rsa,
1347 attributes);
1348 mbedtls_rsa_free(rsa);
1349 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001350 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001351 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001352#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1353 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001354 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001355 default:
1356 /* Nothing else to do. */
1357 break;
1358 }
1359
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 if (status != PSA_SUCCESS) {
1361 psa_reset_key_attributes(attributes);
1362 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001365
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001367}
1368
Gilles Peskinec8000c02019-08-02 20:15:51 +02001369#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1370psa_status_t psa_get_key_slot_number(
1371 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001373{
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001375 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 return PSA_SUCCESS;
1377 } else {
1378 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001379 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001380}
1381#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1382
Gilles Peskine449bd832023-01-11 14:50:10 +01001383static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1384 size_t key_buffer_size,
1385 uint8_t *data,
1386 size_t data_size,
1387 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001388{
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 if (key_buffer_size > data_size) {
1390 return PSA_ERROR_BUFFER_TOO_SMALL;
1391 }
1392 memcpy(data, key_buffer, key_buffer_size);
1393 memset(data + key_buffer_size, 0,
1394 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001395 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001397}
1398
Ronald Cron7285cda2020-11-26 14:46:37 +01001399psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001400 const psa_key_attributes_t *attributes,
1401 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001403{
Ronald Crond18b5f82020-11-25 16:46:05 +01001404 psa_key_type_t type = attributes->core.type;
1405
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 if (key_type_is_raw_bytes(type) ||
1407 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001408 PSA_KEY_TYPE_IS_ECC(type) ||
1409 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 return psa_export_key_buffer_internal(
1411 key_buffer, key_buffer_size,
1412 data, data_size, data_length);
1413 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001414 /* This shouldn't happen in the reference implementation, but
1415 it is valid for a special-purpose implementation to omit
1416 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001418 }
1419}
1420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1422 uint8_t *data,
1423 size_t data_size,
1424 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001425{
1426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1427 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1428 psa_key_slot_t *slot;
1429
Ronald Crone907e552021-01-18 13:22:38 +01001430 /* Reject a zero-length output buffer now, since this can never be a
1431 * valid key representation. This way we know that data must be a valid
1432 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 if (data_size == 0) {
1434 return PSA_ERROR_BUFFER_TOO_SMALL;
1435 }
Ronald Crone907e552021-01-18 13:22:38 +01001436
Ronald Cron9486f9d2020-11-26 13:36:23 +01001437 /* Set the key to empty now, so that even when there are errors, we always
1438 * set data_length to a value between 0 and data_size. On error, setting
1439 * the key to empty is a good choice because an empty key representation is
1440 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001441 *data_length = 0;
1442
Ronald Cron9486f9d2020-11-26 13:36:23 +01001443 /* Export requires the EXPORT flag. There is an exception for public keys,
1444 * which don't require any flag, but
1445 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1446 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1448 PSA_KEY_USAGE_EXPORT, 0);
1449 if (status != PSA_SUCCESS) {
1450 return status;
1451 }
mohammad160306e79202018-03-28 13:17:44 +03001452
Ronald Crond18b5f82020-11-25 16:46:05 +01001453 psa_key_attributes_t attributes = {
1454 .core = slot->attr
1455 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 status = psa_driver_wrapper_export_key(&attributes,
1457 slot->key.data, slot->key.bytes,
1458 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001459
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001461
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001463}
1464
Ronald Cron7285cda2020-11-26 14:46:37 +01001465psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001466 const psa_key_attributes_t *attributes,
1467 const uint8_t *key_buffer,
1468 size_t key_buffer_size,
1469 uint8_t *data,
1470 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001472{
Ronald Crond18b5f82020-11-25 16:46:05 +01001473 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001474
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001475 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001476 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1477 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001478 /* Exporting public -> public */
1479 return psa_export_key_buffer_internal(
1480 key_buffer, key_buffer_size,
1481 data, data_size, data_length);
1482 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001483#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001484 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1485 return mbedtls_psa_rsa_export_public_key(attributes,
1486 key_buffer,
1487 key_buffer_size,
1488 data,
1489 data_size,
1490 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001491#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001492 /* We don't know how to convert a private RSA key to public. */
1493 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001494#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001495 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001496 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001497#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001498 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1499 return mbedtls_psa_ecp_export_public_key(attributes,
1500 key_buffer,
1501 key_buffer_size,
1502 data,
1503 data_size,
1504 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001505#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001506 /* We don't know how to convert a private ECC key to public */
1507 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001508#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001509 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001510 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Setti8bb57632023-05-26 13:48:07 +02001511#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001512 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001513 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001514 key_buffer,
1515 key_buffer_size,
1516 data, data_size,
1517 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001518#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001519 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti8bb57632023-05-26 13:48:07 +02001520#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001521 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001523 (void) key_buffer;
1524 (void) key_buffer_size;
1525 (void) data;
1526 (void) data_size;
1527 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001529 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001530}
Ronald Crond18b5f82020-11-25 16:46:05 +01001531
Gilles Peskine449bd832023-01-11 14:50:10 +01001532psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1533 uint8_t *data,
1534 size_t data_size,
1535 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001536{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001537 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001538 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001539 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001540
Ronald Crone907e552021-01-18 13:22:38 +01001541 /* Reject a zero-length output buffer now, since this can never be a
1542 * valid key representation. This way we know that data must be a valid
1543 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 if (data_size == 0) {
1545 return PSA_ERROR_BUFFER_TOO_SMALL;
1546 }
Ronald Crone907e552021-01-18 13:22:38 +01001547
Darryl Greendd8fb772018-11-07 16:00:44 +00001548 /* Set the key to empty now, so that even when there are errors, we always
1549 * set data_length to a value between 0 and data_size. On error, setting
1550 * the key to empty is a good choice because an empty key representation is
1551 * unlikely to be accepted anywhere. */
1552 *data_length = 0;
1553
1554 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1556 if (status != PSA_SUCCESS) {
1557 return status;
1558 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001559
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1561 status = PSA_ERROR_INVALID_ARGUMENT;
1562 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001563 }
1564
Ronald Crond18b5f82020-11-25 16:46:05 +01001565 psa_key_attributes_t attributes = {
1566 .core = slot->attr
1567 };
Ronald Cron67227982020-11-26 15:16:05 +01001568 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001569 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001571
1572exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001574
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001576}
1577
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001578MBEDTLS_STATIC_ASSERT(
1579 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1580 "One or more key attribute flag is listed as both external-only and dual-use")
1581MBEDTLS_STATIC_ASSERT(
1582 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1583 "One or more key attribute flag is listed as both internal-only and dual-use")
1584MBEDTLS_STATIC_ASSERT(
1585 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1586 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001587
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001588/** Validate that a key policy is internally well-formed.
1589 *
1590 * This function only rejects invalid policies. It does not validate the
1591 * consistency of the policy with respect to other attributes of the key
1592 * such as the key type.
1593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001594static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001595{
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1597 PSA_KEY_USAGE_COPY |
1598 PSA_KEY_USAGE_ENCRYPT |
1599 PSA_KEY_USAGE_DECRYPT |
1600 PSA_KEY_USAGE_SIGN_MESSAGE |
1601 PSA_KEY_USAGE_VERIFY_MESSAGE |
1602 PSA_KEY_USAGE_SIGN_HASH |
1603 PSA_KEY_USAGE_VERIFY_HASH |
1604 PSA_KEY_USAGE_VERIFY_DERIVATION |
1605 PSA_KEY_USAGE_DERIVE)) != 0) {
1606 return PSA_ERROR_INVALID_ARGUMENT;
1607 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001610}
1611
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001612/** Validate the internal consistency of key attributes.
1613 *
1614 * This function only rejects invalid attribute values. If does not
1615 * validate the consistency of the attributes with any key data that may
1616 * be involved in the creation of the key.
1617 *
1618 * Call this function early in the key creation process.
1619 *
1620 * \param[in] attributes Key attributes for the new key.
1621 * \param[out] p_drv On any return, the driver for the key, if any.
1622 * NULL for a transparent key.
1623 *
1624 */
1625static psa_status_t psa_validate_key_attributes(
1626 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001628{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001629 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1631 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 status = psa_validate_key_location(lifetime, p_drv);
1634 if (status != PSA_SUCCESS) {
1635 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001636 }
1637
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 status = psa_validate_key_persistence(lifetime);
1639 if (status != PSA_SUCCESS) {
1640 return status;
1641 }
1642
1643 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1644 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1645 return PSA_ERROR_INVALID_ARGUMENT;
1646 }
1647 } else {
1648 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1649 return PSA_ERROR_INVALID_ARGUMENT;
1650 }
1651 }
1652
1653 status = psa_validate_key_policy(&attributes->core.policy);
1654 if (status != PSA_SUCCESS) {
1655 return status;
1656 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001657
1658 /* Refuse to create overly large keys.
1659 * Note that this doesn't trigger on import if the attributes don't
1660 * explicitly specify a size (so psa_get_key_bits returns 0), so
1661 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1663 return PSA_ERROR_NOT_SUPPORTED;
1664 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001665
Gilles Peskine91e8c332019-08-02 19:19:39 +02001666 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1668 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1669 return PSA_ERROR_INVALID_ARGUMENT;
1670 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001673}
1674
Gilles Peskine4747d192019-04-17 15:05:45 +02001675/** Prepare a key slot to receive key material.
1676 *
1677 * This function allocates a key slot and sets its metadata.
1678 *
1679 * If this function fails, call psa_fail_key_creation().
1680 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001681 * This function is intended to be used as follows:
1682 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001683 * it with the specified attributes, and in case of a volatile key assign it
1684 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001685 * -# Populate the slot with the key material.
1686 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1687 * In case of failure at any step, stop the sequence and call
1688 * psa_fail_key_creation().
1689 *
Ronald Cron5c522922020-11-14 16:35:34 +01001690 * On success, the key slot is locked. It is the responsibility of the caller
1691 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001692 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001693 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001694 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001695 * \param[out] p_slot On success, a pointer to the prepared slot.
1696 * \param[out] p_drv On any return, the driver for the key, if any.
1697 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001698 *
1699 * \retval #PSA_SUCCESS
1700 * The key slot is ready to receive key material.
1701 * \return If this function fails, the key slot is an invalid state.
1702 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001703 */
1704static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001705 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001706 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001707 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001709{
1710 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001711 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001712 psa_key_slot_t *slot;
1713
Gilles Peskinedf179142019-07-15 22:02:14 +02001714 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001715 *p_drv = NULL;
1716
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 status = psa_validate_key_attributes(attributes, p_drv);
1718 if (status != PSA_SUCCESS) {
1719 return status;
1720 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1723 if (status != PSA_SUCCESS) {
1724 return status;
1725 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 slot = *p_slot;
1727
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001728 /* We're storing the declared bit-size of the key. It's up to each
1729 * creation mechanism to verify that this information is correct.
1730 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001731 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001732 * is optional (import, copy). In case of a volatile key, assign it the
1733 * volatile key identifier associated to the slot returned to contain its
1734 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001735
1736 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001738#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1739 slot->attr.id = volatile_key_id;
1740#else
1741 slot->attr.id.key_id = volatile_key_id;
1742#endif
1743 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001744
Gilles Peskine91e8c332019-08-02 19:19:39 +02001745 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001746 * external-only flags, query `attributes`. Thanks to the check
1747 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001748 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001749 * may have set. */
1750 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001751
Gilles Peskinecbaff462019-07-12 23:46:04 +02001752#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001753 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001754 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001755 * create the key file in internal storage, create the
1756 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001757 * persistent data. This is done by starting a transaction that will
1758 * encompass these three actions.
1759 * For registering a volatile key, we just need to find an appropriate
1760 * slot number inside the SE. Since the key is designated volatile, creating
1761 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001762 /* The first thing to do is to find a slot number for the new key.
1763 * We save the slot number in persistent storage as part of the
1764 * transaction data. It will be needed to recover if the power
1765 * fails during the key creation process, to clean up on the secure
1766 * element side after restarting. Obtaining a slot number from the
1767 * secure element driver updates its persistent state, but we do not yet
1768 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001769 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001771 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1773 &slot_number);
1774 if (status != PSA_SUCCESS) {
1775 return status;
1776 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1779 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001780 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001781 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001782 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 status = psa_crypto_save_transaction();
1784 if (status != PSA_SUCCESS) {
1785 (void) psa_crypto_stop_transaction();
1786 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001787 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001788 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001789
1790 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001792 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001793
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001795 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001797 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001798#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1799
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001801}
Gilles Peskine4747d192019-04-17 15:05:45 +02001802
1803/** Finalize the creation of a key once its key material has been set.
1804 *
1805 * This entails writing the key to persistent storage.
1806 *
1807 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001808 * See the documentation of psa_start_key_creation() for the intended use
1809 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001810 *
Ronald Cron5c522922020-11-14 16:35:34 +01001811 * If the finalization succeeds, the function unlocks the key slot (it was
1812 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1813 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001814 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001815 * \param[in,out] slot Pointer to the slot with key material.
1816 * \param[in] driver The secure element driver for the key,
1817 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001818 * \param[out] key On success, identifier of the key. Note that the
1819 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001820 *
1821 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001822 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001823 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1824 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1825 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1826 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1827 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1828 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001829 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001830 * \return If this function fails, the key slot is an invalid state.
1831 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001832 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001833static psa_status_t psa_finish_key_creation(
1834 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001835 psa_se_drv_table_entry_t *driver,
1836 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001837{
1838 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001839 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001840 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001841
1842#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001844#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001846 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001847 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001849
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001850 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1851 sizeof(data.slot_number),
1852 "Slot number size does not match psa_se_key_data_storage_t");
1853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1855 status = psa_save_persistent_key(&slot->attr,
1856 (uint8_t *) &data,
1857 sizeof(data));
1858 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001859#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1860 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001861 /* Key material is saved in export representation in the slot, so
1862 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 status = psa_save_persistent_key(&slot->attr,
1864 slot->key.data,
1865 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001866 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001867 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001868#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1869
Gilles Peskinecbaff462019-07-12 23:46:04 +02001870#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001871 /* Finish the transaction for a key creation. This does not
1872 * happen when registering an existing key. Detect this case
1873 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001874 * creation of a persistent key in a secure element requires a transaction,
1875 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 if (driver != NULL &&
1877 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1878 status = psa_save_se_persistent_data(driver);
1879 if (status != PSA_SUCCESS) {
1880 psa_destroy_persistent_key(slot->attr.id);
1881 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001882 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001884 }
1885#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1886
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001888 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 status = psa_unlock_key_slot(slot);
1890 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001891 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001893 }
Ronald Cron50972942020-11-14 11:28:25 +01001894
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001896}
1897
1898/** Abort the creation of a key.
1899 *
1900 * You may call this function after calling psa_start_key_creation(),
1901 * or after psa_finish_key_creation() fails. In other circumstances, this
1902 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001903 * See the documentation of psa_start_key_creation() for the intended use
1904 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001905 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001906 * \param[in,out] slot Pointer to the slot with key material.
1907 * \param[in] driver The secure element driver for the key,
1908 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001910static void psa_fail_key_creation(psa_key_slot_t *slot,
1911 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001912{
Gilles Peskine011e4282019-06-26 18:34:38 +02001913 (void) driver;
1914
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001916 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001918
1919#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001920 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001921 * element, and the failure happened later (when saving metadata
1922 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001923 * element.
1924 * https://github.com/ARMmbed/mbed-crypto/issues/217
1925 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001926
Gilles Peskined7729582019-08-05 15:55:54 +02001927 /* Abort the ongoing transaction if any (there may not be one if
1928 * the creation process failed before starting one, or if the
1929 * key creation is a registration of a key in a secure element).
1930 * Earlier functions must already have done what it takes to undo any
1931 * partial creation. All that's left is to update the transaction data
1932 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001934#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1935
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001937}
1938
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001939/** Validate optional attributes during key creation.
1940 *
1941 * Some key attributes are optional during key creation. If they are
1942 * specified in the attributes structure, check that they are consistent
1943 * with the data in the slot.
1944 *
1945 * This function should be called near the end of key creation, after
1946 * the slot in memory is fully populated but before saving persistent data.
1947 */
1948static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001949 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001951{
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 if (attributes->core.type != 0) {
1953 if (attributes->core.type != slot->attr.type) {
1954 return PSA_ERROR_INVALID_ARGUMENT;
1955 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001956 }
1957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001959#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1960 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1962 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001963 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001964 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001966
Ronald Cron90857082020-11-25 14:58:33 +01001967 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 slot->attr.type,
1969 slot->key.data,
1970 slot->key.bytes,
1971 &rsa);
1972 if (status != PSA_SUCCESS) {
1973 return status;
1974 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 mbedtls_mpi_init(&actual);
1977 mbedtls_mpi_init(&required);
1978 ret = mbedtls_rsa_export(rsa,
1979 NULL, NULL, NULL, NULL, &actual);
1980 mbedtls_rsa_free(rsa);
1981 mbedtls_free(rsa);
1982 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001983 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
1985 ret = mbedtls_mpi_read_binary(&required,
1986 attributes->domain_parameters,
1987 attributes->domain_parameters_size);
1988 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001989 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 }
1991 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001992 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
1994rsa_exit:
1995 mbedtls_mpi_free(&actual);
1996 mbedtls_mpi_free(&required);
1997 if (ret != 0) {
1998 return mbedtls_to_psa_error(ret);
1999 }
2000 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002001#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2002 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002003 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002004 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006 }
2007 }
2008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 if (attributes->core.bits != 0) {
2010 if (attributes->core.bits != slot->attr.bits) {
2011 return PSA_ERROR_INVALID_ARGUMENT;
2012 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002013 }
2014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002016}
2017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2019 const uint8_t *data,
2020 size_t data_length,
2021 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002022{
2023 psa_status_t status;
2024 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002025 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002026 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302027 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002028
Ronald Cron81709fc2020-11-14 12:10:32 +01002029 *key = MBEDTLS_SVC_KEY_ID_INIT;
2030
Gilles Peskine0f84d622019-09-12 19:03:13 +02002031 /* Reject zero-length symmetric keys (including raw data key objects).
2032 * This also rejects any key which might be encoded as an empty string,
2033 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 if (data_length == 0) {
2035 return PSA_ERROR_INVALID_ARGUMENT;
2036 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002037
Archana449608b2021-09-08 15:36:05 +05302038 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 if (data_length > SIZE_MAX / 8) {
2040 return PSA_ERROR_NOT_SUPPORTED;
2041 }
Archana6ed4bda2021-08-04 10:47:15 +05302042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2044 &slot, &driver);
2045 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002046 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002048
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002049 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302050 * storage ( thus not in the case of importing a key in a secure element
2051 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2052 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (slot->key.data == NULL) {
2054 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302055 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 attributes, data, data_length, &storage_size);
2057 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302058 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 }
Archanad8a83dc2021-06-14 10:04:16 +05302060 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 status = psa_allocate_buffer_to_slot(slot, storage_size);
2062 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002063 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002065 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002066
2067 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 status = psa_driver_wrapper_import_key(attributes,
2069 data, data_length,
2070 slot->key.data,
2071 slot->key.bytes,
2072 &slot->key.bytes, &bits);
2073 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002074 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002078 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002080 status = PSA_ERROR_INVALID_ARGUMENT;
2081 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002082 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002083
Archana6ed4bda2021-08-04 10:47:15 +05302084 /* Enforce a size limit, and in particular ensure that the bit
2085 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302087 status = PSA_ERROR_NOT_SUPPORTED;
2088 goto exit;
2089 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 status = psa_validate_optional_attributes(slot, attributes);
2091 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002092 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002096exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (status != PSA_SUCCESS) {
2098 psa_fail_key_creation(slot, driver);
2099 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002102}
2103
Gilles Peskined7729582019-08-05 15:55:54 +02002104#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2105psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002107{
2108 psa_status_t status;
2109 psa_key_slot_t *slot = NULL;
2110 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002111 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002112
2113 /* Leaving attributes unspecified is not currently supported.
2114 * It could make sense to query the key type and size from the
2115 * secure element, but not all secure elements support this
2116 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2118 return PSA_ERROR_NOT_SUPPORTED;
2119 }
2120 if (psa_get_key_bits(attributes) == 0) {
2121 return PSA_ERROR_NOT_SUPPORTED;
2122 }
Gilles Peskined7729582019-08-05 15:55:54 +02002123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2125 &slot, &driver);
2126 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002127 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 }
Gilles Peskined7729582019-08-05 15:55:54 +02002129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002131
2132exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (status != PSA_SUCCESS) {
2134 psa_fail_key_creation(slot, driver);
2135 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002136
Gilles Peskined7729582019-08-05 15:55:54 +02002137 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 psa_close_key(key);
2139 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002140}
2141#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2144 const psa_key_attributes_t *specified_attributes,
2145 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002146{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002147 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002148 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002149 psa_key_slot_t *source_slot = NULL;
2150 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002151 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002152 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302153 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002154
Ronald Cron81709fc2020-11-14 12:10:32 +01002155 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2156
Archana8a180362021-07-05 02:18:48 +05302157 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2159 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002160 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 status = psa_validate_optional_attributes(source_slot,
2164 specified_attributes);
2165 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002166 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002168
Archana9d17bf42021-09-10 06:22:44 +05302169 /* The target key type and number of bits have been validated by
2170 * psa_validate_optional_attributes() to be either equal to zero or
2171 * equal to the ones of the source key. So it is safe to inherit
2172 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302173 * */
Archana9d17bf42021-09-10 06:22:44 +05302174 actual_attributes.core.bits = source_slot->attr.bits;
2175 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302176
2177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 status = psa_restrict_key_policy(source_slot->attr.type,
2179 &actual_attributes.core.policy,
2180 &source_slot->attr.policy);
2181 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002182 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002184
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2186 &target_slot, &driver);
2187 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002188 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 }
2190 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2191 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302192 /*
Archana9d17bf42021-09-10 06:22:44 +05302193 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302194 * the source key would need to be exported as plaintext and re-imported
2195 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302196 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302197 * appropriate API invocations from the application, if needed.
2198 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002199 status = PSA_ERROR_NOT_SUPPORTED;
2200 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002201 }
Archana8a180362021-07-05 02:18:48 +05302202 /*
2203 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302204 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302205 * - For opaque keys this translates to an invocation of the drivers'
2206 * copy_key entry point through the dispatch layer.
2207 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2209 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2210 &storage_size);
2211 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 }
Archana374fe5b2021-09-08 15:50:28 +05302214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2216 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302217 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 }
Archana374fe5b2021-09-08 15:50:28 +05302219
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 status = psa_driver_wrapper_copy_key(&actual_attributes,
2221 source_slot->key.data,
2222 source_slot->key.bytes,
2223 target_slot->key.data,
2224 target_slot->key.bytes,
2225 &target_slot->key.bytes);
2226 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302227 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 }
2229 } else {
2230 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302231 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 source_slot->key.bytes);
2233 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 }
Archana8a180362021-07-05 02:18:48 +05302236 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002238exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (status != PSA_SUCCESS) {
2240 psa_fail_key_creation(target_slot, driver);
2241 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002246}
2247
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002248
2249
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002250/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002251/* Message digests */
2252/****************************************************************/
2253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002256 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 if (operation->id == 0) {
2258 return PSA_SUCCESS;
2259 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002262 operation->id = 0;
2263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265}
2266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2268 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002269{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002271
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002272 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002274 status = PSA_ERROR_BAD_STATE;
2275 goto exit;
2276 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002279 status = PSA_ERROR_INVALID_ARGUMENT;
2280 goto exit;
2281 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002282
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002283 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2284 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002288
2289exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (status != PSA_SUCCESS) {
2291 psa_hash_abort(operation);
2292 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002293
2294 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002295}
2296
Gilles Peskine449bd832023-01-11 14:50:10 +01002297psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2298 const uint8_t *input,
2299 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002300{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002304 status = PSA_ERROR_BAD_STATE;
2305 goto exit;
2306 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002307
Steven Cooremanc8288352021-03-04 14:02:19 +01002308 /* Don't require hash implementations to behave correctly on a
2309 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 if (input_length == 0) {
2311 return PSA_SUCCESS;
2312 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002315
2316exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 if (status != PSA_SUCCESS) {
2318 psa_hash_abort(operation);
2319 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002322}
2323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2325 uint8_t *hash,
2326 size_t hash_size,
2327 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002328{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002329 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 if (operation->id == 0) {
2331 return PSA_ERROR_BAD_STATE;
2332 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333
Steven Cooreman1e582352021-02-18 17:24:37 +01002334 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 operation, hash, hash_size, hash_length);
2336 psa_hash_abort(operation);
2337 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002338}
2339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2341 const uint8_t *hash,
2342 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002343{
Ronald Cron69a63422021-10-18 09:47:58 +02002344 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002345 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002346 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 operation,
2348 actual_hash, sizeof(actual_hash),
2349 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002352 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002356 status = PSA_ERROR_INVALID_SIGNATURE;
2357 goto exit;
2358 }
2359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002361 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002363
2364exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2366 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002367 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002371}
2372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373psa_status_t psa_hash_compute(psa_algorithm_t alg,
2374 const uint8_t *input, size_t input_length,
2375 uint8_t *hash, size_t hash_size,
2376 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002377{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002378 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 if (!PSA_ALG_IS_HASH(alg)) {
2380 return PSA_ERROR_INVALID_ARGUMENT;
2381 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2384 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002385}
2386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387psa_status_t psa_hash_compare(psa_algorithm_t alg,
2388 const uint8_t *input, size_t input_length,
2389 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002390{
Ronald Cron69a63422021-10-18 09:47:58 +02002391 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002392 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002393
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 if (!PSA_ALG_IS_HASH(alg)) {
2395 return PSA_ERROR_INVALID_ARGUMENT;
2396 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002397
Steven Cooreman1e582352021-02-18 17:24:37 +01002398 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 alg, input, input_length,
2400 actual_hash, sizeof(actual_hash),
2401 &actual_hash_length);
2402 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002403 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 }
2405 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002406 status = PSA_ERROR_INVALID_SIGNATURE;
2407 goto exit;
2408 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002410 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002412
2413exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2415 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002416}
2417
Gilles Peskine449bd832023-01-11 14:50:10 +01002418psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2419 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002420{
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 if (source_operation->id == 0 ||
2422 target_operation->id != 0) {
2423 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002424 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2427 target_operation);
2428 if (status != PSA_SUCCESS) {
2429 psa_hash_abort(target_operation);
2430 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002433}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002434
2435
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002436/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002437/* MAC */
2438/****************************************************************/
2439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002441{
Steven Cooremane6804192021-03-19 18:28:56 +01002442 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 if (operation->id == 0) {
2444 return PSA_SUCCESS;
2445 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002448 operation->mac_size = 0;
2449 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002450 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002453}
2454
Ronald Cron2dff3b22021-06-17 16:33:22 +02002455static psa_status_t psa_mac_finalize_alg_and_key_validation(
2456 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002457 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002459{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002460 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 psa_key_type_t key_type = psa_get_key_type(attributes);
2462 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (!PSA_ALG_IS_MAC(alg)) {
2465 return PSA_ERROR_INVALID_ARGUMENT;
2466 }
Steven Cooremane6804192021-03-19 18:28:56 +01002467
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002468 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 status = psa_mac_key_can_do(alg, key_type);
2470 if (status != PSA_SUCCESS) {
2471 return status;
2472 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002473
Steven Cooremand1a68f12021-05-10 11:13:41 +02002474 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002478 /* A very short MAC is too short for security since it can be
2479 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2480 * so we make this our minimum, even though 32 bits is still
2481 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002483 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2486 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002487 /* It's impossible to "truncate" to a larger length than the full length
2488 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002490 }
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002493 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2494 * that is disabled in the compile-time configuration. The result can
2495 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2496 * configuration into account. In this case, force a return of
2497 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2498 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2499 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2500 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2501 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002503 }
2504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002506}
2507
Gilles Peskine449bd832023-01-11 14:50:10 +01002508static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2509 mbedtls_svc_key_id_t key,
2510 psa_algorithm_t alg,
2511 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002512{
2513 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2514 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002515 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002516
2517 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002519 status = PSA_ERROR_BAD_STATE;
2520 goto exit;
2521 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522
2523 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 key,
2525 &slot,
2526 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2527 alg);
2528 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002529 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531
2532 psa_key_attributes_t attributes = {
2533 .core = slot->attr
2534 };
2535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2537 &operation->mac_size);
2538 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002539 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002541
2542 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002543 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (is_sign) {
2545 status = psa_driver_wrapper_mac_sign_setup(operation,
2546 &attributes,
2547 slot->key.data,
2548 slot->key.bytes,
2549 alg);
2550 } else {
2551 status = psa_driver_wrapper_mac_verify_setup(operation,
2552 &attributes,
2553 slot->key.data,
2554 slot->key.bytes,
2555 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002556 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002557
Gilles Peskinefbfac682018-07-08 20:51:54 +02002558exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 if (status != PSA_SUCCESS) {
2560 psa_mac_abort(operation);
2561 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002566}
2567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2569 mbedtls_svc_key_id_t key,
2570 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002571{
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002573}
2574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2576 mbedtls_svc_key_id_t key,
2577 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002578{
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002580}
2581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2583 const uint8_t *input,
2584 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002585{
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (operation->id == 0) {
2587 return PSA_ERROR_BAD_STATE;
2588 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002589
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002590 /* Don't require hash implementations to behave correctly on a
2591 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (input_length == 0) {
2593 return PSA_SUCCESS;
2594 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2597 input, input_length);
2598 if (status != PSA_SUCCESS) {
2599 psa_mac_abort(operation);
2600 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603}
2604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2606 uint8_t *mac,
2607 size_t mac_size,
2608 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002609{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002610 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2611 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002614 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002615 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002616 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002619 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002620 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002621 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002622
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002623 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2624 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002626 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002627 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002628 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002631 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002632 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002633 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 status = psa_driver_wrapper_mac_sign_finish(operation,
2636 mac, operation->mac_size,
2637 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002638
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002639exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002640 /* In case of success, set the potential excess room in the output buffer
2641 * to an invalid value, to avoid potentially leaking a longer MAC.
2642 * In case of error, set the output length and content to a safe default,
2643 * such that in case the caller misses an error check, the output would be
2644 * an unachievable MAC.
2645 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002647 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002648 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002649 }
mohammad16036df908f2018-04-02 08:34:15 -07002650
Paul Elliottdc42ca82023-02-24 18:11:59 +00002651 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002654
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002656}
2657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2659 const uint8_t *mac,
2660 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002661{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002662 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2663 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002666 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002667 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002668 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002671 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002672 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002673 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002676 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002677 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002678 }
2679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 status = psa_driver_wrapper_mac_verify_finish(operation,
2681 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002682
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002683exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002687}
2688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2690 psa_algorithm_t alg,
2691 const uint8_t *input,
2692 size_t input_length,
2693 uint8_t *mac,
2694 size_t mac_size,
2695 size_t *mac_length,
2696 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002697{
2698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002699 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2700 psa_key_slot_t *slot;
2701 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702
Ronald Cron51131b52021-06-17 17:17:20 +02002703 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 key,
2705 &slot,
2706 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2707 alg);
2708 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002709 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002711
Ronald Cron51131b52021-06-17 17:17:20 +02002712 psa_key_attributes_t attributes = {
2713 .core = slot->attr
2714 };
2715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2717 &operation_mac_size);
2718 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002719 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002723 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002724 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002725 }
2726
2727 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 &attributes,
2729 slot->key.data, slot->key.bytes,
2730 alg,
2731 input, input_length,
2732 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002733
2734exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002735 /* In case of success, set the potential excess room in the output buffer
2736 * to an invalid value, to avoid potentially leaking a longer MAC.
2737 * In case of error, set the output length and content to a safe default,
2738 * such that in case the caller misses an error check, the output would be
2739 * an unachievable MAC.
2740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002742 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002743 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002744 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002745
2746 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002751}
2752
Gilles Peskine449bd832023-01-11 14:50:10 +01002753psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002754 psa_algorithm_t alg,
2755 const uint8_t *input,
2756 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 uint8_t *mac,
2758 size_t mac_size,
2759 size_t *mac_length)
2760{
2761 return psa_mac_compute_internal(key, alg,
2762 input, input_length,
2763 mac, mac_size, mac_length, 1);
2764}
2765
2766psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2767 psa_algorithm_t alg,
2768 const uint8_t *input,
2769 size_t input_length,
2770 const uint8_t *mac,
2771 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002772{
2773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002774 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2775 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 status = psa_mac_compute_internal(key, alg,
2778 input, input_length,
2779 actual_mac, sizeof(actual_mac),
2780 &actual_mac_length, 0);
2781 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002782 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002784
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002786 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002787 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002788 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002790 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002791 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002792 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002793
2794exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002798}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002799
Gilles Peskinee59236f2018-01-27 23:32:46 +01002800/****************************************************************/
2801/* Asymmetric cryptography */
2802/****************************************************************/
2803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2805 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002806{
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (input_is_message) {
2808 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2809 return PSA_ERROR_INVALID_ARGUMENT;
2810 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2813 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2814 return PSA_ERROR_INVALID_ARGUMENT;
2815 }
2816 }
2817 } else {
2818 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2819 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002820 }
2821 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002824}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2827 int input_is_message,
2828 psa_algorithm_t alg,
2829 const uint8_t *input,
2830 size_t input_length,
2831 uint8_t *signature,
2832 size_t signature_size,
2833 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002834{
2835 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2836 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2837 psa_key_slot_t *slot;
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
2869 psa_key_attributes_t attributes = {
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;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003172
Darryl Green5cc689a2018-07-24 15:34:10 +01003173 (void) input;
3174 (void) input_length;
3175 (void) salt;
3176 (void) output;
3177 (void) output_size;
3178
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003179 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003180
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3182 return PSA_ERROR_INVALID_ARGUMENT;
3183 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003184
Ronald Cron5c522922020-11-14 16:35:34 +01003185 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3187 if (status != PSA_SUCCESS) {
3188 return status;
3189 }
3190 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3191 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003192 status = PSA_ERROR_INVALID_ARGUMENT;
3193 goto exit;
3194 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003195
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003196 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003198 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003199
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003200 status = psa_driver_wrapper_asymmetric_encrypt(
3201 &attributes, slot->key.data, slot->key.bytes,
3202 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003204exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003206
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003208}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3211 psa_algorithm_t alg,
3212 const uint8_t *input,
3213 size_t input_length,
3214 const uint8_t *salt,
3215 size_t salt_length,
3216 uint8_t *output,
3217 size_t output_size,
3218 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003220 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003221 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003222 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003223
Darryl Green5cc689a2018-07-24 15:34:10 +01003224 (void) input;
3225 (void) input_length;
3226 (void) salt;
3227 (void) output;
3228 (void) output_size;
3229
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003230 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3233 return PSA_ERROR_INVALID_ARGUMENT;
3234 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003235
Ronald Cron5c522922020-11-14 16:35:34 +01003236 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3238 if (status != PSA_SUCCESS) {
3239 return status;
3240 }
3241 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003242 status = PSA_ERROR_INVALID_ARGUMENT;
3243 goto exit;
3244 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003245
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003246 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003248 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003249
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003250 status = psa_driver_wrapper_asymmetric_decrypt(
3251 &attributes, slot->key.data, slot->key.bytes,
3252 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003254
3255exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003259}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003260
Paul Elliott9fe12f62022-11-30 19:16:02 +00003261/****************************************************************/
3262/* Asymmetric interruptible cryptography */
3263/****************************************************************/
3264
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003265static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3266
Paul Elliott9fe12f62022-11-30 19:16:02 +00003267void psa_interruptible_set_max_ops(uint32_t max_ops)
3268{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003269 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003270}
3271
3272uint32_t psa_interruptible_get_max_ops(void)
3273{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003274 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003275}
3276
Paul Elliott9fe12f62022-11-30 19:16:02 +00003277uint32_t psa_sign_hash_get_num_ops(
3278 const psa_sign_hash_interruptible_operation_t *operation)
3279{
Paul Elliott296ede92022-12-15 17:00:30 +00003280 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003281}
3282
3283uint32_t psa_verify_hash_get_num_ops(
3284 const psa_verify_hash_interruptible_operation_t *operation)
3285{
Paul Elliott296ede92022-12-15 17:00:30 +00003286 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003287}
3288
Paul Elliott59ad9452022-12-18 15:09:02 +00003289static psa_status_t psa_sign_hash_abort_internal(
3290 psa_sign_hash_interruptible_operation_t *operation)
3291{
3292 if (operation->id == 0) {
3293 /* The object has (apparently) been initialized but it is not (yet)
3294 * in use. It's ok to call abort on such an object, and there's
3295 * nothing to do. */
3296 return PSA_SUCCESS;
3297 }
3298
3299 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3300
3301 status = psa_driver_wrapper_sign_hash_abort(operation);
3302
3303 operation->id = 0;
3304
Paul Elliotte6145dc2023-02-07 12:51:21 +00003305 /* Do not clear either the error_occurred or num_ops elements here as they
3306 * only want to be cleared by the application calling abort, not by abort
3307 * being called at completion of an operation. */
3308
Paul Elliott59ad9452022-12-18 15:09:02 +00003309 return status;
3310}
3311
Paul Elliott9fe12f62022-11-30 19:16:02 +00003312psa_status_t psa_sign_hash_start(
3313 psa_sign_hash_interruptible_operation_t *operation,
3314 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3315 const uint8_t *hash, size_t hash_length)
3316{
3317 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3318 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3319 psa_key_slot_t *slot;
3320
Paul Elliottc9774412023-02-06 15:14:07 +00003321 /* Check that start has not been previously called, or operation has not
3322 * previously errored. */
3323 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003324 return PSA_ERROR_BAD_STATE;
3325 }
3326
Paul Elliott9fe12f62022-11-30 19:16:02 +00003327 status = psa_sign_verify_check_alg(0, alg);
3328 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003329 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003330 return status;
3331 }
3332
3333 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3334 PSA_KEY_USAGE_SIGN_HASH,
3335 alg);
3336
3337 if (status != PSA_SUCCESS) {
3338 goto exit;
3339 }
3340
3341 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3342 status = PSA_ERROR_INVALID_ARGUMENT;
3343 goto exit;
3344 }
3345
3346 psa_key_attributes_t attributes = {
3347 .core = slot->attr
3348 };
3349
Paul Elliott296ede92022-12-15 17:00:30 +00003350 /* Ensure ops count gets reset, in case of operation re-use. */
3351 operation->num_ops = 0;
3352
Paul Elliott9fe12f62022-11-30 19:16:02 +00003353 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3354 slot->key.data,
3355 slot->key.bytes, alg,
3356 hash, hash_length);
3357exit:
3358
3359 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003360 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003361 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003362 }
3363
3364 unlock_status = psa_unlock_key_slot(slot);
3365
Paul Elliottc9774412023-02-06 15:14:07 +00003366 if (unlock_status != PSA_SUCCESS) {
3367 operation->error_occurred = 1;
3368 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003369
Paul Elliottc9774412023-02-06 15:14:07 +00003370 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003371}
3372
3373
3374psa_status_t psa_sign_hash_complete(
3375 psa_sign_hash_interruptible_operation_t *operation,
3376 uint8_t *signature, size_t signature_size,
3377 size_t *signature_length)
3378{
3379 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3380
3381 *signature_length = 0;
3382
Paul Elliottc9774412023-02-06 15:14:07 +00003383 /* Check that start has been called first, and that operation has not
3384 * previously errored. */
3385 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003386 status = PSA_ERROR_BAD_STATE;
3387 goto exit;
3388 }
3389
Paul Elliott096abc42023-02-03 18:33:23 +00003390 /* Immediately reject a zero-length signature buffer. This guarantees that
3391 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003392 if (signature_size == 0) {
3393 status = PSA_ERROR_BUFFER_TOO_SMALL;
3394 goto exit;
3395 }
3396
3397 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3398 signature_size,
3399 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003400
Paul Elliott296ede92022-12-15 17:00:30 +00003401 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003402 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003403
Paul Elliottebe225c2023-02-10 14:32:53 +00003404exit:
3405
Paul Elliott59200a22023-02-21 15:07:40 +00003406 psa_wipe_tag_output_buffer(signature, status, signature_size,
3407 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003408
Paul Elliott53bb3122023-02-10 14:22:22 +00003409 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003410 if (status != PSA_SUCCESS) {
3411 operation->error_occurred = 1;
3412 }
3413
Paul Elliott59ad9452022-12-18 15:09:02 +00003414 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003415 }
3416
3417 return status;
3418}
3419
3420psa_status_t psa_sign_hash_abort(
3421 psa_sign_hash_interruptible_operation_t *operation)
3422{
Paul Elliott59ad9452022-12-18 15:09:02 +00003423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3424
3425 status = psa_sign_hash_abort_internal(operation);
3426
3427 /* We clear the number of ops done here, so that it is not cleared when
3428 * the operation fails or succeeds, only on manual abort. */
3429 operation->num_ops = 0;
3430
Paul Elliottc9774412023-02-06 15:14:07 +00003431 /* Likewise, failure state. */
3432 operation->error_occurred = 0;
3433
Paul Elliott59ad9452022-12-18 15:09:02 +00003434 return status;
3435}
3436
3437static psa_status_t psa_verify_hash_abort_internal(
3438 psa_verify_hash_interruptible_operation_t *operation)
3439{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440 if (operation->id == 0) {
3441 /* The object has (apparently) been initialized but it is not (yet)
3442 * in use. It's ok to call abort on such an object, and there's
3443 * nothing to do. */
3444 return PSA_SUCCESS;
3445 }
3446
Paul Elliott59ad9452022-12-18 15:09:02 +00003447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3448
3449 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450
3451 operation->id = 0;
3452
Paul Elliotte6145dc2023-02-07 12:51:21 +00003453 /* Do not clear either the error_occurred or num_ops elements here as they
3454 * only want to be cleared by the application calling abort, not by abort
3455 * being called at completion of an operation. */
3456
Paul Elliott59ad9452022-12-18 15:09:02 +00003457 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003458}
3459
3460psa_status_t psa_verify_hash_start(
3461 psa_verify_hash_interruptible_operation_t *operation,
3462 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3463 const uint8_t *hash, size_t hash_length,
3464 const uint8_t *signature, size_t signature_length)
3465{
3466 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3467 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3468 psa_key_slot_t *slot;
3469
Paul Elliottc9774412023-02-06 15:14:07 +00003470 /* Check that start has not been previously called, or operation has not
3471 * previously errored. */
3472 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003473 return PSA_ERROR_BAD_STATE;
3474 }
3475
3476 status = psa_sign_verify_check_alg(0, alg);
3477 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003478 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003479 return status;
3480 }
3481
3482 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3483 PSA_KEY_USAGE_VERIFY_HASH,
3484 alg);
3485
3486 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003487 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488 return status;
3489 }
3490
3491 psa_key_attributes_t attributes = {
3492 .core = slot->attr
3493 };
3494
Paul Elliott296ede92022-12-15 17:00:30 +00003495 /* Ensure ops count gets reset, in case of operation re-use. */
3496 operation->num_ops = 0;
3497
Paul Elliott9fe12f62022-11-30 19:16:02 +00003498 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3499 slot->key.data,
3500 slot->key.bytes,
3501 alg, hash, hash_length,
3502 signature, signature_length);
3503
3504 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003505 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003506 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003507 }
3508
3509 unlock_status = psa_unlock_key_slot(slot);
3510
Paul Elliottc9774412023-02-06 15:14:07 +00003511 if (unlock_status != PSA_SUCCESS) {
3512 operation->error_occurred = 1;
3513 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514
Paul Elliottc9774412023-02-06 15:14:07 +00003515 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003516}
3517
3518psa_status_t psa_verify_hash_complete(
3519 psa_verify_hash_interruptible_operation_t *operation)
3520{
3521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3522
Paul Elliottc9774412023-02-06 15:14:07 +00003523 /* Check that start has been called first, and that operation has not
3524 * previously errored. */
3525 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003526 status = PSA_ERROR_BAD_STATE;
3527 goto exit;
3528 }
3529
3530 status = psa_driver_wrapper_verify_hash_complete(operation);
3531
Paul Elliott296ede92022-12-15 17:00:30 +00003532 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003533 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003534 operation);
3535
Paul Elliottebe225c2023-02-10 14:32:53 +00003536exit:
3537
Paul Elliott9fe12f62022-11-30 19:16:02 +00003538 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003539 if (status != PSA_SUCCESS) {
3540 operation->error_occurred = 1;
3541 }
3542
Paul Elliott59ad9452022-12-18 15:09:02 +00003543 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003544 }
3545
3546 return status;
3547}
3548
3549psa_status_t psa_verify_hash_abort(
3550 psa_verify_hash_interruptible_operation_t *operation)
3551{
Paul Elliott59ad9452022-12-18 15:09:02 +00003552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003553
Paul Elliott59ad9452022-12-18 15:09:02 +00003554 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003555
Paul Elliott59ad9452022-12-18 15:09:02 +00003556 /* We clear the number of ops done here, so that it is not cleared when
3557 * the operation fails or succeeds, only on manual abort. */
3558 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003559
Paul Elliottc9774412023-02-06 15:14:07 +00003560 /* Likewise, failure state. */
3561 operation->error_occurred = 0;
3562
Paul Elliott59ad9452022-12-18 15:09:02 +00003563 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003564}
3565
Paul Elliott588f8ed2022-12-02 18:10:26 +00003566/****************************************************************/
3567/* Asymmetric interruptible cryptography internal */
3568/* implementations */
3569/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003570
Paul Elliott588f8ed2022-12-02 18:10:26 +00003571void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3572{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003573
Paul Elliott588f8ed2022-12-02 18:10:26 +00003574#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3575 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3576 defined(MBEDTLS_ECP_RESTARTABLE)
3577
3578 /* Internal implementation uses zero to indicate infinite number max ops,
3579 * therefore avoid this value, and set to minimum possible. */
3580 if (max_ops == 0) {
3581 max_ops = 1;
3582 }
3583
Paul Elliott588f8ed2022-12-02 18:10:26 +00003584 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003585#else
3586 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003587#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3588 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3589 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3590}
3591
Paul Elliott588f8ed2022-12-02 18:10:26 +00003592uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003593 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003594{
3595#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3596 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3597 defined(MBEDTLS_ECP_RESTARTABLE)
3598
Paul Elliott93d9ca82023-02-15 18:14:21 +00003599 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003600#else
3601 (void) operation;
3602 return 0;
3603#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3604 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3605 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3606}
3607
3608uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003609 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003610{
3611 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3612 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3613 defined(MBEDTLS_ECP_RESTARTABLE)
3614
Paul Elliott93d9ca82023-02-15 18:14:21 +00003615 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003616#else
3617 (void) operation;
3618 return 0;
3619#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3620 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3621 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3622}
3623
3624psa_status_t mbedtls_psa_sign_hash_start(
3625 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3626 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3627 size_t key_buffer_size, psa_algorithm_t alg,
3628 const uint8_t *hash, size_t hash_length)
3629{
3630 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003631 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003632
Paul Elliott068fe072023-01-16 13:59:15 +00003633 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3634 return PSA_ERROR_NOT_SUPPORTED;
3635 }
3636
3637 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003638 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003639 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003640
3641#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003642 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3643 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003644
Paul Elliotta1c94092023-02-15 16:38:04 +00003645 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3646
Paul Elliott93d9ca82023-02-15 18:14:21 +00003647 /* Ensure num_ops is zero'ed in case of context re-use. */
3648 operation->num_ops = 0;
3649
Paul Elliott068fe072023-01-16 13:59:15 +00003650 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3651 attributes->core.bits,
3652 key_buffer,
3653 key_buffer_size,
3654 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003655
Paul Elliott068fe072023-01-16 13:59:15 +00003656 if (status != PSA_SUCCESS) {
3657 return status;
3658 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003659
Paul Elliott1bc59df2023-02-05 13:41:57 +00003660 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003661 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003662
Paul Elliott068fe072023-01-16 13:59:15 +00003663 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003664 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003665 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003666
Paul Elliott0290a762023-02-09 14:30:24 +00003667 /* We only need to store the same length of hash as the private key size
3668 * here, it would be truncated by the internal implementation anyway. */
3669 required_hash_length = (hash_length < operation->coordinate_bytes ?
3670 hash_length : operation->coordinate_bytes);
3671
Paul Elliottba70ad42023-02-15 18:23:53 +00003672 if (required_hash_length > sizeof(operation->hash)) {
3673 /* Shouldn't happen, but better safe than sorry. */
3674 return PSA_ERROR_CORRUPTION_DETECTED;
3675 }
3676
Paul Elliott0290a762023-02-09 14:30:24 +00003677 memcpy(operation->hash, hash, required_hash_length);
3678 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003679
3680 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003681
3682#else
Paul Elliott068fe072023-01-16 13:59:15 +00003683 (void) operation;
3684 (void) key_buffer;
3685 (void) key_buffer_size;
3686 (void) alg;
3687 (void) hash;
3688 (void) hash_length;
3689 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003690 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003691
Paul Elliott068fe072023-01-16 13:59:15 +00003692 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003693#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3694 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3695 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003696}
3697
3698psa_status_t mbedtls_psa_sign_hash_complete(
3699 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3700 uint8_t *signature, size_t signature_size,
3701 size_t *signature_length)
3702{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003703#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3704 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3705 defined(MBEDTLS_ECP_RESTARTABLE)
3706
Paul Elliotta1c94092023-02-15 16:38:04 +00003707 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003708 mbedtls_mpi r;
3709 mbedtls_mpi s;
3710
Paul Elliott46845252023-02-03 14:59:11 +00003711 mbedtls_mpi_init(&r);
3712 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003713
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003714 /* Ensure max_ops is set to the current value (or default). */
3715 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3716
Paul Elliotta1c94092023-02-15 16:38:04 +00003717 if (signature_size < 2 * operation->coordinate_bytes) {
3718 status = PSA_ERROR_BUFFER_TOO_SMALL;
3719 goto exit;
3720 }
3721
Paul Elliott588f8ed2022-12-02 18:10:26 +00003722 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003723
Paul Elliott588f8ed2022-12-02 18:10:26 +00003724#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3725 status = mbedtls_to_psa_error(
3726 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003727 &r,
3728 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003729 &operation->ctx->d,
3730 operation->hash,
3731 operation->hash_length,
3732 operation->md_alg,
3733 mbedtls_psa_get_random,
3734 MBEDTLS_PSA_RANDOM_STATE,
3735 &operation->restart_ctx));
3736#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003737 status = PSA_ERROR_NOT_SUPPORTED;
3738 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003739#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3740 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741 status = mbedtls_to_psa_error(
3742 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003743 &r,
3744 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745 &operation->ctx->d,
3746 operation->hash,
3747 operation->hash_length,
3748 mbedtls_psa_get_random,
3749 MBEDTLS_PSA_RANDOM_STATE,
3750 mbedtls_psa_get_random,
3751 MBEDTLS_PSA_RANDOM_STATE,
3752 &operation->restart_ctx));
3753 }
3754
Paul Elliottf8e5b562023-02-19 18:43:45 +00003755 /* Hide the fact that the restart context only holds a delta of number of
3756 * ops done during the last operation, not an absolute value. */
3757 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3758
Paul Elliott724bd252023-02-08 12:35:08 +00003759 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003760 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003761 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003763 operation->coordinate_bytes)
3764 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765
3766 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003767 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003768 }
3769
3770 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003771 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003772 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003773 operation->coordinate_bytes,
3774 operation->coordinate_bytes)
3775 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003776
3777 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003778 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003779 }
3780
Paul Elliott1bc59df2023-02-05 13:41:57 +00003781 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003782
Paul Elliott724bd252023-02-08 12:35:08 +00003783 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784 }
Paul Elliott724bd252023-02-08 12:35:08 +00003785
3786exit:
3787
3788 mbedtls_mpi_free(&r);
3789 mbedtls_mpi_free(&s);
3790 return status;
3791
Paul Elliott588f8ed2022-12-02 18:10:26 +00003792 #else
3793
3794 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795 (void) signature;
3796 (void) signature_size;
3797 (void) signature_length;
3798
3799 return PSA_ERROR_NOT_SUPPORTED;
3800
3801#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3802 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3803 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3804}
3805
3806psa_status_t mbedtls_psa_sign_hash_abort(
3807 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3808{
3809
3810#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3811 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3812 defined(MBEDTLS_ECP_RESTARTABLE)
3813
3814 if (operation->ctx) {
3815 mbedtls_ecdsa_free(operation->ctx);
3816 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003817 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003818 }
3819
3820 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3821
Paul Elliott93d9ca82023-02-15 18:14:21 +00003822 operation->num_ops = 0;
3823
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824 return PSA_SUCCESS;
3825
3826#else
3827
3828 (void) operation;
3829
3830 return PSA_ERROR_NOT_SUPPORTED;
3831
3832#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3833 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3834 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3835}
3836
3837psa_status_t mbedtls_psa_verify_hash_start(
3838 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3839 const psa_key_attributes_t *attributes,
3840 const uint8_t *key_buffer, size_t key_buffer_size,
3841 psa_algorithm_t alg,
3842 const uint8_t *hash, size_t hash_length,
3843 const uint8_t *signature, size_t signature_length)
3844{
3845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003846 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003847 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003848
Paul Elliott068fe072023-01-16 13:59:15 +00003849 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3850 return PSA_ERROR_NOT_SUPPORTED;
3851 }
3852
3853 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003854 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003855 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003856
3857#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003858 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3859 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860
Paul Elliotta1c94092023-02-15 16:38:04 +00003861 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3862 mbedtls_mpi_init(&operation->r);
3863 mbedtls_mpi_init(&operation->s);
3864
Paul Elliott93d9ca82023-02-15 18:14:21 +00003865 /* Ensure num_ops is zero'ed in case of context re-use. */
3866 operation->num_ops = 0;
3867
Paul Elliott068fe072023-01-16 13:59:15 +00003868 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3869 attributes->core.bits,
3870 key_buffer,
3871 key_buffer_size,
3872 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003873
Paul Elliott068fe072023-01-16 13:59:15 +00003874 if (status != PSA_SUCCESS) {
3875 return status;
3876 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003877
Paul Elliottc569fc22023-02-10 13:02:54 +00003878 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003879
Paul Elliott1bc59df2023-02-05 13:41:57 +00003880 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003881 return PSA_ERROR_INVALID_SIGNATURE;
3882 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003883
Paul Elliott068fe072023-01-16 13:59:15 +00003884 status = mbedtls_to_psa_error(
3885 mbedtls_mpi_read_binary(&operation->r,
3886 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003887 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888
Paul Elliott068fe072023-01-16 13:59:15 +00003889 if (status != PSA_SUCCESS) {
3890 return status;
3891 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003892
Paul Elliott068fe072023-01-16 13:59:15 +00003893 status = mbedtls_to_psa_error(
3894 mbedtls_mpi_read_binary(&operation->s,
3895 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003896 coordinate_bytes,
3897 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898
Paul Elliott068fe072023-01-16 13:59:15 +00003899 if (status != PSA_SUCCESS) {
3900 return status;
3901 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902
Paul Elliott2c9843f2023-02-15 17:32:42 +00003903 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904
Paul Elliott2c9843f2023-02-15 17:32:42 +00003905 if (status != PSA_SUCCESS) {
3906 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003907 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003908
Paul Elliott0290a762023-02-09 14:30:24 +00003909 /* We only need to store the same length of hash as the private key size
3910 * here, it would be truncated by the internal implementation anyway. */
3911 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3912 coordinate_bytes);
3913
Paul Elliottba70ad42023-02-15 18:23:53 +00003914 if (required_hash_length > sizeof(operation->hash)) {
3915 /* Shouldn't happen, but better safe than sorry. */
3916 return PSA_ERROR_CORRUPTION_DETECTED;
3917 }
3918
Paul Elliott0290a762023-02-09 14:30:24 +00003919 memcpy(operation->hash, hash, required_hash_length);
3920 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003921
3922 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003923#else
Paul Elliott068fe072023-01-16 13:59:15 +00003924 (void) operation;
3925 (void) key_buffer;
3926 (void) key_buffer_size;
3927 (void) alg;
3928 (void) hash;
3929 (void) hash_length;
3930 (void) signature;
3931 (void) signature_length;
3932 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003933 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003934 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003935
Paul Elliott068fe072023-01-16 13:59:15 +00003936 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3938 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3939 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003940}
3941
3942psa_status_t mbedtls_psa_verify_hash_complete(
3943 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3944{
3945
3946#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3947 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3948 defined(MBEDTLS_ECP_RESTARTABLE)
3949
Paul Elliottf8e5b562023-02-19 18:43:45 +00003950 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3951
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003952 /* Ensure max_ops is set to the current value (or default). */
3953 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3954
Paul Elliottf8e5b562023-02-19 18:43:45 +00003955 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3957 operation->hash,
3958 operation->hash_length,
3959 &operation->ctx->Q,
3960 &operation->r,
3961 &operation->s,
3962 &operation->restart_ctx));
3963
Paul Elliottf8e5b562023-02-19 18:43:45 +00003964 /* Hide the fact that the restart context only holds a delta of number of
3965 * ops done during the last operation, not an absolute value. */
3966 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3967
3968 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003969#else
3970 (void) operation;
3971
3972 return PSA_ERROR_NOT_SUPPORTED;
3973
3974#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3975 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3976 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3977}
3978
3979psa_status_t mbedtls_psa_verify_hash_abort(
3980 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3981{
3982
3983#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3984 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3985 defined(MBEDTLS_ECP_RESTARTABLE)
3986
3987 if (operation->ctx) {
3988 mbedtls_ecdsa_free(operation->ctx);
3989 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003990 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003991 }
3992
3993 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3994
Paul Elliott93d9ca82023-02-15 18:14:21 +00003995 operation->num_ops = 0;
3996
Paul Elliott588f8ed2022-12-02 18:10:26 +00003997 mbedtls_mpi_free(&operation->r);
3998 mbedtls_mpi_free(&operation->s);
3999
4000 return PSA_SUCCESS;
4001
4002#else
4003 (void) operation;
4004
4005 return PSA_ERROR_NOT_SUPPORTED;
4006
4007#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4008 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4009 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4010}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004011
mohammad1603503973b2018-03-12 15:59:30 +02004012/****************************************************************/
4013/* Symmetric cryptography */
4014/****************************************************************/
4015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4017 mbedtls_svc_key_id_t key,
4018 psa_algorithm_t alg,
4019 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004020{
4021 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4022 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004023 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4025 PSA_KEY_USAGE_ENCRYPT :
4026 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02004027
4028 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004030 status = PSA_ERROR_BAD_STATE;
4031 goto exit;
4032 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004035 status = PSA_ERROR_INVALID_ARGUMENT;
4036 goto exit;
4037 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004038
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4040 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004041 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004043
Ronald Cron49fafa92021-03-10 08:34:23 +01004044 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004045 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004046 * so we only set it (in the driver wrapper) after resources have been
4047 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004048 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004050 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004052 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 }
4054 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004055
Ronald Crona4af55f2020-12-14 14:36:06 +01004056 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004058 };
4059
Ronald Cronab99ac22020-10-01 16:38:28 +02004060 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (cipher_operation == MBEDTLS_ENCRYPT) {
4062 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4063 &attributes,
4064 slot->key.data,
4065 slot->key.bytes,
4066 alg);
4067 } else {
4068 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4069 &attributes,
4070 slot->key.data,
4071 slot->key.bytes,
4072 alg);
4073 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004074
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004075exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 if (status != PSA_SUCCESS) {
4077 psa_cipher_abort(operation);
4078 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004079
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004083}
4084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4086 mbedtls_svc_key_id_t key,
4087 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004088{
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004090}
4091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4093 mbedtls_svc_key_id_t key,
4094 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004095{
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004097}
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4100 uint8_t *iv,
4101 size_t iv_size,
4102 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004103{
Ronald Cron6d051732020-10-01 14:10:20 +02004104 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004105 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4106 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01004107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004109 status = PSA_ERROR_BAD_STATE;
4110 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004111 }
4112
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004114 status = PSA_ERROR_BAD_STATE;
4115 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004116 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004117
Ronald Cron2fb90522021-07-05 12:31:44 +02004118 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004120 status = PSA_ERROR_BUFFER_TOO_SMALL;
4121 goto exit;
4122 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004125 status = PSA_ERROR_GENERIC_ERROR;
4126 goto exit;
4127 }
4128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 status = psa_generate_random(local_iv, default_iv_length);
4130 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004131 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 }
Ronald Cron5618a392021-03-26 09:52:26 +01004133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 status = psa_driver_wrapper_cipher_set_iv(operation,
4135 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004136
4137exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (status == PSA_SUCCESS) {
4139 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004140 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004141 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004143 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004145 }
Ronald Cron6d051732020-10-01 14:10:20 +02004146
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004148}
4149
Gilles Peskine449bd832023-01-11 14:50:10 +01004150psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4151 const uint8_t *iv,
4152 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004153{
Ronald Cron6d051732020-10-01 14:10:20 +02004154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004155
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004157 status = PSA_ERROR_BAD_STATE;
4158 goto exit;
4159 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004162 status = PSA_ERROR_BAD_STATE;
4163 goto exit;
4164 }
Ronald Crona0d68172021-03-26 10:15:08 +01004165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004167 status = PSA_ERROR_INVALID_ARGUMENT;
4168 goto exit;
4169 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004170
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 status = psa_driver_wrapper_cipher_set_iv(operation,
4172 iv,
4173 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004174
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004175exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004177 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 } else {
4179 psa_cipher_abort(operation);
4180 }
4181 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004182}
4183
Gilles Peskine449bd832023-01-11 14:50:10 +01004184psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4185 const uint8_t *input,
4186 size_t input_length,
4187 uint8_t *output,
4188 size_t output_size,
4189 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004190{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004191 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004194 status = PSA_ERROR_BAD_STATE;
4195 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004196 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004199 status = PSA_ERROR_BAD_STATE;
4200 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004201 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004202
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 status = psa_driver_wrapper_cipher_update(operation,
4204 input,
4205 input_length,
4206 output,
4207 output_size,
4208 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004209
4210exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 if (status != PSA_SUCCESS) {
4212 psa_cipher_abort(operation);
4213 }
Ronald Cron6d051732020-10-01 14:10:20 +02004214
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004216}
4217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4219 uint8_t *output,
4220 size_t output_size,
4221 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004222{
David Saadab4ecc272019-02-14 13:48:10 +02004223 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004226 status = PSA_ERROR_BAD_STATE;
4227 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004228 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004229
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004231 status = PSA_ERROR_BAD_STATE;
4232 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004233 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004234
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 status = psa_driver_wrapper_cipher_finish(operation,
4236 output,
4237 output_size,
4238 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004239
4240exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 if (status == PSA_SUCCESS) {
4242 return psa_cipher_abort(operation);
4243 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004244 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004246
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004248 }
mohammad1603503973b2018-03-12 15:59:30 +02004249}
4250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004252{
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004254 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004255 * in use. It's ok to call abort on such an object, and there's
4256 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004258 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004261
Ronald Cron49fafa92021-03-10 08:34:23 +01004262 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004263 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004264 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004265
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004267}
4268
Gilles Peskine449bd832023-01-11 14:50:10 +01004269psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4270 psa_algorithm_t alg,
4271 const uint8_t *input,
4272 size_t input_length,
4273 uint8_t *output,
4274 size_t output_size,
4275 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004276{
4277 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004278 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004279 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004280 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4281 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004284 status = PSA_ERROR_INVALID_ARGUMENT;
4285 goto exit;
4286 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4289 PSA_KEY_USAGE_ENCRYPT,
4290 alg);
4291 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004292 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004294
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004295 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004297 };
4298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4300 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004301 status = PSA_ERROR_GENERIC_ERROR;
4302 goto exit;
4303 }
4304
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (default_iv_length > 0) {
4306 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004307 status = PSA_ERROR_BUFFER_TOO_SMALL;
4308 goto exit;
4309 }
4310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 status = psa_generate_random(local_iv, default_iv_length);
4312 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004315 }
4316
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004317 status = psa_driver_wrapper_cipher_encrypt(
4318 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004319 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004320 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004322
4323exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 unlock_status = psa_unlock_key_slot(slot);
4325 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004326 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004327 }
Ronald Cron23919522021-07-08 19:00:07 +02004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 if (status == PSA_SUCCESS) {
4330 if (default_iv_length > 0) {
4331 memcpy(output, local_iv, default_iv_length);
4332 }
4333 *output_length += default_iv_length;
4334 } else {
4335 *output_length = 0;
4336 }
4337
4338 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004339}
4340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4342 psa_algorithm_t alg,
4343 const uint8_t *input,
4344 size_t input_length,
4345 uint8_t *output,
4346 size_t output_size,
4347 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004348{
4349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004350 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004351 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004354 status = PSA_ERROR_INVALID_ARGUMENT;
4355 goto exit;
4356 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4359 PSA_KEY_USAGE_DECRYPT,
4360 alg);
4361 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004362 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004364
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004365 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004367 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4370 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004371 status = PSA_ERROR_INVALID_ARGUMENT;
4372 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004374 status = PSA_ERROR_INVALID_ARGUMENT;
4375 goto exit;
4376 }
4377
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004378 status = psa_driver_wrapper_cipher_decrypt(
4379 &attributes, slot->key.data, slot->key.bytes,
4380 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004382
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004383exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 unlock_status = psa_unlock_key_slot(slot);
4385 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004386 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004390 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 }
Ronald Cron23919522021-07-08 19:00:07 +02004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004394}
4395
4396
mohammad16035955c982018-04-26 00:53:03 +03004397/****************************************************************/
4398/* AEAD */
4399/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004400
Paul Elliottbaff51c2021-09-28 17:44:45 +01004401/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004402static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004403{
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004405}
4406
4407/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4409 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004410{
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004414#if defined(PSA_WANT_ALG_GCM)
4415 case PSA_ALG_GCM:
4416 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 * arbitrarily large nonces. Please note that we do not generally
4418 * recommend the usage of nonces of greater length than
4419 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4420 * size, which can then lead to collisions if you encrypt a very
4421 * large number of messages.*/
4422 if (nonce_length != 0) {
4423 return PSA_SUCCESS;
4424 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004425 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004426#endif /* PSA_WANT_ALG_GCM */
4427#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004428 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 if (nonce_length >= 7 && nonce_length <= 13) {
4430 return PSA_SUCCESS;
4431 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004432 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004433#endif /* PSA_WANT_ALG_CCM */
4434#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004435 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if (nonce_length == 12) {
4437 return PSA_SUCCESS;
4438 } else if (nonce_length == 8) {
4439 return PSA_ERROR_NOT_SUPPORTED;
4440 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004441 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004442#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004443 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004444 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004446 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004449}
4450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004452{
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4454 return PSA_ERROR_INVALID_ARGUMENT;
4455 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004458}
4459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4461 psa_algorithm_t alg,
4462 const uint8_t *nonce,
4463 size_t nonce_length,
4464 const uint8_t *additional_data,
4465 size_t additional_data_length,
4466 const uint8_t *plaintext,
4467 size_t plaintext_length,
4468 uint8_t *ciphertext,
4469 size_t ciphertext_size,
4470 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004471{
Ronald Cron215633c2021-03-16 17:15:37 +01004472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4473 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004474
mohammad1603f08a5502018-06-03 15:05:47 +03004475 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 status = psa_aead_check_algorithm(alg);
4478 if (status != PSA_SUCCESS) {
4479 return status;
4480 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004481
Ronald Cron9a986162021-03-26 12:40:07 +01004482 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4484 if (status != PSA_SUCCESS) {
4485 return status;
4486 }
mohammad16035955c982018-04-26 00:53:03 +03004487
Ronald Cron215633c2021-03-16 17:15:37 +01004488 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004490 };
mohammad16035955c982018-04-26 00:53:03 +03004491
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 status = psa_aead_check_nonce_length(alg, nonce_length);
4493 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004494 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004496
Ronald Cronde822812021-03-17 16:08:20 +01004497 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004498 &attributes, slot->key.data, slot->key.bytes,
4499 alg,
4500 nonce, nonce_length,
4501 additional_data, additional_data_length,
4502 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4506 memset(ciphertext, 0, ciphertext_size);
4507 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004508
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004509exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004513}
4514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4516 psa_algorithm_t alg,
4517 const uint8_t *nonce,
4518 size_t nonce_length,
4519 const uint8_t *additional_data,
4520 size_t additional_data_length,
4521 const uint8_t *ciphertext,
4522 size_t ciphertext_length,
4523 uint8_t *plaintext,
4524 size_t plaintext_size,
4525 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004526{
Ronald Cron215633c2021-03-16 17:15:37 +01004527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4528 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004529
Gilles Peskineee652a32018-06-01 19:23:52 +02004530 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 status = psa_aead_check_algorithm(alg);
4533 if (status != PSA_SUCCESS) {
4534 return status;
4535 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004536
Ronald Cron9a986162021-03-26 12:40:07 +01004537 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4539 if (status != PSA_SUCCESS) {
4540 return status;
4541 }
mohammad16035955c982018-04-26 00:53:03 +03004542
Ronald Cron215633c2021-03-16 17:15:37 +01004543 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004545 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 status = psa_aead_check_nonce_length(alg, nonce_length);
4548 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004549 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004551
Ronald Cronde822812021-03-17 16:08:20 +01004552 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004553 &attributes, slot->key.data, slot->key.bytes,
4554 alg,
4555 nonce, nonce_length,
4556 additional_data, additional_data_length,
4557 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (status != PSA_SUCCESS && plaintext_size != 0) {
4561 memset(plaintext, 0, plaintext_size);
4562 }
mohammad160360a64d02018-06-03 17:20:42 +03004563
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004564exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 return status;
mohammad16035955c982018-04-26 00:53:03 +03004568}
4569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4571{
4572 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004573
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004575#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004577 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4579 return PSA_ERROR_INVALID_ARGUMENT;
4580 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004581 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004582#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004583
Przemek Stekiel86679c72022-10-06 17:06:56 +02004584#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004586 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4588 return PSA_ERROR_INVALID_ARGUMENT;
4589 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004590 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004591#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004592
Przemek Stekiel86679c72022-10-06 17:06:56 +02004593#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004595 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (tag_len != 16) {
4597 return PSA_ERROR_INVALID_ARGUMENT;
4598 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004599 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004600#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004601
4602 default:
4603 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004605 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004607}
4608
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004609/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004610static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4611 int is_encrypt,
4612 mbedtls_svc_key_id_t key,
4613 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004614{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4616 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4617 psa_key_slot_t *slot = NULL;
4618 psa_key_usage_t key_usage = 0;
4619
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 status = psa_aead_check_algorithm(alg);
4621 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004622 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004626 status = PSA_ERROR_BAD_STATE;
4627 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004628 }
4629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 if (operation->nonce_set || operation->lengths_set ||
4631 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004632 status = PSA_ERROR_BAD_STATE;
4633 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004634 }
4635
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004637 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004639 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4643 alg);
4644 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004645 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004647
4648 psa_key_attributes_t attributes = {
4649 .core = slot->attr
4650 };
4651
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004653 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004655
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 if (is_encrypt) {
4657 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4658 &attributes,
4659 slot->key.data,
4660 slot->key.bytes,
4661 alg);
4662 } else {
4663 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4664 &attributes,
4665 slot->key.data,
4666 slot->key.bytes,
4667 alg);
4668 }
4669 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004670 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004674
4675exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004679 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004681 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 } else {
4683 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004684 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004687}
4688
Paul Elliott302ff6b2021-04-20 18:10:30 +01004689/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004690psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4691 mbedtls_svc_key_id_t key,
4692 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004693{
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004695}
4696
4697/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004698psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4699 mbedtls_svc_key_id_t key,
4700 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004701{
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004703}
4704
4705/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4707 uint8_t *nonce,
4708 size_t nonce_size,
4709 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004710{
4711 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004712 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01004713 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004714
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004715 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004718 status = PSA_ERROR_BAD_STATE;
4719 goto exit;
4720 }
4721
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004723 status = PSA_ERROR_BAD_STATE;
4724 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004725 }
4726
Paul Elliotte193ea82021-10-01 13:00:16 +01004727 /* For CCM, this size may not be correct according to the PSA
4728 * specification. The PSA Crypto 1.0.1 specification states:
4729 *
4730 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4731 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4732 *
4733 * However this restriction that L has to be the smallest integer is not
4734 * applied in practice, and it is not implementable here since the
4735 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4737 operation->alg);
4738 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004739 status = PSA_ERROR_BUFFER_TOO_SMALL;
4740 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004741 }
4742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 status = psa_generate_random(local_nonce, required_nonce_size);
4744 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004745 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004747
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004749
Paul Elliott39dc6b82021-05-11 19:16:09 +01004750exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (status == PSA_SUCCESS) {
4752 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004753 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 } else {
4755 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004756 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004759}
4760
4761/* Set the nonce for a multipart authenticated encryption or decryption
4762 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004763psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4764 const uint8_t *nonce,
4765 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004766{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004767 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004770 status = PSA_ERROR_BAD_STATE;
4771 goto exit;
4772 }
4773
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004775 status = PSA_ERROR_BAD_STATE;
4776 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004777 }
4778
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4780 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004781 status = PSA_ERROR_INVALID_ARGUMENT;
4782 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004783 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004784
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4786 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004787
Paul Elliott39dc6b82021-05-11 19:16:09 +01004788exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004790 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 } else {
4792 psa_aead_abort(operation);
4793 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004794
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004796}
4797
4798/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004799psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4800 size_t ad_length,
4801 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004802{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004803 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4804
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004806 status = PSA_ERROR_BAD_STATE;
4807 goto exit;
4808 }
4809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (operation->lengths_set || operation->ad_started ||
4811 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004812 status = PSA_ERROR_BAD_STATE;
4813 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004814 }
4815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004817#if defined(PSA_WANT_ALG_GCM)
4818 case PSA_ALG_GCM:
4819 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 * bits. Without the guard this code will generate warnings on 32bit
4821 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004822#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (((uint64_t) ad_length) >> 61 != 0 ||
4824 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004825 status = PSA_ERROR_INVALID_ARGUMENT;
4826 goto exit;
4827 }
Paul Elliott325d3742021-09-27 17:56:28 +01004828#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004829 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004830#endif /* PSA_WANT_ALG_GCM */
4831#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004832 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004834 status = PSA_ERROR_INVALID_ARGUMENT;
4835 goto exit;
4836 }
4837 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004838#endif /* PSA_WANT_ALG_CCM */
4839#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004840 case PSA_ALG_CHACHA20_POLY1305:
4841 /* No length restrictions for ChaChaPoly. */
4842 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004843#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004844 default:
4845 break;
4846 }
Paul Elliott325d3742021-09-27 17:56:28 +01004847
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4849 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004850
Paul Elliott39dc6b82021-05-11 19:16:09 +01004851exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004853 operation->ad_remaining = ad_length;
4854 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004855 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 } else {
4857 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004858 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004861}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004862
4863/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004864psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4865 const uint8_t *input,
4866 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004867{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004871 status = PSA_ERROR_BAD_STATE;
4872 goto exit;
4873 }
4874
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004876 status = PSA_ERROR_BAD_STATE;
4877 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004878 }
4879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 if (operation->lengths_set) {
4881 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004882 status = PSA_ERROR_INVALID_ARGUMENT;
4883 goto exit;
4884 }
4885
4886 operation->ad_remaining -= input_length;
4887 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004888#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004890 status = PSA_ERROR_BAD_STATE;
4891 goto exit;
4892 }
4893#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 status = psa_driver_wrapper_aead_update_ad(operation, input,
4896 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004897
Paul Elliott39dc6b82021-05-11 19:16:09 +01004898exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004900 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 } else {
4902 psa_aead_abort(operation);
4903 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004906}
4907
4908/* Encrypt or decrypt a message fragment in an active multipart AEAD
4909 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004910psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4911 const uint8_t *input,
4912 size_t input_length,
4913 uint8_t *output,
4914 size_t output_size,
4915 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004916{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004917 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004918
4919 *output_length = 0;
4920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004922 status = PSA_ERROR_BAD_STATE;
4923 goto exit;
4924 }
4925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004927 status = PSA_ERROR_BAD_STATE;
4928 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004929 }
4930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004932 /* Additional data length was supplied, but not all the additional
4933 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004935 status = PSA_ERROR_INVALID_ARGUMENT;
4936 goto exit;
4937 }
4938
4939 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004941 status = PSA_ERROR_INVALID_ARGUMENT;
4942 goto exit;
4943 }
4944
4945 operation->body_remaining -= input_length;
4946 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004947#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004949 status = PSA_ERROR_BAD_STATE;
4950 goto exit;
4951 }
4952#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4955 output, output_size,
4956 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004957
Paul Elliott39dc6b82021-05-11 19:16:09 +01004958exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004960 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 } else {
4962 psa_aead_abort(operation);
4963 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004964
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004966}
4967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004969{
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if (operation->id == 0 || !operation->nonce_set) {
4971 return PSA_ERROR_BAD_STATE;
4972 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4975 operation->body_remaining != 0)) {
4976 return PSA_ERROR_INVALID_ARGUMENT;
4977 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004980}
4981
Paul Elliott302ff6b2021-04-20 18:10:30 +01004982/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004983psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4984 uint8_t *ciphertext,
4985 size_t ciphertext_size,
4986 size_t *ciphertext_length,
4987 uint8_t *tag,
4988 size_t tag_size,
4989 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004990{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004991 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4992
Paul Elliott302ff6b2021-04-20 18:10:30 +01004993 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004994 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 status = psa_aead_final_checks(operation);
4997 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004998 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005000
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005002 status = PSA_ERROR_BAD_STATE;
5003 goto exit;
5004 }
5005
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5007 ciphertext_size,
5008 ciphertext_length,
5009 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005010
Paul Elliott39dc6b82021-05-11 19:16:09 +01005011exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005012
5013
Paul Elliottf47b0952021-05-21 18:02:33 +01005014 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005015 * the zero tag size, make sure the tag is set to something implausible.
5016 * Even if the operation succeeds, make sure we clear the rest of the
5017 * buffer to prevent potential leakage of anything previously placed in
5018 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005019 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005020
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005024}
5025
5026/* Finish authenticating and decrypting a message in a multipart AEAD
5027 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005028psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5029 uint8_t *plaintext,
5030 size_t plaintext_size,
5031 size_t *plaintext_length,
5032 const uint8_t *tag,
5033 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005034{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005035 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5036
Paul Elliott302ff6b2021-04-20 18:10:30 +01005037 *plaintext_length = 0;
5038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 status = psa_aead_final_checks(operation);
5040 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005041 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005043
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005045 status = PSA_ERROR_BAD_STATE;
5046 goto exit;
5047 }
5048
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5050 plaintext_size,
5051 plaintext_length,
5052 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005053
5054exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005056
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005058}
5059
5060/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005062{
5063 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005066 /* The object has (apparently) been initialized but it is not (yet)
5067 * in use. It's ok to call abort on such an object, and there's
5068 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005070 }
5071
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005073
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005075
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005077}
5078
Gilles Peskinee59236f2018-01-27 23:32:46 +01005079/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005080/* Generators */
5081/****************************************************************/
5082
Przemek Stekiel69c46792022-06-10 12:59:51 +02005083#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005084 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005085 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305086 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
5087 defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
John Durkop07cc04a2020-11-16 22:08:34 -08005088#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005089#endif /* At least one builtin KDF */
5090
Przemek Stekiel69c46792022-06-10 12:59:51 +02005091#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005092 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5093 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5094static psa_status_t psa_key_derivation_start_hmac(
5095 psa_mac_operation_t *operation,
5096 psa_algorithm_t hash_alg,
5097 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005099{
5100 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5101 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5103 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5104 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005105
Steven Cooreman72f736a2021-05-07 14:14:37 +02005106 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 status = psa_driver_wrapper_mac_sign_setup(operation,
5110 &attributes,
5111 hmac_key, hmac_key_length,
5112 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005113
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 psa_reset_key_attributes(&attributes);
5115 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005116}
5117#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005118
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005119#define HKDF_STATE_INIT 0 /* no input yet */
5120#define HKDF_STATE_STARTED 1 /* got salt */
5121#define HKDF_STATE_KEYED 2 /* got key */
5122#define HKDF_STATE_OUTPUT 3 /* output started */
5123
Gilles Peskinecbe66502019-05-16 16:59:18 +02005124static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005126{
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5128 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5129 } else {
5130 return operation->alg;
5131 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005132}
5133
Gilles Peskine449bd832023-01-11 14:50:10 +01005134psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005135{
5136 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5138 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005139 /* The object has (apparently) been initialized but it is not
5140 * in use. It's ok to call abort on such an object, and there's
5141 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005143#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5145 mbedtls_free(operation->ctx.hkdf.info);
5146 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5147 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005148#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005149#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5150 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5152 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5153 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5154 if (operation->ctx.tls12_prf.secret != NULL) {
5155 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
5156 operation->ctx.tls12_prf.secret_length);
5157 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooremana6df6042021-04-29 19:32:25 +02005158 }
5159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (operation->ctx.tls12_prf.seed != NULL) {
5161 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
5162 operation->ctx.tls12_prf.seed_length);
5163 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01005164 }
5165
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (operation->ctx.tls12_prf.label != NULL) {
5167 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
5168 operation->ctx.tls12_prf.label_length);
5169 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01005170 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005171#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 if (operation->ctx.tls12_prf.other_secret != NULL) {
5173 mbedtls_platform_zeroize(operation->ctx.tls12_prf.other_secret,
5174 operation->ctx.tls12_prf.other_secret_length);
5175 mbedtls_free(operation->ctx.tls12_prf.other_secret);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005176 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005177#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005178 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005179
5180 /* We leave the fields Ai and output_block to be erased safely by the
5181 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005183#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5184 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005185#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5187 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5188 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5189 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005190#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305191#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
5192 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305193 if (operation->ctx.pbkdf2.salt != NULL) {
5194 mbedtls_platform_zeroize(operation->ctx.pbkdf2.salt,
5195 operation->ctx.pbkdf2.salt_length);
5196 mbedtls_free(operation->ctx.pbkdf2.salt);
5197 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305198
5199 status = PSA_SUCCESS;
5200 } else
5201#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005202 {
5203 status = PSA_ERROR_BAD_STATE;
5204 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 mbedtls_platform_zeroize(operation, sizeof(*operation));
5206 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005207}
5208
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005209psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005211{
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005213 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005215 }
5216
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005217 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005219}
5220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5222 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005223{
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 if (operation->alg == 0) {
5225 return PSA_ERROR_BAD_STATE;
5226 }
5227 if (capacity > operation->capacity) {
5228 return PSA_ERROR_INVALID_ARGUMENT;
5229 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005230 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005232}
5233
Przemek Stekiel69c46792022-06-10 12:59:51 +02005234#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005235/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005236static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5237 psa_algorithm_t kdf_alg,
5238 uint8_t *output,
5239 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005240{
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5242 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005243 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005244 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005245#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005247#else
5248 const uint8_t last_block = 0xff;
5249#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if (hkdf->state < HKDF_STATE_KEYED ||
5252 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005253#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005255#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 )) {
5257 return PSA_ERROR_BAD_STATE;
5258 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005259 hkdf->state = HKDF_STATE_OUTPUT;
5260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005262 /* Copy what remains of the current block */
5263 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005265 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 }
5267 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005268 output += n;
5269 output_length -= n;
5270 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005272 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005274 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005275 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005276 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005277 * object was corrupted or if this function is called directly
5278 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 if (hkdf->block_number == last_block) {
5280 return PSA_ERROR_BAD_STATE;
5281 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005282
5283 /* We need a new block */
5284 ++hkdf->block_number;
5285 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5288 hash_alg,
5289 hkdf->prk,
5290 hash_length);
5291 if (status != PSA_SUCCESS) {
5292 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005293 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005294
5295 if (hkdf->block_number != 1) {
5296 status = psa_mac_update(&hkdf->hmac,
5297 hkdf->output_block,
5298 hash_length);
5299 if (status != PSA_SUCCESS) {
5300 return status;
5301 }
5302 }
5303 status = psa_mac_update(&hkdf->hmac,
5304 hkdf->info,
5305 hkdf->info_length);
5306 if (status != PSA_SUCCESS) {
5307 return status;
5308 }
5309 status = psa_mac_update(&hkdf->hmac,
5310 &hkdf->block_number, 1);
5311 if (status != PSA_SUCCESS) {
5312 return status;
5313 }
5314 status = psa_mac_sign_finish(&hkdf->hmac,
5315 hkdf->output_block,
5316 sizeof(hkdf->output_block),
5317 &hmac_output_length);
5318 if (status != PSA_SUCCESS) {
5319 return status;
5320 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005321 }
5322
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005324}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005325#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005326
John Durkop07cc04a2020-11-16 22:08:34 -08005327#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5328 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005329static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5330 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005332{
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5334 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005335 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5336 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005337 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005338
Janos Follath7742fee2019-06-17 12:58:10 +01005339 /* We can't be wanting more output after block 0xff, otherwise
5340 * the capacity check in psa_key_derivation_output_bytes() would have
5341 * prevented this call. It could happen only if the operation
5342 * object was corrupted or if this function is called directly
5343 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if (tls12_prf->block_number == 0xff) {
5345 return PSA_ERROR_CORRUPTION_DETECTED;
5346 }
Janos Follath7742fee2019-06-17 12:58:10 +01005347
5348 /* We need a new block */
5349 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005350 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005351
5352 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5353 *
5354 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5355 *
5356 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5357 * HMAC_hash(secret, A(2) + seed) +
5358 * HMAC_hash(secret, A(3) + seed) + ...
5359 *
5360 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005361 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005362 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005363 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005364 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005365 * is currently extracted as `output_block` and where i is
5366 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005367 */
5368
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 status = psa_key_derivation_start_hmac(&hmac,
5370 hash_alg,
5371 tls12_prf->secret,
5372 tls12_prf->secret_length);
5373 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005374 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005376
5377 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005379 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5380 * the variable seed and in this instance means it in the context of the
5381 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 status = psa_mac_update(&hmac,
5383 tls12_prf->label,
5384 tls12_prf->label_length);
5385 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005386 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 }
5388 status = psa_mac_update(&hmac,
5389 tls12_prf->seed,
5390 tls12_prf->seed_length);
5391 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005392 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 }
5394 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005395 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5397 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005398 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005400 }
5401
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 status = psa_mac_sign_finish(&hmac,
5403 tls12_prf->Ai, hash_length,
5404 &hmac_output_length);
5405 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005406 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 }
5408 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005409 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005411
5412 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 status = psa_key_derivation_start_hmac(&hmac,
5414 hash_alg,
5415 tls12_prf->secret,
5416 tls12_prf->secret_length);
5417 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005418 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 }
5420 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5421 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005422 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 }
5424 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5425 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005426 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 }
5428 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5429 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005430 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 }
5432 status = psa_mac_sign_finish(&hmac,
5433 tls12_prf->output_block, hash_length,
5434 &hmac_output_length);
5435 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005436 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005438
Janos Follath7742fee2019-06-17 12:58:10 +01005439
5440cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 cleanup_status = psa_mac_abort(&hmac);
5442 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005443 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005445
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005447}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005448
Janos Follath844eb0e2019-06-19 12:10:49 +01005449static psa_status_t psa_key_derivation_tls12_prf_read(
5450 psa_tls12_prf_key_derivation_t *tls12_prf,
5451 psa_algorithm_t alg,
5452 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005454{
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5456 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005457 psa_status_t status;
5458 uint8_t offset, length;
5459
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005461 case PSA_TLS12_PRF_STATE_LABEL_SET:
5462 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5463 break;
5464 case PSA_TLS12_PRF_STATE_OUTPUT:
5465 break;
5466 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005468 }
5469
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005471 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 if (tls12_prf->left_in_block == 0) {
5473 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5474 alg);
5475 if (status != PSA_SUCCESS) {
5476 return status;
5477 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005478
5479 continue;
5480 }
5481
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005483 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005485 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005487
5488 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005490 output += length;
5491 output_length -= length;
5492 tls12_prf->left_in_block -= length;
5493 }
5494
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005496}
John Durkop07cc04a2020-11-16 22:08:34 -08005497#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5498 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005499
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005500#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5501static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5502 psa_tls12_ecjpake_to_pms_t *ecjpake,
5503 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005505{
5506 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005507 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (output_length != 32) {
5510 return PSA_ERROR_INVALID_ARGUMENT;
5511 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5514 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5515 &output_size);
5516 if (status != PSA_SUCCESS) {
5517 return status;
5518 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (output_size != output_length) {
5521 return PSA_ERROR_GENERIC_ERROR;
5522 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005523
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005525}
5526#endif
5527
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305528#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
5529static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5530 psa_pbkdf2_key_derivation_t *pbkdf2,
5531 psa_algorithm_t prf_alg,
5532 uint8_t prf_output_length,
5533 psa_key_attributes_t *attributes)
5534{
5535 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305536 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305537 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305538 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305539 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305540 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305541 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305542
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305543 mac_operation.is_sign = 1;
5544 mac_operation.mac_size = prf_output_length;
5545 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305546
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305547 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5548 attributes,
5549 pbkdf2->password,
5550 pbkdf2->password_length,
5551 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305552 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305553 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305554 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305555 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5556 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305557 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305558 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305559 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305560 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305561 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305562 }
5563 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5564 &mac_output_length);
5565 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305566 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305567 }
5568
5569 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305570 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305571 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305572 }
5573
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305574 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305575
5576 for (i = 1; i < pbkdf2->input_cost; i++) {
5577 status = psa_driver_wrapper_mac_compute(attributes,
5578 pbkdf2->password,
5579 pbkdf2->password_length,
5580 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305581 U_i, sizeof(U_i),
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305582 &mac_output_length);
5583 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305584 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305585 }
5586
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305587 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305588 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305589
5590cleanup:
5591 /* Zeroise buffers to clear sensitive data from memory. */
5592 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5593 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305594}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305595
5596static psa_status_t psa_key_derivation_pbkdf2_read(
5597 psa_pbkdf2_key_derivation_t *pbkdf2,
5598 psa_algorithm_t kdf_alg,
5599 uint8_t *output,
5600 size_t output_length)
5601{
5602 psa_status_t status;
5603 psa_algorithm_t prf_alg;
5604 uint8_t prf_output_length;
5605 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5606 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5607 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5608
5609 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5610 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5611 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5612 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305613 } else {
5614 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305615 }
5616
5617 switch (pbkdf2->state) {
5618 case PSA_PBKDF2_STATE_PASSWORD_SET:
5619 /* Initially we need a new block so bytes_used is equal to block size*/
5620 pbkdf2->bytes_used = prf_output_length;
5621 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5622 break;
5623 case PSA_PBKDF2_STATE_OUTPUT:
5624 break;
5625 default:
5626 return PSA_ERROR_BAD_STATE;
5627 }
5628
5629 while (output_length != 0) {
5630 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5631 if (n > output_length) {
5632 n = (uint8_t) output_length;
5633 }
5634 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5635 output += n;
5636 output_length -= n;
5637 pbkdf2->bytes_used += n;
5638
5639 if (output_length == 0) {
5640 break;
5641 }
5642
5643 /* We need a new block */
5644 pbkdf2->bytes_used = 0;
5645 pbkdf2->block_number++;
5646
5647 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5648 prf_output_length,
5649 &attributes);
5650 if (status != PSA_SUCCESS) {
5651 return status;
5652 }
5653 }
5654
5655 return PSA_SUCCESS;
5656}
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305657#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
5658
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005659psa_status_t psa_key_derivation_output_bytes(
5660 psa_key_derivation_operation_t *operation,
5661 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005663{
5664 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005666
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005668 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005670 }
5671
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005673 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005674 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005675 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005676 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005677 goto exit;
5678 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005680 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005681 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005682 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5683 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005684 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005685 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005687 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005688 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005689
Przemek Stekiel69c46792022-06-10 12:59:51 +02005690#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5692 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5693 output, output_length);
5694 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005695#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005696#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5697 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5699 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5700 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5701 kdf_alg, output,
5702 output_length);
5703 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005704#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5705 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005706#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005708 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5710 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005711#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305712#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
5713 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305714 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5715 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305716 } else
5717#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005718
Gilles Peskineeab56e42018-07-12 17:12:33 +02005719 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005720 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005722 }
5723
5724exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005726 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005727 * This allows us to differentiate between exhausted operations and
5728 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5729 * operations. */
5730 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005732 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005734 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005736}
5737
David Brown7807bf72021-02-09 16:28:23 -07005738#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005739static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005740{
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 if (data_size >= 8) {
5742 mbedtls_des_key_set_parity(data);
5743 }
5744 if (data_size >= 16) {
5745 mbedtls_des_key_set_parity(data + 8);
5746 }
5747 if (data_size >= 24) {
5748 mbedtls_des_key_set_parity(data + 16);
5749 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005750}
David Brown7807bf72021-02-09 16:28:23 -07005751#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005752
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005753/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 * ECC keys on a Weierstrass elliptic curve require the generation
5755 * of a private key which is an integer
5756 * in the range [1, N - 1], where N is the boundary of the private key domain:
5757 * N is the prime p for Diffie-Hellman, or the order of the
5758 * curve’s base point for ECC.
5759 *
5760 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5761 * This function generates the private key using the following process:
5762 *
5763 * 1. Draw a byte string of length ceiling(m/8) bytes.
5764 * 2. If m is not a multiple of 8, set the most significant
5765 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5766 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5767 * 4. If k > N - 2, discard the result and return to step 1.
5768 * 5. Output k + 1 as the private key.
5769 *
5770 * This method allows compliance to NIST standards, specifically the methods titled
5771 * Key-Pair Generation by Testing Candidates in the following publications:
5772 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5773 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5774 * Diffie-Hellman keys.
5775 *
5776 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5777 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5778 *
5779 * Note: Function allocates memory for *data buffer, so given *data should be
5780 * always NULL.
5781 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005782#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5783#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005784static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005785 psa_key_slot_t *slot,
5786 size_t bits,
5787 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005788 uint8_t **data
5789 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005790{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005791 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005792 mbedtls_mpi k;
5793 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005794 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005796
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 mbedtls_mpi_init(&k);
5798 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005799
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005800 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005802 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005804
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005806 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005807 goto cleanup;
5808 }
5809
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005810 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005812
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005814
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005815 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005816 /* Let m be the bit size of N. */
5817 size_t m = ecp_group.nbits;
5818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 size_t m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005820
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005821 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005823
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005824 /* Note: This function is always called with *data == NULL and it
5825 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 *data = mbedtls_calloc(1, m_bytes);
5827 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005828 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005829 goto cleanup;
5830 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005831
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005833 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005835 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005837
5838 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005840 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005841 * (8 * ceiling(m/8) - m) bits of the first byte in
5842 * the string to zero.
5843 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005845 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005846 }
5847
5848 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 * big-endian byte string.
5850 */
5851 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005852
5853 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 * Result of comparison is returned. When it indicates error
5855 * then this function is called again.
5856 */
5857 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005858 }
5859
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005860 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5862 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005863cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if (ret != 0) {
5865 status = mbedtls_to_psa_error(ret);
5866 }
5867 if (status != PSA_SUCCESS) {
5868 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005869 *data = NULL;
5870 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 mbedtls_mpi_free(&k);
5872 mbedtls_mpi_free(&diff_N_2);
5873 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005874}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005875
5876/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5877 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5878 *
5879 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5880 * draw a 32-byte string and process it as specified in
5881 * Elliptic Curves for Security [RFC7748] §5.
5882 *
5883 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5884 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5885 *
5886 * Note: Function allocates memory for *data buffer, so given *data should be
5887 * always NULL.
5888 */
5889
5890static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5891 size_t bits,
5892 psa_key_derivation_operation_t *operation,
5893 uint8_t **data
5894 )
5895{
5896 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005897 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005898
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005900 case 255:
5901 output_length = 32;
5902 break;
5903 case 448:
5904 output_length = 56;
5905 break;
5906 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005908 break;
5909 }
5910
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005912
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 if (*data == NULL) {
5914 return PSA_ERROR_INSUFFICIENT_MEMORY;
5915 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005916
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005920 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005922
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005924 case 255:
5925 (*data)[0] &= 248;
5926 (*data)[31] &= 127;
5927 (*data)[31] |= 64;
5928 break;
5929 case 448:
5930 (*data)[0] &= 252;
5931 (*data)[55] |= 128;
5932 break;
5933 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005935 break;
5936 }
5937
5938 return status;
5939}
Valerio Setti86587ab2023-06-27 13:09:30 +02005940#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5941static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5942 psa_key_slot_t *slot, size_t bits,
5943 psa_key_derivation_operation_t *operation, uint8_t **data)
5944{
5945 (void) slot;
5946 (void) bits;
5947 (void) operation;
5948 (void) data;
5949 return PSA_ERROR_NOT_SUPPORTED;
5950}
5951
5952static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5953 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5954{
5955 (void) bits;
5956 (void) operation;
5957 (void) data;
5958 return PSA_ERROR_NOT_SUPPORTED;
5959}
5960#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5961#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005962
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005963static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005964 psa_key_slot_t *slot,
5965 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005967{
5968 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305970 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005971 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5974 return PSA_ERROR_INVALID_ARGUMENT;
5975 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005976
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005977#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005978 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5980 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5981 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005982 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5984 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005985 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 }
5987 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005988 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5990 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005991 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005993 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005994 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005995#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005996 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 if (key_type_is_raw_bytes(slot->attr.type)) {
5998 if (bits % 8 != 0) {
5999 return PSA_ERROR_INVALID_ARGUMENT;
6000 }
6001 data = mbedtls_calloc(1, bytes);
6002 if (data == NULL) {
6003 return PSA_ERROR_INSUFFICIENT_MEMORY;
6004 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 status = psa_key_derivation_output_bytes(operation, data, bytes);
6007 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006008 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 }
David Brown12ca5032021-02-11 11:02:00 -07006010#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6012 psa_des_set_key_parity(data, bytes);
6013 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006014#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 } else {
6016 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006017 }
Ronald Crondd04d422020-11-28 15:14:42 +01006018
Ronald Cronbf33c932020-11-28 18:06:53 +01006019 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006020 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006022 };
6023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6025 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6026 &storage_size);
6027 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306028 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 }
Archanad8a83dc2021-06-14 10:04:16 +05306030 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 status = psa_allocate_buffer_to_slot(slot, storage_size);
6032 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306033 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 }
Archanad8a83dc2021-06-14 10:04:16 +05306035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 status = psa_driver_wrapper_import_key(&attributes,
6037 data, bytes,
6038 slot->key.data,
6039 slot->key.bytes,
6040 &slot->key.bytes, &bits);
6041 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006042 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006044
6045exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 mbedtls_free(data);
6047 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006048}
6049
Gilles Peskine449bd832023-01-11 14:50:10 +01006050psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6051 psa_key_derivation_operation_t *operation,
6052 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006053{
6054 psa_status_t status;
6055 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006056 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006057
Ronald Cron81709fc2020-11-14 12:10:32 +01006058 *key = MBEDTLS_SVC_KEY_ID_INIT;
6059
Gilles Peskine0f84d622019-09-12 19:03:13 +02006060 /* Reject any attempt to create a zero-length key so that we don't
6061 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 if (psa_get_key_bits(attributes) == 0) {
6063 return PSA_ERROR_INVALID_ARGUMENT;
6064 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (operation->alg == PSA_ALG_NONE) {
6067 return PSA_ERROR_BAD_STATE;
6068 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 if (!operation->can_output_key) {
6071 return PSA_ERROR_NOT_PERMITTED;
6072 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6075 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006076#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006078 /* Deriving a key in a secure element is not implemented yet. */
6079 status = PSA_ERROR_NOT_SUPPORTED;
6080 }
6081#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (status == PSA_SUCCESS) {
6083 status = psa_generate_derived_key_internal(slot,
6084 attributes->core.bits,
6085 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006086 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (status == PSA_SUCCESS) {
6088 status = psa_finish_key_creation(slot, driver, key);
6089 }
6090 if (status != PSA_SUCCESS) {
6091 psa_fail_key_creation(slot, driver);
6092 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006093
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006095}
6096
Gilles Peskineeab56e42018-07-12 17:12:33 +02006097
6098
6099/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006100/* Key derivation */
6101/****************************************************************/
6102
Steven Cooreman932ffb72021-02-15 12:14:32 +01006103#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006104static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006105{
6106#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6108 return 1;
6109 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006110#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006111#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6113 return 1;
6114 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006115#endif
6116#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6118 return 1;
6119 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006120#endif
6121#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6123 return 1;
6124 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006125#endif
6126#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6128 return 1;
6129 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006130#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006131#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6133 return 1;
6134 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006135#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306136#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6137 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6138 return 1;
6139 }
6140#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006142}
6143
Gilles Peskine449bd832023-01-11 14:50:10 +01006144static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006145{
6146 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 psa_status_t status = psa_hash_setup(&operation, alg);
6148 psa_hash_abort(&operation);
6149 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006150}
6151
Gilles Peskine969c5d62019-01-16 15:53:06 +01006152static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006153 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006155{
Janos Follath5fe19732019-06-20 15:09:30 +01006156 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6157 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006159
Gilles Peskine969c5d62019-01-16 15:53:06 +01006160 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 if (!is_kdf_alg_supported(kdf_alg)) {
6162 return PSA_ERROR_NOT_SUPPORTED;
6163 }
John Durkop07cc04a2020-11-16 22:08:34 -08006164
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006165 /* All currently supported key derivation algorithms (apart from
Andrzej Kurek702776f2022-09-16 06:22:44 -04006166 * ecjpake to pms) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6168 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
6169 if (kdf_alg != PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6170 if (hash_size == 0) {
6171 return PSA_ERROR_NOT_SUPPORTED;
6172 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006173
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006174 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6175 * we might fail later, which is somewhat unfriendly and potentially
6176 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 psa_status_t status = psa_hash_try_support(hash_alg);
6178 if (status != PSA_SUCCESS) {
6179 return status;
6180 }
6181 } else {
6182 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006183 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006184
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6186 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6187 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6188 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006189 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006190#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006191 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6193 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006194 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006196#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6197 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 operation->capacity = 255 * hash_size;
6199 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006200}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006203{
6204#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 if (alg == PSA_ALG_ECDH) {
6206 return PSA_SUCCESS;
6207 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006208#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006209#if defined(PSA_WANT_ALG_FFDH)
6210 if (alg == PSA_ALG_FFDH) {
6211 return PSA_SUCCESS;
6212 }
6213#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006214 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006216}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006217
6218static int psa_key_derivation_allows_free_form_secret_input(
6219 psa_algorithm_t kdf_alg)
6220{
6221#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6222 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6223 return 0;
6224 }
6225#endif
6226 (void) kdf_alg;
6227 return 1;
6228}
John Durkop07cc04a2020-11-16 22:08:34 -08006229#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006230
Gilles Peskine449bd832023-01-11 14:50:10 +01006231psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6232 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006233{
6234 psa_status_t status;
6235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 if (operation->alg != 0) {
6237 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006238 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6241 return PSA_ERROR_INVALID_ARGUMENT;
6242 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6243#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6244 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6245 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6246 status = psa_key_agreement_try_support(ka_alg);
6247 if (status != PSA_SUCCESS) {
6248 return status;
6249 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006250 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6251 return PSA_ERROR_INVALID_ARGUMENT;
6252 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6254#else
6255 return PSA_ERROR_NOT_SUPPORTED;
6256#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6257 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6258#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6259 status = psa_key_derivation_setup_kdf(operation, alg);
6260#else
6261 return PSA_ERROR_NOT_SUPPORTED;
6262#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6263 } else {
6264 return PSA_ERROR_INVALID_ARGUMENT;
6265 }
6266
6267 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006268 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 }
6270 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006271}
6272
Przemek Stekiel69c46792022-06-10 12:59:51 +02006273#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006274static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6275 psa_algorithm_t kdf_alg,
6276 psa_key_derivation_step_t step,
6277 const uint8_t *data,
6278 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006279{
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006281 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006283 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006284#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6286 return PSA_ERROR_INVALID_ARGUMENT;
6287 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006288#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 if (hkdf->state != HKDF_STATE_INIT) {
6290 return PSA_ERROR_BAD_STATE;
6291 } else {
6292 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6293 hash_alg,
6294 data, data_length);
6295 if (status != PSA_SUCCESS) {
6296 return status;
6297 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006298 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006300 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006301 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006302#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006304 /* We shouldn't be in different state as HKDF_EXPAND only allows
6305 * two inputs: SECRET (this case) and INFO which does not modify
6306 * the state. It could happen only if the hkdf
6307 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 if (hkdf->state != HKDF_STATE_INIT) {
6309 return PSA_ERROR_BAD_STATE;
6310 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006311
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006312 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6314 return PSA_ERROR_INVALID_ARGUMENT;
6315 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006316
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 memcpy(hkdf->prk, data, data_length);
6318 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006319#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006320 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006321 /* HKDF: If no salt was provided, use an empty salt.
6322 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006324#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6326 return PSA_ERROR_BAD_STATE;
6327 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006328#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6330 hash_alg,
6331 NULL, 0);
6332 if (status != PSA_SUCCESS) {
6333 return status;
6334 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006335 hkdf->state = HKDF_STATE_STARTED;
6336 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 if (hkdf->state != HKDF_STATE_STARTED) {
6338 return PSA_ERROR_BAD_STATE;
6339 }
6340 status = psa_mac_update(&hkdf->hmac,
6341 data, data_length);
6342 if (status != PSA_SUCCESS) {
6343 return status;
6344 }
6345 status = psa_mac_sign_finish(&hkdf->hmac,
6346 hkdf->prk,
6347 sizeof(hkdf->prk),
6348 &data_length);
6349 if (status != PSA_SUCCESS) {
6350 return status;
6351 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006352 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006353
Gilles Peskine2b522db2019-04-12 15:11:49 +02006354 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006355 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006356#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006358 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006360 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006362#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006363 {
6364 /* Block 0 is empty, and the next block will be
6365 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006367 }
6368
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006370 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006371#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6373 return PSA_ERROR_INVALID_ARGUMENT;
6374 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006375#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006376#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6378 hkdf->state == HKDF_STATE_INIT) {
6379 return PSA_ERROR_BAD_STATE;
6380 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006381#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (hkdf->state == HKDF_STATE_OUTPUT) {
6383 return PSA_ERROR_BAD_STATE;
6384 }
6385 if (hkdf->info_set) {
6386 return PSA_ERROR_BAD_STATE;
6387 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006388 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (data_length != 0) {
6390 hkdf->info = mbedtls_calloc(1, data_length);
6391 if (hkdf->info == NULL) {
6392 return PSA_ERROR_INSUFFICIENT_MEMORY;
6393 }
6394 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006395 }
6396 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006398 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006400 }
6401}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006402#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006403
John Durkop07cc04a2020-11-16 22:08:34 -08006404#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6405 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006406static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6407 const uint8_t *data,
6408 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006409{
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6411 return PSA_ERROR_BAD_STATE;
6412 }
Janos Follathf08e2652019-06-13 09:05:41 +01006413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 if (data_length != 0) {
6415 prf->seed = mbedtls_calloc(1, data_length);
6416 if (prf->seed == NULL) {
6417 return PSA_ERROR_INSUFFICIENT_MEMORY;
6418 }
Janos Follathf08e2652019-06-13 09:05:41 +01006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006421 prf->seed_length = data_length;
6422 }
Janos Follathf08e2652019-06-13 09:05:41 +01006423
Gilles Peskine43f958b2020-12-13 14:55:14 +01006424 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006427}
6428
Gilles Peskine449bd832023-01-11 14:50:10 +01006429static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6430 const uint8_t *data,
6431 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006432{
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6434 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6435 return PSA_ERROR_BAD_STATE;
6436 }
Janos Follath81550542019-06-13 14:26:34 +01006437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (data_length != 0) {
6439 prf->secret = mbedtls_calloc(1, data_length);
6440 if (prf->secret == NULL) {
6441 return PSA_ERROR_INSUFFICIENT_MEMORY;
6442 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006445 prf->secret_length = data_length;
6446 }
Janos Follath81550542019-06-13 14:26:34 +01006447
Gilles Peskine43f958b2020-12-13 14:55:14 +01006448 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006451}
6452
Gilles Peskine449bd832023-01-11 14:50:10 +01006453static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6454 const uint8_t *data,
6455 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006456{
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6458 return PSA_ERROR_BAD_STATE;
6459 }
Janos Follath63028dd2019-06-13 09:15:47 +01006460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 if (data_length != 0) {
6462 prf->label = mbedtls_calloc(1, data_length);
6463 if (prf->label == NULL) {
6464 return PSA_ERROR_INSUFFICIENT_MEMORY;
6465 }
Janos Follath63028dd2019-06-13 09:15:47 +01006466
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006468 prf->label_length = data_length;
6469 }
Janos Follath63028dd2019-06-13 09:15:47 +01006470
Gilles Peskine43f958b2020-12-13 14:55:14 +01006471 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006472
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006474}
6475
Gilles Peskine449bd832023-01-11 14:50:10 +01006476static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6477 psa_key_derivation_step_t step,
6478 const uint8_t *data,
6479 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006480{
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006482 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006484 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006486 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006488 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006490 }
6491}
John Durkop07cc04a2020-11-16 22:08:34 -08006492#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6493 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6494
6495#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6496static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6497 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006498 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006500{
6501 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6503 4 + data_length + prf->other_secret_length :
6504 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006505
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6507 return PSA_ERROR_INVALID_ARGUMENT;
6508 }
John Durkop07cc04a2020-11-16 22:08:34 -08006509
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 uint8_t *pms = mbedtls_calloc(1, pms_len);
6511 if (pms == NULL) {
6512 return PSA_ERROR_INSUFFICIENT_MEMORY;
6513 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006514 uint8_t *cur = pms;
6515
6516 /* pure-PSK:
6517 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006518 *
6519 * The premaster secret is formed as follows: if the PSK is N octets
6520 * long, concatenate a uint16 with the value N, N zero octets, a second
6521 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006522 *
6523 * mixed-PSK:
6524 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6525 * follows: concatenate a uint16 with the length of the other secret,
6526 * the other secret itself, uint16 with the length of PSK, and the
6527 * PSK itself.
6528 * For details please check:
6529 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6530 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6531 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006532 */
6533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6535 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6536 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6537 if (prf->other_secret_length != 0) {
6538 memcpy(cur, prf->other_secret, prf->other_secret_length);
6539 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006540 cur += prf->other_secret_length;
6541 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 } else {
6543 *cur++ = MBEDTLS_BYTE_1(data_length);
6544 *cur++ = MBEDTLS_BYTE_0(data_length);
6545 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006546 cur += data_length;
6547 }
6548
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 *cur++ = MBEDTLS_BYTE_1(data_length);
6550 *cur++ = MBEDTLS_BYTE_0(data_length);
6551 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006552 cur += data_length;
6553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08006555
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 mbedtls_platform_zeroize(pms, pms_len);
6557 mbedtls_free(pms);
6558 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006559}
Janos Follath6660f0e2019-06-17 08:44:03 +01006560
Przemek Stekiele47201b2022-04-19 13:53:28 +02006561static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6562 psa_tls12_prf_key_derivation_t *prf,
6563 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006565{
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6567 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006568 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006569
6570 if (data_length != 0) {
6571 prf->other_secret = mbedtls_calloc(1, data_length);
6572 if (prf->other_secret == NULL) {
6573 return PSA_ERROR_INSUFFICIENT_MEMORY;
6574 }
6575
6576 memcpy(prf->other_secret, data, data_length);
6577 prf->other_secret_length = data_length;
6578 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006579 prf->other_secret_length = 0;
6580 }
6581
6582 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6583
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006585}
6586
Janos Follath6660f0e2019-06-17 08:44:03 +01006587static psa_status_t psa_tls12_prf_psk_to_ms_input(
6588 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006589 psa_key_derivation_step_t step,
6590 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006592{
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006594 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 return psa_tls12_prf_psk_to_ms_set_key(prf,
6596 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006597 break;
6598 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006599 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6600 data,
6601 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006602 break;
6603 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006605 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006606
Przemek Stekiele47201b2022-04-19 13:53:28 +02006607 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006608}
John Durkop07cc04a2020-11-16 22:08:34 -08006609#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006610
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006611#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6612static psa_status_t psa_tls12_ecjpake_to_pms_input(
6613 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006614 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006615 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006617{
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6619 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6620 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006621 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006622
6623 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 if (data[0] != 0x04) {
6625 return PSA_ERROR_INVALID_ARGUMENT;
6626 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006627
6628 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006630
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006632}
6633#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306634
6635#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6636static psa_status_t psa_pbkdf2_set_input_cost(
6637 psa_pbkdf2_key_derivation_t *pbkdf2,
6638 psa_key_derivation_step_t step,
6639 uint64_t data)
6640{
6641 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6642 return PSA_ERROR_INVALID_ARGUMENT;
6643 }
6644
6645 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6646 return PSA_ERROR_BAD_STATE;
6647 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306648
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306649 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306650 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306651 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306652
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306653 if (data == 0) {
6654 return PSA_ERROR_INVALID_ARGUMENT;
6655 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306656
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306657 pbkdf2->input_cost = data;
6658 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6659
6660 return PSA_SUCCESS;
6661}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306662
6663static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6664 const uint8_t *data,
6665 size_t data_length)
6666{
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306667 if (pbkdf2->state != PSA_PBKDF2_STATE_INPUT_COST_SET &&
6668 pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6669 return PSA_ERROR_BAD_STATE;
6670 }
6671
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306672 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6673 pbkdf2->salt = mbedtls_calloc(1, data_length);
6674 if (pbkdf2->salt == NULL) {
6675 return PSA_ERROR_INSUFFICIENT_MEMORY;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306676 }
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306677
6678 memcpy(pbkdf2->salt, data, data_length);
6679 pbkdf2->salt_length = data_length;
6680 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306681 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306682
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306683 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6684 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306685 return PSA_ERROR_INSUFFICIENT_MEMORY;
6686 }
6687
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306688 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6689 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306690 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306691 mbedtls_free(pbkdf2->salt);
6692 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306693 }
6694
6695 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6696
6697 return PSA_SUCCESS;
6698}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306699
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306700static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306701 const uint8_t *input,
6702 size_t input_len,
6703 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306704 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306705{
6706 psa_status_t status = PSA_SUCCESS;
6707 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6708 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306709 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306710 } else {
6711 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306712 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306713 }
6714 return status;
6715}
6716
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306717static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306718 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306719 const uint8_t *data,
6720 size_t data_length)
6721{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306722 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306723 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6724 return PSA_ERROR_BAD_STATE;
6725 }
6726
6727 if (data_length != 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306728 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6729 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6730 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6731 pbkdf2->password,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306732 &pbkdf2->password_length);
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306733 }
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306734 }
6735
6736 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6737
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306738 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306739}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306740
6741static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306742 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306743 psa_key_derivation_step_t step,
6744 const uint8_t *data,
6745 size_t data_length)
6746{
6747 switch (step) {
6748 case PSA_KEY_DERIVATION_INPUT_SALT:
6749 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6750 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306751 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306752 default:
6753 return PSA_ERROR_INVALID_ARGUMENT;
6754 }
6755}
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306756#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6757
Gilles Peskineb8965192019-09-24 16:21:10 +02006758/** Check whether the given key type is acceptable for the given
6759 * input step of a key derivation.
6760 *
6761 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6762 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6763 * Both secret and non-secret inputs can alternatively have the type
6764 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6765 * that the input was passed as a buffer rather than via a key object.
6766 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006767static int psa_key_derivation_check_input_type(
6768 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006770{
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006772 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (key_type == PSA_KEY_TYPE_DERIVE) {
6774 return PSA_SUCCESS;
6775 }
6776 if (key_type == PSA_KEY_TYPE_NONE) {
6777 return PSA_SUCCESS;
6778 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006779 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006780 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 if (key_type == PSA_KEY_TYPE_DERIVE) {
6782 return PSA_SUCCESS;
6783 }
6784 if (key_type == PSA_KEY_TYPE_NONE) {
6785 return PSA_SUCCESS;
6786 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006787 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006788 case PSA_KEY_DERIVATION_INPUT_LABEL:
6789 case PSA_KEY_DERIVATION_INPUT_SALT:
6790 case PSA_KEY_DERIVATION_INPUT_INFO:
6791 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6793 return PSA_SUCCESS;
6794 }
6795 if (key_type == PSA_KEY_TYPE_NONE) {
6796 return PSA_SUCCESS;
6797 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006798 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306799 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6800 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6801 return PSA_SUCCESS;
6802 }
6803 if (key_type == PSA_KEY_TYPE_DERIVE) {
6804 return PSA_SUCCESS;
6805 }
6806 if (key_type == PSA_KEY_TYPE_NONE) {
6807 return PSA_SUCCESS;
6808 }
6809 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006810 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006812}
6813
Janos Follathb80a94e2019-06-12 15:54:46 +01006814static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006815 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006816 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006817 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006818 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006820{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006821 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 status = psa_key_derivation_check_input_type(step, key_type);
6825 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006826 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006828
Przemek Stekiel69c46792022-06-10 12:59:51 +02006829#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6831 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6832 step, data, data_length);
6833 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006834#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006835#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6837 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6838 step, data, data_length);
6839 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006840#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6841#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6843 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6844 step, data, data_length);
6845 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006846#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006847#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006849 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6851 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006852#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306853#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6854 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306855 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6856 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306857 } else
6858#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006859 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006860 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006861 (void) data;
6862 (void) data_length;
6863 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006865 }
6866
Gilles Peskine224b0d62019-09-23 18:13:17 +02006867exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 if (status != PSA_SUCCESS) {
6869 psa_key_derivation_abort(operation);
6870 }
6871 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006872}
6873
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306874static psa_status_t psa_key_derivation_input_integer_internal(
6875 psa_key_derivation_operation_t *operation,
6876 psa_key_derivation_step_t step,
6877 uint64_t value)
6878{
6879 psa_status_t status;
6880 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6881
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306882#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6883 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6884 status = psa_pbkdf2_set_input_cost(
6885 &operation->ctx.pbkdf2, step, value);
6886 } else
6887#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306888 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306889 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306890 (void) value;
6891 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306892 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306893 }
6894
6895 if (status != PSA_SUCCESS) {
6896 psa_key_derivation_abort(operation);
6897 }
6898 return status;
6899}
6900
Janos Follath51f4a0f2019-06-14 11:35:55 +01006901psa_status_t psa_key_derivation_input_bytes(
6902 psa_key_derivation_operation_t *operation,
6903 psa_key_derivation_step_t step,
6904 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006906{
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 return psa_key_derivation_input_internal(operation, step,
6908 PSA_KEY_TYPE_NONE,
6909 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006910}
6911
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306912psa_status_t psa_key_derivation_input_integer(
6913 psa_key_derivation_operation_t *operation,
6914 psa_key_derivation_step_t step,
6915 uint64_t value)
6916{
6917 return psa_key_derivation_input_integer_internal(operation, step, value);
6918}
6919
Janos Follath51f4a0f2019-06-14 11:35:55 +01006920psa_status_t psa_key_derivation_input_key(
6921 psa_key_derivation_operation_t *operation,
6922 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006924{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006925 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006926 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006927 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006928
Ronald Cron5c522922020-11-14 16:35:34 +01006929 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6931 if (status != PSA_SUCCESS) {
6932 psa_key_derivation_abort(operation);
6933 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006934 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006935
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306936 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6937 * permission to output to a key object. */
6938 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6939 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006940 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006942
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 status = psa_key_derivation_input_internal(operation,
6944 step, slot->attr.type,
6945 slot->key.data,
6946 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006951}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006952
6953
6954
6955/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006956/* Key agreement */
6957/****************************************************************/
6958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6960 const uint8_t *key_buffer,
6961 size_t key_buffer_size,
6962 psa_algorithm_t alg,
6963 const uint8_t *peer_key,
6964 size_t peer_key_length,
6965 uint8_t *shared_secret,
6966 size_t shared_secret_size,
6967 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006968{
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006970#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006971 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6973 key_buffer_size, alg,
6974 peer_key, peer_key_length,
6975 shared_secret,
6976 shared_secret_size,
6977 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006978#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006979
6980#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
6981 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02006982 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01006983 peer_key,
6984 peer_key_length,
6985 key_buffer,
6986 key_buffer_size,
6987 shared_secret,
6988 shared_secret_size,
6989 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006990#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
6991
Gilles Peskine01d718c2018-09-18 12:01:02 +02006992 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006993 (void) attributes;
6994 (void) key_buffer;
6995 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006996 (void) peer_key;
6997 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006998 (void) shared_secret;
6999 (void) shared_secret_size;
7000 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007002 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007003}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007004
Aditya Deshpande17845b82022-10-13 17:21:01 +01007005/** Internal function for raw key agreement
7006 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007007 * to the driver's implementation if a driver is present.
7008 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007009 * (psa_key_agreement_raw_builtin).
7010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007011static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7012 psa_key_slot_t *private_key,
7013 const uint8_t *peer_key,
7014 size_t peer_key_length,
7015 uint8_t *shared_secret,
7016 size_t shared_secret_size,
7017 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007018{
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7020 return PSA_ERROR_NOT_SUPPORTED;
7021 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007022
7023 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007025 };
7026
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 return psa_driver_wrapper_key_agreement(&attributes,
7028 private_key->key.data,
7029 private_key->key.bytes, alg,
7030 peer_key, peer_key_length,
7031 shared_secret,
7032 shared_secret_size,
7033 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007034}
7035
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007036/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007037 * to potentially free embedded data structures and wipe confidential data.
7038 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007039static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7040 psa_key_derivation_step_t step,
7041 psa_key_slot_t *private_key,
7042 const uint8_t *peer_key,
7043 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007044{
7045 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007046 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007047 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007049
7050 /* Step 1: run the secret agreement algorithm to generate the shared
7051 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 status = psa_key_agreement_raw_internal(ka_alg,
7053 private_key,
7054 peer_key, peer_key_length,
7055 shared_secret,
7056 sizeof(shared_secret),
7057 &shared_secret_length);
7058 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007059 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007061
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007062 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007063 * the shared secret. A shared secret is permitted wherever a key
7064 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 status = psa_key_derivation_input_internal(operation, step,
7066 PSA_KEY_TYPE_DERIVE,
7067 shared_secret,
7068 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007069exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7071 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007072}
7073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7075 psa_key_derivation_step_t step,
7076 mbedtls_svc_key_id_t private_key,
7077 const uint8_t *peer_key,
7078 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007079{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007080 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007081 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007082 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7085 return PSA_ERROR_INVALID_ARGUMENT;
7086 }
Ronald Cron5c522922020-11-14 16:35:34 +01007087 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7089 if (status != PSA_SUCCESS) {
7090 return status;
7091 }
7092 status = psa_key_agreement_internal(operation, step,
7093 slot,
7094 peer_key, peer_key_length);
7095 if (status != PSA_SUCCESS) {
7096 psa_key_derivation_abort(operation);
7097 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007098 /* If a private key has been added as SECRET, we allow the derived
7099 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007101 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007103 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007104
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007106
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007108}
7109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7111 mbedtls_svc_key_id_t private_key,
7112 const uint8_t *peer_key,
7113 size_t peer_key_length,
7114 uint8_t *output,
7115 size_t output_size,
7116 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007117{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007118 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007119 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007120 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007123 status = PSA_ERROR_INVALID_ARGUMENT;
7124 goto exit;
7125 }
Ronald Cron5c522922020-11-14 16:35:34 +01007126 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7128 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007129 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007131
Gilles Peskine3e561302022-04-14 00:17:15 +02007132 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7133 * for the output size. The PSA specification only guarantees that this
7134 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7135 * but it might be nice to allow smaller buffers if the output fits.
7136 * At the time of writing this comment, with only ECDH implemented,
7137 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7138 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7139 * be exact for it as well. */
7140 size_t expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7142 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007143 status = PSA_ERROR_BUFFER_TOO_SMALL;
7144 goto exit;
7145 }
7146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 status = psa_key_agreement_raw_internal(alg, slot,
7148 peer_key, peer_key_length,
7149 output, output_size,
7150 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007151
7152exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007154 /* If an error happens and is not handled properly, the output
7155 * may be used as a key to protect sensitive data. Arrange for such
7156 * a key to be random, which is likely to result in decryption or
7157 * verification errors. This is better than filling the buffer with
7158 * some constant data such as zeros, which would result in the data
7159 * being protected with a reproducible, easily knowable key.
7160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007162 *output_length = output_size;
7163 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007164
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007168}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007169
7170
Gilles Peskine30524eb2020-11-13 17:02:26 +01007171
Gilles Peskine86a440b2018-11-12 18:39:40 +01007172/****************************************************************/
7173/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007174/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007175
Gilles Peskine30524eb2020-11-13 17:02:26 +01007176/** Initialize the PSA random generator.
7177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007178static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007179{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007180#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007182#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7183
Gilles Peskine30524eb2020-11-13 17:02:26 +01007184 /* Set default configuration if
7185 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007187 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 }
7189 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007190 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007192
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007194#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7195 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7196 /* The PSA entropy injection feature depends on using NV seed as an entropy
7197 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 mbedtls_entropy_add_source(&rng->entropy,
7199 mbedtls_nv_seed_poll, NULL,
7200 MBEDTLS_ENTROPY_BLOCK_SIZE,
7201 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007202#endif
7203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007205#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007206}
7207
7208/** Deinitialize the PSA random generator.
7209 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007210static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007211{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007212#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007214#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7216 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007217#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007218}
7219
7220/** Seed the PSA random generator.
7221 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007222static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007223{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007224#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7225 /* Do nothing: the external RNG seeds itself. */
7226 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007228#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007229 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7231 drbg_seed, sizeof(drbg_seed) - 1);
7232 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007233#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007234}
7235
Gilles Peskine449bd832023-01-11 14:50:10 +01007236psa_status_t psa_generate_random(uint8_t *output,
7237 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007238{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007239 GUARD_MODULE_INITIALIZED;
7240
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007241#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7242
7243 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7245 output, output_size,
7246 &output_length);
7247 if (status != PSA_SUCCESS) {
7248 return status;
7249 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007250 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007251 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 if (output_length != output_size) {
7253 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7254 }
7255 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007256
7257#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007260 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7262 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7263 output_size);
7264 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7265 output, request_size);
7266 if (ret != 0) {
7267 return mbedtls_to_psa_error(ret);
7268 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007269 output_size -= request_size;
7270 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007271 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007273#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007274}
7275
Gilles Peskine8814fc42020-12-14 15:33:44 +01007276/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007277 *
7278 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7279 * `psa_generate_random(...)`. The state parameter is ignored since the
7280 * PSA API doesn't support passing an explicit state.
7281 *
7282 * In the non-external case, psa_generate_random() calls an
7283 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7284 * and semantics as mbedtls_psa_get_random(). As an optimization,
7285 * instead of doing this back-and-forth between the PSA API and the
7286 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7287 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007289#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7290int mbedtls_psa_get_random(void *p_rng,
7291 unsigned char *output,
7292 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007293{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007294 /* This function takes a pointer to the RNG state because that's what
7295 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7296 * its own state internally and doesn't let the caller access that state.
7297 * So we just ignore the state parameter, and in practice we'll pass
7298 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007299 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 psa_status_t status = psa_generate_random(output, output_size);
7301 if (status == PSA_SUCCESS) {
7302 return 0;
7303 } else {
7304 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7305 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007306}
7307#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7308
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007309#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00007310#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007311
Gilles Peskine449bd832023-01-11 14:50:10 +01007312psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7313 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007314{
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 if (global_data.initialized) {
7316 return PSA_ERROR_NOT_PERMITTED;
7317 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007318
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7320 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7321 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7322 return PSA_ERROR_INVALID_ARGUMENT;
7323 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007324
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007326}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007327#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007328
Ronald Cron3772afe2021-02-08 16:10:05 +01007329/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007330 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007331 * \param type The key type
7332 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007333 *
7334 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007335 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007336 * \retval #PSA_ERROR_INVALID_ARGUMENT
7337 * The size in bits of the key is not valid.
7338 * \retval #PSA_ERROR_NOT_SUPPORTED
7339 * The type and/or the size in bits of the key or the combination of
7340 * the two is not supported.
7341 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007342static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007344{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (key_type_is_raw_bytes(type)) {
7348 status = psa_validate_unstructured_key_bit_size(type, bits);
7349 if (status != PSA_SUCCESS) {
7350 return status;
7351 }
7352 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007353#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7355 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7356 return PSA_ERROR_NOT_SUPPORTED;
7357 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007358
Ronald Cron01b2aba2020-10-05 09:42:02 +02007359 /* Accept only byte-aligned keys, for the same reasons as
7360 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 if (bits % 8 != 0) {
7362 return PSA_ERROR_NOT_SUPPORTED;
7363 }
7364 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007365#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007366
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007367#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007369 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 return PSA_SUCCESS;
7371 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007372#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007373
Valerio Setti8bb57632023-05-26 13:48:07 +02007374#if defined(MBEDTLS_PSA_WANT_KEY_TYPE_DH_KEY_PAIR_LEGACY)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007375 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007376 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007377 return PSA_ERROR_NOT_SUPPORTED;
7378 }
7379 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007380#endif /* defined(MBEDTLS_PSA_WANT_KEY_TYPE_DH_KEY_PAIR_LEGACY) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007381 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007383 }
7384
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007386}
7387
Ronald Cron55ed0592020-10-05 10:30:40 +02007388psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007389 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007391{
7392 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007393 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007394
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 if ((attributes->domain_parameters == NULL) &&
7396 (attributes->domain_parameters_size != 0)) {
7397 return PSA_ERROR_INVALID_ARGUMENT;
7398 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (key_type_is_raw_bytes(type)) {
7401 status = psa_generate_random(key_buffer, key_buffer_size);
7402 if (status != PSA_SUCCESS) {
7403 return status;
7404 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007405
David Brown12ca5032021-02-11 11:02:00 -07007406#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (type == PSA_KEY_TYPE_DES) {
7408 psa_des_set_key_parity(key_buffer, key_buffer_size);
7409 }
David Brown8107e312021-02-12 08:08:46 -07007410#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007412
Valerio Setti76df8c12023-07-11 14:11:28 +02007413#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7415 return mbedtls_psa_rsa_generate_key(attributes,
7416 key_buffer,
7417 key_buffer_size,
7418 key_buffer_length);
7419 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007420#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007421
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007422#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7424 return mbedtls_psa_ecp_generate_key(attributes,
7425 key_buffer,
7426 key_buffer_size,
7427 key_buffer_length);
7428 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007429#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007430
Valerio Setti8bb57632023-05-26 13:48:07 +02007431#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007432 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7433 return mbedtls_psa_ffdh_generate_key(attributes,
7434 key_buffer,
7435 key_buffer_size,
7436 key_buffer_length);
7437 } else
Valerio Setti8bb57632023-05-26 13:48:07 +02007438#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_LEGACY) */
Steven Cooreman29149862020-08-05 15:43:42 +02007439 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 (void) key_buffer_length;
7441 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007442 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007443
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007445}
Darryl Green0c6575a2018-11-07 16:05:30 +00007446
Gilles Peskine449bd832023-01-11 14:50:10 +01007447psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7448 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007449{
7450 psa_status_t status;
7451 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007452 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007453 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007454
Ronald Cron81709fc2020-11-14 12:10:32 +01007455 *key = MBEDTLS_SVC_KEY_ID_INIT;
7456
Gilles Peskine0f84d622019-09-12 19:03:13 +02007457 /* Reject any attempt to create a zero-length key so that we don't
7458 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 if (psa_get_key_bits(attributes) == 0) {
7460 return PSA_ERROR_INVALID_ARGUMENT;
7461 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007462
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007463 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7465 return PSA_ERROR_INVALID_ARGUMENT;
7466 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7469 &slot, &driver);
7470 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007471 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 }
Gilles Peskine11792082019-08-06 18:36:36 +02007473
Ronald Cron977c2472020-10-13 08:32:21 +02007474 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307475 * storage ( thus not in the case of generating a key in a secure element
7476 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7477 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 if (slot->key.data == NULL) {
7479 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7480 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007481 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 attributes->core.type, attributes->core.bits);
7483 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007484 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007486
7487 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 attributes->core.type,
7489 attributes->core.bits);
7490 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007491 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 attributes, &key_buffer_size);
7493 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007494 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 }
Ronald Cron977c2472020-10-13 08:32:21 +02007496 }
Ronald Cron977c2472020-10-13 08:32:21 +02007497
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7499 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007500 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 }
Ronald Cron977c2472020-10-13 08:32:21 +02007502 }
7503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 status = psa_driver_wrapper_generate_key(attributes,
7505 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if (status != PSA_SUCCESS) {
7508 psa_remove_key_data_from_memory(slot);
7509 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007510
Gilles Peskine11792082019-08-06 18:36:36 +02007511exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 if (status == PSA_SUCCESS) {
7513 status = psa_finish_key_creation(slot, driver, key);
7514 }
7515 if (status != PSA_SUCCESS) {
7516 psa_fail_key_creation(slot, driver);
7517 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007518
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007520}
7521
Gilles Peskinee59236f2018-01-27 23:32:46 +01007522/****************************************************************/
7523/* Module setup */
7524/****************************************************************/
7525
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007526#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007527psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 void (* entropy_init)(mbedtls_entropy_context *ctx),
7529 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007530{
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7532 return PSA_ERROR_BAD_STATE;
7533 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007534 global_data.rng.entropy_init = entropy_init;
7535 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007537}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007538#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007541{
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 psa_wipe_all_key_slots();
7543 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7544 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007545 }
7546 /* Wipe all remaining data, including configuration.
7547 * In particular, this sets all state indicator to the value
7548 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007550
7551 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007553}
7554
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007555#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7556/** Recover a transaction that was interrupted by a power failure.
7557 *
7558 * This function is called during initialization, before psa_crypto_init()
7559 * returns. If this function returns a failure status, the initialization
7560 * fails.
7561 */
7562static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007564{
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007566 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7567 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 /* TODO - fall through to the failure case until this
7569 * is implemented.
7570 * https://github.com/ARMmbed/mbed-crypto/issues/218
7571 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007572 default:
7573 /* We found an unsupported transaction in the storage.
7574 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007576 }
7577}
7578#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007581{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007582 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007583
Gilles Peskinec6b69072018-11-20 21:42:52 +01007584 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if (global_data.initialized != 0) {
7586 return PSA_SUCCESS;
7587 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007588
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007589 /* Init drivers */
7590 status = psa_driver_wrapper_init();
7591 if (status != PSA_SUCCESS) {
7592 goto exit;
7593 }
7594 global_data.drivers_initialized = 1;
7595
Gilles Peskine30524eb2020-11-13 17:02:26 +01007596 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007598 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 status = mbedtls_psa_random_seed(&global_data.rng);
7600 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007601 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007603 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 status = psa_initialize_key_slots();
7606 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007607 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007609
Gilles Peskine4b734222019-07-24 15:56:31 +02007610#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 status = psa_crypto_load_transaction();
7612 if (status == PSA_SUCCESS) {
7613 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7614 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007615 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 }
7617 status = psa_crypto_stop_transaction();
7618 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007619 /* There's no transaction to complete. It's all good. */
7620 status = PSA_SUCCESS;
7621 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007622#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007623
Gilles Peskinec6b69072018-11-20 21:42:52 +01007624 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007625 global_data.initialized = 1;
7626
7627exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 if (status != PSA_SUCCESS) {
7629 mbedtls_psa_crypto_free();
7630 }
7631 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007632}
7633
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007634psa_status_t psa_crypto_driver_pake_get_password_len(
7635 const psa_crypto_driver_pake_inputs_t *inputs,
7636 size_t *password_len)
7637{
7638 if (inputs->password_len == 0) {
7639 return PSA_ERROR_BAD_STATE;
7640 }
7641
7642 *password_len = inputs->password_len;
7643
7644 return PSA_SUCCESS;
7645}
7646
7647psa_status_t psa_crypto_driver_pake_get_password(
7648 const psa_crypto_driver_pake_inputs_t *inputs,
7649 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7650{
7651 if (inputs->password_len == 0) {
7652 return PSA_ERROR_BAD_STATE;
7653 }
7654
7655 if (buffer_size < inputs->password_len) {
7656 return PSA_ERROR_BUFFER_TOO_SMALL;
7657 }
7658
7659 memcpy(buffer, inputs->password, inputs->password_len);
7660 *buffer_length = inputs->password_len;
7661
7662 return PSA_SUCCESS;
7663}
7664
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007665psa_status_t psa_crypto_driver_pake_get_user_len(
7666 const psa_crypto_driver_pake_inputs_t *inputs,
7667 size_t *user_len)
7668{
7669 if (inputs->user_len == 0) {
7670 return PSA_ERROR_BAD_STATE;
7671 }
7672
7673 *user_len = inputs->user_len;
7674
7675 return PSA_SUCCESS;
7676}
7677
7678psa_status_t psa_crypto_driver_pake_get_user(
7679 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007680 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007681{
7682 if (inputs->user_len == 0) {
7683 return PSA_ERROR_BAD_STATE;
7684 }
7685
Przemek Stekielc0e62502023-03-14 11:49:36 +01007686 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007687 return PSA_ERROR_BUFFER_TOO_SMALL;
7688 }
7689
Przemek Stekielc0e62502023-03-14 11:49:36 +01007690 memcpy(user_id, inputs->user, inputs->user_len);
7691 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007692
7693 return PSA_SUCCESS;
7694}
7695
7696psa_status_t psa_crypto_driver_pake_get_peer_len(
7697 const psa_crypto_driver_pake_inputs_t *inputs,
7698 size_t *peer_len)
7699{
7700 if (inputs->peer_len == 0) {
7701 return PSA_ERROR_BAD_STATE;
7702 }
7703
7704 *peer_len = inputs->peer_len;
7705
7706 return PSA_SUCCESS;
7707}
7708
7709psa_status_t psa_crypto_driver_pake_get_peer(
7710 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007711 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007712{
7713 if (inputs->peer_len == 0) {
7714 return PSA_ERROR_BAD_STATE;
7715 }
7716
Przemek Stekielc0e62502023-03-14 11:49:36 +01007717 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007718 return PSA_ERROR_BUFFER_TOO_SMALL;
7719 }
7720
Przemek Stekielc0e62502023-03-14 11:49:36 +01007721 memcpy(peer_id, inputs->peer, inputs->peer_len);
7722 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007723
7724 return PSA_SUCCESS;
7725}
7726
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007727psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7728 const psa_crypto_driver_pake_inputs_t *inputs,
7729 psa_pake_cipher_suite_t *cipher_suite)
7730{
7731 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7732 return PSA_ERROR_BAD_STATE;
7733 }
7734
7735 *cipher_suite = inputs->cipher_suite;
7736
7737 return PSA_SUCCESS;
7738}
7739
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01007740#if defined(PSA_WANT_ALG_SOME_PAKE)
Neil Armstronga7d08c32022-06-01 18:21:20 +02007741psa_status_t psa_pake_setup(
7742 psa_pake_operation_t *operation,
7743 const psa_pake_cipher_suite_t *cipher_suite)
7744{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007745 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007746
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007747 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007748 status = PSA_ERROR_BAD_STATE;
7749 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007750 }
7751
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007752 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007753 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007754 status = PSA_ERROR_INVALID_ARGUMENT;
7755 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007756 }
7757
Przemek Stekiel51eac532022-12-07 11:04:51 +01007758 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7759
Przemek Stekiele12ed362022-12-21 12:54:46 +01007760 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007761 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7762 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007763 operation->data.inputs.cipher_suite = *cipher_suite;
7764
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007765#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007766 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007767 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007768 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007769
David Horstmann16f01512023-06-14 17:21:07 +01007770 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007771 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007772 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007773#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007774 {
7775 status = PSA_ERROR_NOT_SUPPORTED;
7776 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007777 }
7778
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007779 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7780
Przemek Stekiel51eac532022-12-07 11:04:51 +01007781 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007782exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007783 psa_pake_abort(operation);
7784 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007785}
7786
7787psa_status_t psa_pake_set_password_key(
7788 psa_pake_operation_t *operation,
7789 mbedtls_svc_key_id_t password)
7790{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007791 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007792 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7793 psa_key_slot_t *slot = NULL;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007794
Przemek Stekiel51eac532022-12-07 11:04:51 +01007795 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007796 status = PSA_ERROR_BAD_STATE;
7797 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007798 }
7799
Przemek Stekiel6c764412022-11-22 14:05:12 +01007800 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7801 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007802 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007803 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007804 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007805 }
7806
Przemek Stekiel6c764412022-11-22 14:05:12 +01007807 psa_key_attributes_t attributes = {
7808 .core = slot->attr
7809 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007810
Przemek Stekiel51eac532022-12-07 11:04:51 +01007811 psa_key_type_t type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007812
Przemek Stekiel51eac532022-12-07 11:04:51 +01007813 if (type != PSA_KEY_TYPE_PASSWORD &&
7814 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7815 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007816 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007817 }
7818
Przemek Stekiel51eac532022-12-07 11:04:51 +01007819 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7820 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007821 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007822 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007823 }
7824
7825 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7826 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007827 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007828exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007829 if (status != PSA_SUCCESS) {
7830 psa_pake_abort(operation);
7831 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007832 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007833 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007834}
7835
7836psa_status_t psa_pake_set_user(
7837 psa_pake_operation_t *operation,
7838 const uint8_t *user_id,
7839 size_t user_id_len)
7840{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007841 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007842
7843 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007844 status = PSA_ERROR_BAD_STATE;
7845 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007846 }
7847
Przemek Stekiel51eac532022-12-07 11:04:51 +01007848 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007849 status = PSA_ERROR_INVALID_ARGUMENT;
7850 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007851 }
7852
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007853 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007854 status = PSA_ERROR_BAD_STATE;
7855 goto exit;
7856 }
7857
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007858 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7859 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007860 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7861 goto exit;
7862 }
7863
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007864 memcpy(operation->data.inputs.user, user_id, user_id_len);
7865 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007866
7867 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007868exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007869 psa_pake_abort(operation);
7870 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007871}
7872
7873psa_status_t psa_pake_set_peer(
7874 psa_pake_operation_t *operation,
7875 const uint8_t *peer_id,
7876 size_t peer_id_len)
7877{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007878 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007879
7880 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007881 status = PSA_ERROR_BAD_STATE;
7882 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007883 }
7884
Przemek Stekiel51eac532022-12-07 11:04:51 +01007885 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007886 status = PSA_ERROR_INVALID_ARGUMENT;
7887 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007888 }
7889
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007890 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007891 status = PSA_ERROR_BAD_STATE;
7892 goto exit;
7893 }
7894
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007895 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7896 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007897 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7898 goto exit;
7899 }
7900
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007901 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7902 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007903
7904 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007905exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007906 psa_pake_abort(operation);
7907 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007908}
7909
7910psa_status_t psa_pake_set_role(
7911 psa_pake_operation_t *operation,
7912 psa_pake_role_t role)
7913{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007914 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007915
Przemek Stekiel51eac532022-12-07 11:04:51 +01007916 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007917 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007918 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007919 }
7920
Przemek Stekiel09104b82023-03-06 14:11:51 +01007921 switch (operation->alg) {
7922#if defined(PSA_WANT_ALG_JPAKE)
7923 case PSA_ALG_JPAKE:
7924 if (role == PSA_PAKE_ROLE_NONE) {
7925 return PSA_SUCCESS;
7926 }
7927 status = PSA_ERROR_INVALID_ARGUMENT;
7928 break;
7929#endif
7930 default:
7931 (void) role;
7932 status = PSA_ERROR_NOT_SUPPORTED;
7933 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007934 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007935exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007936 psa_pake_abort(operation);
7937 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007938}
7939
David Horstmanne7f21e62023-05-12 18:17:21 +01007940/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007941#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01007942static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01007943 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01007944{
David Horstmann74a3d8c2023-06-14 18:28:19 +01007945 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01007946 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007947 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01007948
David Horstmann024e5c52023-06-14 15:48:21 +01007949 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01007950 is_x1 = (stage->outputs < 1);
7951 } else {
7952 is_x1 = (stage->inputs < 1);
7953 }
7954
David Horstmann74a3d8c2023-06-14 18:28:19 +01007955 key_share_step = is_x1 ?
7956 PSA_JPAKE_X1_STEP_KEY_SHARE :
7957 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01007958 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01007959 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
7960 PSA_JPAKE_X2S_STEP_KEY_SHARE :
7961 PSA_JPAKE_X4S_STEP_KEY_SHARE;
7962 } else {
7963 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007964 }
David Horstmann74a3d8c2023-06-14 18:28:19 +01007965 return key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekielb09c4872023-01-17 12:05:38 +01007966}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007967#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01007968
Przemek Stekiel2797d372022-12-22 11:19:22 +01007969static psa_status_t psa_pake_complete_inputs(
7970 psa_pake_operation_t *operation)
7971{
Przemek Stekiel2797d372022-12-22 11:19:22 +01007972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01007973 /* Create copy of the inputs on stack as inputs share memory
7974 with the driver context which will be setup by the driver. */
7975 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01007976
Przemek Stekielfde11282023-03-13 16:06:09 +01007977 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01007978 return PSA_ERROR_BAD_STATE;
7979 }
7980
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007981 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01007982 if (inputs.user_len == 0 || inputs.peer_len == 0) {
7983 return PSA_ERROR_BAD_STATE;
7984 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01007985 }
7986
Przemek Stekiel18620a32023-01-17 16:34:52 +01007987 /* Clear driver context */
7988 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
7989
7990 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007991
7992 /* Driver is responsible for creating its own copy of the password. */
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007993 mbedtls_platform_zeroize(inputs.password, inputs.password_len);
7994 mbedtls_free(inputs.password);
Przemek Stekiel2797d372022-12-22 11:19:22 +01007995
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007996 /* User and peer are translated to role. */
7997 mbedtls_free(inputs.user);
7998 mbedtls_free(inputs.peer);
7999
Przemek Stekiel2797d372022-12-22 11:19:22 +01008000 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008001#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008002 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008003 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008004 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008005#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008006 {
8007 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008008 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008009 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008010 return status;
8011}
8012
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008013#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008014static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008015 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008016 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008017 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008018{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008019 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8020 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8021 step != PSA_PAKE_STEP_ZK_PROOF) {
8022 return PSA_ERROR_INVALID_ARGUMENT;
8023 }
8024
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008025 psa_jpake_computation_stage_t *computation_stage =
8026 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008027
David Horstmann5da95602023-06-08 15:37:12 +01008028 if (computation_stage->round != PSA_JPAKE_FIRST &&
8029 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008030 return PSA_ERROR_BAD_STATE;
8031 }
8032
David Horstmanne7f21e62023-05-12 18:17:21 +01008033 /* Check that the step we are given is the one we were expecting */
8034 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008035 return PSA_ERROR_BAD_STATE;
8036 }
8037
David Horstmanne7f21e62023-05-12 18:17:21 +01008038 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8039 computation_stage->inputs == 0 &&
8040 computation_stage->outputs == 0) {
8041 /* Start of the round, so function decides whether we are inputting
8042 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008043 computation_stage->io_mode = io_mode;
8044 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008045 /* Middle of the round so the mode we are in must match the function
8046 * called by the user */
8047 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008048 }
8049
8050 return PSA_SUCCESS;
8051}
8052
David Horstmanne7f21e62023-05-12 18:17:21 +01008053static psa_status_t psa_jpake_epilogue(
8054 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008055 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008056{
David Horstmanne7f21e62023-05-12 18:17:21 +01008057 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008058 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008059
David Horstmanne7f21e62023-05-12 18:17:21 +01008060 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8061 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008062 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008063 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008064 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008065 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008066 }
8067 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008068 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008069 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008070 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008071 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008072 }
8073 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008074 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8075 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008076 /* End of a round, move to the next round */
8077 stage->inputs = 0;
8078 stage->outputs = 0;
8079 stage->round++;
8080 }
8081 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008082 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008083 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008084 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008085 return PSA_SUCCESS;
8086}
David Horstmanne7f21e62023-05-12 18:17:21 +01008087
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008088#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008089
Neil Armstronga7d08c32022-06-01 18:21:20 +02008090psa_status_t psa_pake_output(
8091 psa_pake_operation_t *operation,
8092 psa_pake_step_t step,
8093 uint8_t *output,
8094 size_t output_size,
8095 size_t *output_length)
8096{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008098 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008099 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008100
8101 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008102 status = psa_pake_complete_inputs(operation);
8103 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008104 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008105 }
8106 }
8107
8108 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008109 status = PSA_ERROR_BAD_STATE;
8110 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008111 }
8112
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008113 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008114 status = PSA_ERROR_INVALID_ARGUMENT;
8115 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008116 }
8117
Przemek Stekiele12ed362022-12-21 12:54:46 +01008118 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008119#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008120 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008121 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008122 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008123 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008124 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008125 driver_step = convert_jpake_computation_stage_to_driver_step(
8126 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008127 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008128#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008129 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008130 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008131 status = PSA_ERROR_NOT_SUPPORTED;
8132 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008133 }
8134
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008135 status = psa_driver_wrapper_pake_output(operation, driver_step,
8136 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008137
8138 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008139 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008140 }
8141
8142 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008143#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008144 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008145 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008146 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008147 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008148 }
8149 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008150#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008151 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008152 status = PSA_ERROR_NOT_SUPPORTED;
8153 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008154 }
8155
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156 return PSA_SUCCESS;
8157exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008158 psa_pake_abort(operation);
8159 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008160}
8161
8162psa_status_t psa_pake_input(
8163 psa_pake_operation_t *operation,
8164 psa_pake_step_t step,
8165 const uint8_t *input,
8166 size_t input_length)
8167{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008168 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008169 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008170 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8171 operation->primitive,
8172 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008173
8174 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008175 status = psa_pake_complete_inputs(operation);
8176 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008177 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008178 }
8179 }
8180
8181 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008182 status = PSA_ERROR_BAD_STATE;
8183 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008184 }
8185
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008186 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008187 status = PSA_ERROR_INVALID_ARGUMENT;
8188 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008189 }
8190
Przemek Stekiele12ed362022-12-21 12:54:46 +01008191 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008192#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008193 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008194 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008195 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008196 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008197 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008198 driver_step = convert_jpake_computation_stage_to_driver_step(
8199 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008200 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008201#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008202 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008203 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008204 status = PSA_ERROR_NOT_SUPPORTED;
8205 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008206 }
8207
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008208 status = psa_driver_wrapper_pake_input(operation, driver_step,
8209 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008210
8211 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008212 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008213 }
8214
8215 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008216#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008217 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008218 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008219 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008220 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008221 }
8222 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008223#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008224 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008225 status = PSA_ERROR_NOT_SUPPORTED;
8226 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008227 }
8228
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008229 return PSA_SUCCESS;
8230exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008231 psa_pake_abort(operation);
8232 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008233}
8234
8235psa_status_t psa_pake_get_implicit_key(
8236 psa_pake_operation_t *operation,
8237 psa_key_derivation_operation_t *output)
8238{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008239 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008240 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008241 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008242 size_t shared_key_len = 0;
8243
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008244 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008245 status = PSA_ERROR_BAD_STATE;
8246 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008247 }
8248
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008249#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008250 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008251 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008252 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008253 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008254 status = PSA_ERROR_BAD_STATE;
8255 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008256 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008257 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008258#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008259 {
8260 status = PSA_ERROR_NOT_SUPPORTED;
8261 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008262 }
8263
Przemek Stekiel0c781802022-11-29 14:53:13 +01008264 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8265 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008266 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008267 &shared_key_len);
8268
8269 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008270 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008271 }
8272
8273 status = psa_key_derivation_input_bytes(output,
8274 PSA_KEY_DERIVATION_INPUT_SECRET,
8275 shared_key,
8276 shared_key_len);
8277
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008278 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008279exit:
8280 abort_status = psa_pake_abort(operation);
8281 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008282}
8283
8284psa_status_t psa_pake_abort(
8285 psa_pake_operation_t *operation)
8286{
Przemek Stekield69dca92023-01-31 19:59:20 +01008287 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008288
Przemek Stekield69dca92023-01-31 19:59:20 +01008289 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008290 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008291 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008292
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008293 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8294 if (operation->data.inputs.password != NULL) {
8295 mbedtls_platform_zeroize(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008296 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008297 mbedtls_free(operation->data.inputs.password);
8298 }
8299 if (operation->data.inputs.user != NULL) {
8300 mbedtls_free(operation->data.inputs.user);
8301 }
8302 if (operation->data.inputs.peer != NULL) {
8303 mbedtls_free(operation->data.inputs.peer);
8304 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008305 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008306 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008307
Przemek Stekield69dca92023-01-31 19:59:20 +01008308 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008309}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008310#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008311
Gilles Peskinee59236f2018-01-27 23:32:46 +01008312#endif /* MBEDTLS_PSA_CRYPTO_C */