blob: dcc6ab85734ac876a2c5b8dd309858a7ebf3377b [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"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010030#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010038#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010039#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010040#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020042#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010044#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010045/* Include internal declarations that are useful for implementing persistently
46 * stored keys. */
47#include "psa_crypto_storage.h"
48
Gilles Peskineb2b64d32020-12-14 16:43:58 +010049#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010050
Gilles Peskineb46bef22019-07-30 21:32:04 +020051#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include <stdlib.h>
53#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010056#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020057#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000058#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020059#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020061#include "mbedtls/chacha20.h"
62#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/cipher.h"
64#include "mbedtls/ccm.h"
65#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020067#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010068#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010069#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/error.h"
71#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010073#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000074#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010075#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000076#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010077#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000078#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010079#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010081#include "mbedtls/sha1.h"
82#include "mbedtls/sha256.h"
83#include "mbedtls/sha512.h"
Paul Elliott588f8ed2022-12-02 18:10:26 +000084#include "hash_info.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085
Gilles Peskine449bd832023-01-11 14:50:10 +010086#define ARRAY_LENGTH(array) (sizeof(array) / sizeof(*(array)))
Gilles Peskine996deb12018-08-01 15:45:45 +020087
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020088#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
89 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
90 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020091#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020092#endif
93
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010094/****************************************************************/
95/* Global data, support functions and library management */
96/****************************************************************/
97
Gilles Peskine449bd832023-01-11 14:50:10 +010098static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020099{
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200101}
102
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100103/* Values for psa_global_data_t::rng_state */
104#define RNG_NOT_INITIALIZED 0
105#define RNG_INITIALIZED 1
106#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107
Gilles Peskine449bd832023-01-11 14:50:10 +0100108typedef struct {
Gilles Peskinec6b69072018-11-20 21:42:52 +0100109 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100110 unsigned rng_state : 2;
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
Gilles Peskine449bd832023-01-11 14:50:10 +0100125psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100126{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100127 /* Mbed TLS error codes can combine a high-level error code and a
128 * low-level error code. The low-level error usually reflects the
129 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 int low_level_ret = -(-ret & 0x007f);
131 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100132 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100133 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100134
135 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
136 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine9a944802018-06-21 09:35:35 +0200138 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
139 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
140 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
141 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
142 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200144 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200146 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskine9a944802018-06-21 09:35:35 +0200148
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000150 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000151#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100152 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100154
155 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100157 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100159
Gilles Peskine26869f22019-05-06 15:25:00 +0200160 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine26869f22019-05-06 15:25:00 +0200162
163 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200165 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200167
Gilles Peskinea5905292018-02-07 20:59:33 +0100168 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100170 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100173 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100177 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100178 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100180 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
184 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100185 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
186 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100187 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100189 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
190 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100192 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100194#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100195
196 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100198
Gilles Peskinee59236f2018-01-27 23:32:46 +0100199 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
200 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
201 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100203
204 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200206 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100208 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100210
Gilles Peskine82e57d12020-11-13 21:31:17 +0100211#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100213 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
214 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100215 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100216 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100217 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
218 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100220 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100222#endif
223
Gilles Peskinea5905292018-02-07 20:59:33 +0100224 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100226 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100228 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100230 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100232
Gilles Peskinef76aa772018-10-29 19:24:33 +0100233 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100235 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100237 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100239 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100241 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100243 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100245 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100247 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100249
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100250 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100252 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
253 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100255 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100257 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
258 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100260 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100262 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
263 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100265 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100267 case MBEDTLS_ERR_PK_INVALID_ALG:
268 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
269 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100272 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200273 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100275
Gilles Peskineff2d2002019-05-06 15:26:23 +0200276 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200278 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200280
Gilles Peskinea5905292018-02-07 20:59:33 +0100281 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100283 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100285 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100289 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
290 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100292 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100294 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100296 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200298
itayzafrir5c753392018-05-08 11:18:38 +0300299 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300300 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300302 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300304 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300306 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
307 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300309 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100311 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100313
Paul Elliott588f8ed2022-12-02 18:10:26 +0000314 case MBEDTLS_ERR_ECP_IN_PROGRESS:
315 return PSA_OPERATION_INCOMPLETE;
316
Janos Follatha13b9052019-11-22 12:48:59 +0000317 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300319
Gilles Peskinee59236f2018-01-27 23:32:46 +0100320 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100322 }
323}
324
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200325
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200326
327
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100328/****************************************************************/
329/* Key management */
330/****************************************************************/
331
John Durkop9814fa22020-11-04 12:28:15 -0800332#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800333 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cronf467d632021-11-19 18:02:34 +0100334 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
335 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
336 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100337mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
338 size_t bits,
339 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200340{
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100342 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100344#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100345 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100347#endif
348#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100349 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100351#endif
352#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100353 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100355#endif
356#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100357 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100358 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100359#endif
360#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100363 case 528:
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 if (bits_is_sloppy) {
365 return MBEDTLS_ECP_DP_SECP521R1;
366 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100367 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100368#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100369 }
370 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100371
Paul Elliott8ff510a2020-06-02 17:19:28 +0100372 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100374#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100375 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100377#endif
378#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100379 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100381#endif
382#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100383 case 512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100385#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100386 }
387 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100388
Paul Elliott8ff510a2020-06-02 17:19:28 +0100389 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 255:
Gilles Peskine449bd832023-01-11 14:50:10 +0100393 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 if (bits_is_sloppy) {
396 return MBEDTLS_ECP_DP_CURVE25519;
397 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100399#endif
400#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100401 case 448:
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100403#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100404 }
405 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100406
Paul Elliott8ff510a2020-06-02 17:19:28 +0100407 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100410 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100412#endif
413#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 }
422 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200423 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100425 (void) bits_is_sloppy;
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200427}
John Durkop9814fa22020-11-04 12:28:15 -0800428#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cronf467d632021-11-19 18:02:34 +0100429 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
430 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
431 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
432 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200433
Gilles Peskine449bd832023-01-11 14:50:10 +0100434psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
435 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200436{
437 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200442 case PSA_KEY_TYPE_PASSWORD:
443 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200444 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100445#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 if (bits != 128 && bits != 192 && bits != 256) {
448 return PSA_ERROR_INVALID_ARGUMENT;
449 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 break;
451#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200452#if defined(PSA_WANT_KEY_TYPE_ARIA)
453 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 if (bits != 128 && bits != 192 && bits != 256) {
455 return PSA_ERROR_INVALID_ARGUMENT;
456 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200457 break;
458#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100459#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200460 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100461 if (bits != 128 && bits != 192 && bits != 256) {
462 return PSA_ERROR_INVALID_ARGUMENT;
463 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 break;
465#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100466#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200467 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 if (bits != 64 && bits != 128 && bits != 192) {
469 return PSA_ERROR_INVALID_ARGUMENT;
470 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200471 break;
472#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100473#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200474 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 if (bits != 256) {
476 return PSA_ERROR_INVALID_ARGUMENT;
477 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200478 break;
479#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200480 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200482 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 if (bits % 8 != 0) {
484 return PSA_ERROR_INVALID_ARGUMENT;
485 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200486
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200488}
489
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100491 *
Steven Cooremancd640932021-03-08 12:00:27 +0100492 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
493 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 *
495 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100496 * \param[in] key_type The key type of the key to be used with the
497 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498 *
499 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100500 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100505 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507{
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 if (PSA_ALG_IS_HMAC(algorithm)) {
509 if (key_type == PSA_KEY_TYPE_HMAC) {
510 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100511 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100512 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
515 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
516 * key. */
517 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
518 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
519 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
520 * the block length (larger than 1) for block ciphers. */
521 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
522 return PSA_SUCCESS;
523 }
524 }
525 }
526
527 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100528}
529
Gilles Peskine449bd832023-01-11 14:50:10 +0100530psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
531 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200532{
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 if (slot->key.data != NULL) {
534 return PSA_ERROR_ALREADY_EXISTS;
535 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200536
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 slot->key.data = mbedtls_calloc(1, buffer_length);
538 if (slot->key.data == NULL) {
539 return PSA_ERROR_INSUFFICIENT_MEMORY;
540 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200541
Ronald Cronea0f8a62020-11-25 17:52:23 +0100542 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200544}
545
Gilles Peskine449bd832023-01-11 14:50:10 +0100546psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
547 const uint8_t *data,
548 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200549{
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 psa_status_t status = psa_allocate_buffer_to_slot(slot,
551 data_length);
552 if (status != PSA_SUCCESS) {
553 return status;
554 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200555
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 memcpy(slot->key.data, data, data_length);
557 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200558}
559
Ronald Crona0fe59f2020-11-29 11:14:53 +0100560psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100561 const psa_key_attributes_t *attributes,
562 const uint8_t *data, size_t data_length,
563 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100565{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100566 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
567 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100568
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200569 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 if (data_length == 0) {
571 return PSA_ERROR_NOT_SUPPORTED;
572 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 if (key_type_is_raw_bytes(type)) {
575 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200576
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
578 *bits);
579 if (status != PSA_SUCCESS) {
580 return status;
581 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200582
Ronald Crondd04d422020-11-28 15:14:42 +0100583 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100585 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200587
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return PSA_SUCCESS;
589 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
John Durkop9814fa22020-11-04 12:28:15 -0800590#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
592 if (PSA_KEY_TYPE_IS_ECC(type)) {
593 return mbedtls_psa_ecp_import_key(attributes,
594 data, data_length,
595 key_buffer, key_buffer_size,
596 key_buffer_length,
597 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100598 }
John Durkop9814fa22020-11-04 12:28:15 -0800599#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
600 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700601#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
603 if (PSA_KEY_TYPE_IS_RSA(type)) {
604 return mbedtls_psa_rsa_import_key(attributes,
605 data, data_length,
606 key_buffer, key_buffer_size,
607 key_buffer_length,
608 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200609 }
John Durkop9814fa22020-11-04 12:28:15 -0800610#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
611 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100612 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100613
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100615}
616
Gilles Peskinef603c712019-01-19 13:40:11 +0100617/** Calculate the intersection of two algorithm usage policies.
618 *
619 * Return 0 (which allows no operation) on incompatibility.
620 */
621static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100622 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100623 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100625{
Gilles Peskine549ea862019-05-22 11:45:59 +0200626 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 if (alg1 == alg2) {
628 return alg1;
629 }
Steven Cooreman03488022021-02-18 12:07:20 +0100630 /* If the policies are from the same hash-and-sign family, check
631 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100632 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
633 PSA_ALG_IS_SIGN_HASH(alg2) &&
634 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
635 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
636 return alg2;
637 }
638 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
639 return alg1;
640 }
Steven Cooreman03488022021-02-18 12:07:20 +0100641 }
642 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100643 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100644 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
646 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
647 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
648 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
649 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100650 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100651
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100652 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
654 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
655 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
656 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100657 }
658 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
660 (alg1_len <= alg2_len)) {
661 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100662 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100663 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
664 (alg2_len <= alg1_len)) {
665 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100666 }
667 }
668 /* If the policies are from the same MAC family, check whether one
669 * of them is a minimum-MAC-length policy. Calculate the most
670 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
672 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
673 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100674 /* Validate the combination of key type and algorithm. Since the base
675 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
677 return 0;
678 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100679
Steven Cooreman31a876d2021-03-03 20:47:40 +0100680 /* Get the (exact or at-least) output lengths for both sides of the
681 * requested intersection. None of the currently supported algorithms
682 * have an output length dependent on the actual key size, so setting it
683 * to a bogus value of 0 is currently OK.
684 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100685 * Note that for at-least-this-length wildcard algorithms, the output
686 * length is set to the shortest allowed length, which allows us to
687 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
689 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100690 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100691
Steven Cooremana1d83222021-02-25 10:20:29 +0100692 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
694 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
695 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100696 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100697
698 /* If only one is an at-least-this-length policy, the intersection would
699 * be the other (fixed-length) policy as long as said fixed length is
700 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
702 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100703 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
705 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100706 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100707
Steven Cooremancd640932021-03-08 12:00:27 +0100708 /* If none of them are wildcards, check whether they define the same tag
709 * length. This is still possible here when one is default-length and
710 * the other specific-length. Ensure to always return the
711 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 if (alg1_len == alg2_len) {
713 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
714 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100715 }
716 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100718}
719
Gilles Peskine449bd832023-01-11 14:50:10 +0100720static int psa_key_algorithm_permits(psa_key_type_t key_type,
721 psa_algorithm_t policy_alg,
722 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200723{
Gilles Peskine549ea862019-05-22 11:45:59 +0200724 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 if (requested_alg == policy_alg) {
726 return 1;
727 }
Steven Cooreman03488022021-02-18 12:07:20 +0100728 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
729 * and requested_alg is the same hash-and-sign family with any hash,
730 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
732 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
733 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
734 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100735 }
736 /* If policy_alg is a wildcard AEAD algorithm of the same base as
737 * the requested algorithm, check the requested tag length to be
738 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 if (PSA_ALG_IS_AEAD(policy_alg) &&
740 PSA_ALG_IS_AEAD(requested_alg) &&
741 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
742 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
743 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
744 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
745 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100746 }
Steven Cooremancd640932021-03-08 12:00:27 +0100747 /* If policy_alg is a MAC algorithm of the same base as the requested
748 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 if (PSA_ALG_IS_MAC(policy_alg) &&
750 PSA_ALG_IS_MAC(requested_alg) &&
751 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
752 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100753 /* Validate the combination of key type and algorithm. Since the policy
754 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
756 return 0;
757 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100758
Steven Cooreman31a876d2021-03-03 20:47:40 +0100759 /* Get both the requested output length for the algorithm which is to be
760 * verified, and the default output length for the base algorithm.
761 * Note that none of the currently supported algorithms have an output
762 * length dependent on actual key size, so setting it to a bogus value
763 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100764 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100766 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 key_type, 0,
768 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100769
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100770 /* If the policy is default-length, only allow an algorithm with
771 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
773 return requested_output_length == default_output_length;
774 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100775
776 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100777 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
779 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
780 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100781 }
782
Steven Cooremancd640932021-03-08 12:00:27 +0100783 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
784 * check for the requested MAC length to be equal to or longer than the
785 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
787 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
788 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100789 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200790 }
Steven Cooremance48e852020-10-05 16:02:45 +0200791 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200792 * a key derivation with that key agreement should also be allowed. This
793 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
795 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
796 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
797 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200798 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100799 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200801}
802
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100803/** Test whether a policy permits an algorithm.
804 *
805 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100806 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100807 * \note This function requires providing the key type for which the policy is
808 * being validated, since some algorithm policy definitions (e.g. MAC)
809 * have different properties depending on what kind of cipher it is
810 * combined with.
811 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100812 * \retval PSA_SUCCESS When \p alg is a specific algorithm
813 * allowed by the \p policy.
814 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
815 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
816 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100817 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100818static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
819 psa_key_type_t key_type,
820 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100821{
Steven Cooremand788fab2021-02-25 11:29:17 +0100822 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100823 if (alg == 0) {
824 return PSA_ERROR_INVALID_ARGUMENT;
825 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100826
Steven Cooreman7e39f052021-02-23 14:18:32 +0100827 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 if (PSA_ALG_IS_WILDCARD(alg)) {
829 return PSA_ERROR_INVALID_ARGUMENT;
830 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
833 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
834 return PSA_SUCCESS;
835 } else {
836 return PSA_ERROR_NOT_PERMITTED;
837 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100838}
839
Gilles Peskinef603c712019-01-19 13:40:11 +0100840/** Restrict a key policy based on a constraint.
841 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100842 * \note This function requires providing the key type for which the policy is
843 * being restricted, since some algorithm policy definitions (e.g. MAC)
844 * have different properties depending on what kind of cipher it is
845 * combined with.
846 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100847 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100848 * \param[in,out] policy The policy to restrict.
849 * \param[in] constraint The policy constraint to apply.
850 *
851 * \retval #PSA_SUCCESS
852 * \c *policy contains the intersection of the original value of
853 * \c *policy and \c *constraint.
854 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100855 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100856 * \c *policy is unchanged.
857 */
858static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100859 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100860 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100862{
863 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100864 psa_key_policy_algorithm_intersection(key_type, policy->alg,
865 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200866 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
868 constraint->alg2);
869 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
870 return PSA_ERROR_INVALID_ARGUMENT;
871 }
872 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
873 return PSA_ERROR_INVALID_ARGUMENT;
874 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 policy->usage &= constraint->usage;
876 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100878 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100879}
880
Przemek Stekiel348410f2022-11-15 22:22:07 +0100881psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100882 mbedtls_svc_key_id_t key,
883 psa_key_slot_t **p_slot,
884 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100885 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100886{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200887 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
888 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100889
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 status = psa_get_and_lock_key_slot(key, p_slot);
891 if (status != PSA_SUCCESS) {
892 return status;
893 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200894 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100895
896 /* Enforce that usage policy for the key slot contains all the flags
897 * required by the usage parameter. There is one exception: public
898 * keys can always be exported, so we treat public key objects as
899 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100901 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903
Gilles Peskine449bd832023-01-11 14:50:10 +0100904 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100905 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200906 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100907 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100908
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800909 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 if (alg != 0) {
911 status = psa_key_policy_permits(&slot->attr.policy,
912 slot->attr.type,
913 alg);
914 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100915 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100917 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100918
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200920
921error:
922 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200924
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100926}
Darryl Green940d72c2018-07-13 13:18:51 +0100927
Ronald Cron5c522922020-11-14 16:35:34 +0100928/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200929 *
930 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200931 * available, as opposed to a key in a secure element and/or to be used
932 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200933 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200934 * This is a temporary function that may be used instead of
935 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
936 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937 *
Ronald Cron5c522922020-11-14 16:35:34 +0100938 * On success, the returned key slot is locked. It is the responsibility of the
939 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 */
Ronald Cron5c522922020-11-14 16:35:34 +0100941static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
942 mbedtls_svc_key_id_t key,
943 psa_key_slot_t **p_slot,
944 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200946{
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
948 usage, alg);
949 if (status != PSA_SUCCESS) {
950 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200951 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
954 psa_unlock_key_slot(*p_slot);
955 *p_slot = NULL;
956 return PSA_ERROR_NOT_SUPPORTED;
957 }
958
959 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200960}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961
Gilles Peskine449bd832023-01-11 14:50:10 +0100962psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000963{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100964 /* Data pointer will always be either a valid pointer or NULL in an
965 * initialized slot, so we can just free it. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 if (slot->key.data != NULL) {
967 mbedtls_platform_zeroize(slot->key.data, slot->key.bytes);
968 }
Ronald Cronea0f8a62020-11-25 17:52:23 +0100969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 mbedtls_free(slot->key.data);
Ronald Cronea0f8a62020-11-25 17:52:23 +0100971 slot->key.data = NULL;
972 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000973
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +0000975}
976
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100977/** Completely wipe a slot in memory, including its policy.
978 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100979psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100980{
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +0100982
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 /*
984 * As the return error code may not be handled in case of multiple errors,
985 * do our best to report an unexpected lock counter. Assert with
986 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
987 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
988 * function is called as part of the execution of a test suite, the
989 * execution of the test suite is stopped in error if the assertion fails.
990 */
991 if (slot->lock_count != 1) {
992 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +0100993 status = PSA_ERROR_CORRUPTION_DETECTED;
994 }
995
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200996 /* Multipart operations may still be using the key. This is safe
997 * because all multipart operation objects are independent from
998 * the key slot: if they need to access the key after the setup
999 * phase, they have a copy of the key. Note that this means that
1000 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001001 /* At this point, key material and other type-specific content has
1002 * been wiped. Clear remaining metadata. We can call memset and not
1003 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 memset(slot, 0, sizeof(*slot));
1005 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001009{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001010 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001011 psa_status_t status; /* status of the last operation */
1012 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001013#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1014 psa_se_drv_table_entry_t *driver;
1015#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 if (mbedtls_svc_key_id_is_null(key)) {
1018 return PSA_SUCCESS;
1019 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001020
Ronald Cronf2911112020-10-29 17:51:10 +01001021 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001022 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001023 * key, this will load the key description from persistent memory if not
1024 * done yet. We cannot avoid this loading as without it we don't know if
1025 * the key is operated by an SE or not and this information is needed by
1026 * the current implementation.
1027 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 status = psa_get_and_lock_key_slot(key, &slot);
1029 if (status != PSA_SUCCESS) {
1030 return status;
1031 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001032
Ronald Cronf2911112020-10-29 17:51:10 +01001033 /*
1034 * If the key slot containing the key description is under access by the
1035 * library (apart from the present access), the key cannot be destroyed
1036 * yet. For the time being, just return in error. Eventually (to be
1037 * implemented), the key should be destroyed when all accesses have
1038 * stopped.
1039 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (slot->lock_count > 1) {
1041 psa_unlock_key_slot(slot);
1042 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001043 }
1044
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001046 /* Refuse the destruction of a read-only key (which may or may not work
1047 * if we attempt it, depending on whether the key is merely read-only
1048 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001049 * Just do the best we can, which is to wipe the copy in memory
1050 * (done in this function's cleanup code). */
1051 overall_status = PSA_ERROR_NOT_PERMITTED;
1052 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001053 }
1054
Gilles Peskine354f7672019-07-12 23:46:38 +02001055#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1057 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001058 /* For a key in a secure element, we need to do three things:
1059 * remove the key file in internal storage, destroy the
1060 * key inside the secure element, and update the driver's
1061 * persistent data. Start a transaction that will encompass these
1062 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001064 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001066 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 status = psa_crypto_save_transaction();
1068 if (status != PSA_SUCCESS) {
1069 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001070 /* We should still try to destroy the key in the secure
1071 * element and the key metadata in storage. This is especially
1072 * important if the error is that the storage is full.
1073 * But how to do it exactly without risking an inconsistent
1074 * state after a reset?
1075 * https://github.com/ARMmbed/mbed-crypto/issues/215
1076 */
1077 overall_status = status;
1078 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001079 }
1080
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 status = psa_destroy_se_key(driver,
1082 psa_key_slot_get_slot_number(slot));
1083 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001084 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001086 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001087#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1088
Darryl Greend49a4992018-06-18 17:27:26 +01001089#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1091 status = psa_destroy_persistent_key(slot->attr.id);
1092 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001093 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001095
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001096 /* TODO: other slots may have a copy of the same key. We should
1097 * invalidate them.
1098 * https://github.com/ARMmbed/mbed-crypto/issues/214
1099 */
Darryl Greend49a4992018-06-18 17:27:26 +01001100 }
1101#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001102
Gilles Peskinefc762652019-07-22 19:30:34 +02001103#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 if (driver != NULL) {
1105 status = psa_save_se_persistent_data(driver);
1106 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001107 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 }
1109 status = psa_crypto_stop_transaction();
1110 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001111 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001113 }
1114#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1115
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001116exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001118 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001120 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 }
1122 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001123}
1124
John Durkop07cc04a2020-11-16 22:08:34 -08001125#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001126 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001127static psa_status_t psa_get_rsa_public_exponent(
1128 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001130{
1131 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001133 uint8_t *buffer = NULL;
1134 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1138 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001139 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 }
1141 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001142 /* It's the default value, which is reported as an empty string,
1143 * so there's nothing to do. */
1144 goto exit;
1145 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 buflen = mbedtls_mpi_size(&mpi);
1148 buffer = mbedtls_calloc(1, buflen);
1149 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001150 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1151 goto exit;
1152 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1154 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001155 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001157 attributes->domain_parameters = buffer;
1158 attributes->domain_parameters_size = buflen;
1159
1160exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 mbedtls_mpi_free(&mpi);
1162 if (ret != 0) {
1163 mbedtls_free(buffer);
1164 }
1165 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001166}
John Durkop07cc04a2020-11-16 22:08:34 -08001167#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001168 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001169
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001170/** Retrieve all the publicly-accessible attributes of a key.
1171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001172psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1173 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001174{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001176 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001177 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001180
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1182 if (status != PSA_SUCCESS) {
1183 return status;
1184 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001185
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001186 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1188 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001189
1190#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1192 psa_set_key_slot_number(attributes,
1193 psa_key_slot_get_slot_number(slot));
1194 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001195#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001196
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 switch (slot->attr.type) {
John Durkop07cc04a2020-11-16 22:08:34 -08001198#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001199 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001200 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001201 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001202 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001203 * is not yet implemented.
1204 * https://github.com/ARMmbed/mbed-crypto/issues/216
1205 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001207 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001208
Ronald Cron90857082020-11-25 14:58:33 +01001209 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 slot->attr.type,
1211 slot->key.data,
1212 slot->key.bytes,
1213 &rsa);
1214 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001215 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001217
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 status = psa_get_rsa_public_exponent(rsa,
1219 attributes);
1220 mbedtls_rsa_free(rsa);
1221 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001222 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001224#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001225 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001226 default:
1227 /* Nothing else to do. */
1228 break;
1229 }
1230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 if (status != PSA_SUCCESS) {
1232 psa_reset_key_attributes(attributes);
1233 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001236
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001238}
1239
Gilles Peskinec8000c02019-08-02 20:15:51 +02001240#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1241psa_status_t psa_get_key_slot_number(
1242 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001244{
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001246 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 return PSA_SUCCESS;
1248 } else {
1249 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001250 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001251}
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1255 size_t key_buffer_size,
1256 uint8_t *data,
1257 size_t data_size,
1258 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001259{
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 if (key_buffer_size > data_size) {
1261 return PSA_ERROR_BUFFER_TOO_SMALL;
1262 }
1263 memcpy(data, key_buffer, key_buffer_size);
1264 memset(data + key_buffer_size, 0,
1265 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001266 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001268}
1269
Ronald Cron7285cda2020-11-26 14:46:37 +01001270psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001271 const psa_key_attributes_t *attributes,
1272 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001274{
Ronald Crond18b5f82020-11-25 16:46:05 +01001275 psa_key_type_t type = attributes->core.type;
1276
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 if (key_type_is_raw_bytes(type) ||
1278 PSA_KEY_TYPE_IS_RSA(type) ||
1279 PSA_KEY_TYPE_IS_ECC(type)) {
1280 return psa_export_key_buffer_internal(
1281 key_buffer, key_buffer_size,
1282 data, data_size, data_length);
1283 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001284 /* This shouldn't happen in the reference implementation, but
1285 it is valid for a special-purpose implementation to omit
1286 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001288 }
1289}
1290
Gilles Peskine449bd832023-01-11 14:50:10 +01001291psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1292 uint8_t *data,
1293 size_t data_size,
1294 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001295{
1296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1297 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1298 psa_key_slot_t *slot;
1299
Ronald Crone907e552021-01-18 13:22:38 +01001300 /* Reject a zero-length output buffer now, since this can never be a
1301 * valid key representation. This way we know that data must be a valid
1302 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 if (data_size == 0) {
1304 return PSA_ERROR_BUFFER_TOO_SMALL;
1305 }
Ronald Crone907e552021-01-18 13:22:38 +01001306
Ronald Cron9486f9d2020-11-26 13:36:23 +01001307 /* Set the key to empty now, so that even when there are errors, we always
1308 * set data_length to a value between 0 and data_size. On error, setting
1309 * the key to empty is a good choice because an empty key representation is
1310 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001311 *data_length = 0;
1312
Ronald Cron9486f9d2020-11-26 13:36:23 +01001313 /* Export requires the EXPORT flag. There is an exception for public keys,
1314 * which don't require any flag, but
1315 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1316 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1318 PSA_KEY_USAGE_EXPORT, 0);
1319 if (status != PSA_SUCCESS) {
1320 return status;
1321 }
mohammad160306e79202018-03-28 13:17:44 +03001322
Ronald Crond18b5f82020-11-25 16:46:05 +01001323 psa_key_attributes_t attributes = {
1324 .core = slot->attr
1325 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 status = psa_driver_wrapper_export_key(&attributes,
1327 slot->key.data, slot->key.bytes,
1328 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001331
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333}
1334
Ronald Cron7285cda2020-11-26 14:46:37 +01001335psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001336 const psa_key_attributes_t *attributes,
1337 const uint8_t *key_buffer,
1338 size_t key_buffer_size,
1339 uint8_t *data,
1340 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342{
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type)) {
1346 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type)) {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001347 /* Exporting public -> public */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 return psa_export_key_buffer_internal(
1349 key_buffer, key_buffer_size,
1350 data, data_size, data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001351 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001352
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 if (PSA_KEY_TYPE_IS_RSA(type)) {
John Durkop0e005192020-10-31 22:06:54 -07001354#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1356 return mbedtls_psa_rsa_export_public_key(attributes,
1357 key_buffer,
1358 key_buffer_size,
1359 data,
1360 data_size,
1361 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001362#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001363 /* We don't know how to convert a private RSA key to public. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001365#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1366 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 } else {
John Durkop6ba40d12020-11-10 08:50:04 -08001368#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1370 return mbedtls_psa_ecp_export_public_key(attributes,
1371 key_buffer,
1372 key_buffer_size,
1373 data,
1374 data_size,
1375 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001376#else
1377 /* We don't know how to convert a private ECC key to public */
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001379#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1380 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001381 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 } else {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001383 /* This shouldn't happen in the reference implementation, but
1384 it is valid for a special-purpose implementation to omit
1385 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001387 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001388}
Ronald Crond18b5f82020-11-25 16:46:05 +01001389
Gilles Peskine449bd832023-01-11 14:50:10 +01001390psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1391 uint8_t *data,
1392 size_t data_size,
1393 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001394{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001396 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001397 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001398
Ronald Crone907e552021-01-18 13:22:38 +01001399 /* Reject a zero-length output buffer now, since this can never be a
1400 * valid key representation. This way we know that data must be a valid
1401 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 if (data_size == 0) {
1403 return PSA_ERROR_BUFFER_TOO_SMALL;
1404 }
Ronald Crone907e552021-01-18 13:22:38 +01001405
Darryl Greendd8fb772018-11-07 16:00:44 +00001406 /* Set the key to empty now, so that even when there are errors, we always
1407 * set data_length to a value between 0 and data_size. On error, setting
1408 * the key to empty is a good choice because an empty key representation is
1409 * unlikely to be accepted anywhere. */
1410 *data_length = 0;
1411
1412 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1414 if (status != PSA_SUCCESS) {
1415 return status;
1416 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1419 status = PSA_ERROR_INVALID_ARGUMENT;
1420 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421 }
1422
Ronald Crond18b5f82020-11-25 16:46:05 +01001423 psa_key_attributes_t attributes = {
1424 .core = slot->attr
1425 };
Ronald Cron67227982020-11-26 15:16:05 +01001426 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001429
1430exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001432
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001434}
1435
Gilles Peskine91e8c332019-08-02 19:19:39 +02001436#if defined(static_assert)
Gilles Peskine449bd832023-01-11 14:50:10 +01001437static_assert((MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1438 "One or more key attribute flag is listed as both external-only and dual-use");
1439static_assert((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1440 "One or more key attribute flag is listed as both internal-only and dual-use");
1441static_assert((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1442 "One or more key attribute flag is listed as both internal-only and external-only");
Gilles Peskine91e8c332019-08-02 19:19:39 +02001443#endif
1444
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001445/** Validate that a key policy is internally well-formed.
1446 *
1447 * This function only rejects invalid policies. It does not validate the
1448 * consistency of the policy with respect to other attributes of the key
1449 * such as the key type.
1450 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001451static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001452{
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1454 PSA_KEY_USAGE_COPY |
1455 PSA_KEY_USAGE_ENCRYPT |
1456 PSA_KEY_USAGE_DECRYPT |
1457 PSA_KEY_USAGE_SIGN_MESSAGE |
1458 PSA_KEY_USAGE_VERIFY_MESSAGE |
1459 PSA_KEY_USAGE_SIGN_HASH |
1460 PSA_KEY_USAGE_VERIFY_HASH |
1461 PSA_KEY_USAGE_VERIFY_DERIVATION |
1462 PSA_KEY_USAGE_DERIVE)) != 0) {
1463 return PSA_ERROR_INVALID_ARGUMENT;
1464 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001465
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001467}
1468
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001469/** Validate the internal consistency of key attributes.
1470 *
1471 * This function only rejects invalid attribute values. If does not
1472 * validate the consistency of the attributes with any key data that may
1473 * be involved in the creation of the key.
1474 *
1475 * Call this function early in the key creation process.
1476 *
1477 * \param[in] attributes Key attributes for the new key.
1478 * \param[out] p_drv On any return, the driver for the key, if any.
1479 * NULL for a transparent key.
1480 *
1481 */
1482static psa_status_t psa_validate_key_attributes(
1483 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001485{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001486 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1488 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 status = psa_validate_key_location(lifetime, p_drv);
1491 if (status != PSA_SUCCESS) {
1492 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001493 }
1494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 status = psa_validate_key_persistence(lifetime);
1496 if (status != PSA_SUCCESS) {
1497 return status;
1498 }
1499
1500 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1501 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1502 return PSA_ERROR_INVALID_ARGUMENT;
1503 }
1504 } else {
1505 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1506 return PSA_ERROR_INVALID_ARGUMENT;
1507 }
1508 }
1509
1510 status = psa_validate_key_policy(&attributes->core.policy);
1511 if (status != PSA_SUCCESS) {
1512 return status;
1513 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001514
1515 /* Refuse to create overly large keys.
1516 * Note that this doesn't trigger on import if the attributes don't
1517 * explicitly specify a size (so psa_get_key_bits returns 0), so
1518 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1520 return PSA_ERROR_NOT_SUPPORTED;
1521 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001522
Gilles Peskine91e8c332019-08-02 19:19:39 +02001523 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1525 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1526 return PSA_ERROR_INVALID_ARGUMENT;
1527 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001530}
1531
Gilles Peskine4747d192019-04-17 15:05:45 +02001532/** Prepare a key slot to receive key material.
1533 *
1534 * This function allocates a key slot and sets its metadata.
1535 *
1536 * If this function fails, call psa_fail_key_creation().
1537 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001538 * This function is intended to be used as follows:
1539 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001540 * it with the specified attributes, and in case of a volatile key assign it
1541 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001542 * -# Populate the slot with the key material.
1543 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1544 * In case of failure at any step, stop the sequence and call
1545 * psa_fail_key_creation().
1546 *
Ronald Cron5c522922020-11-14 16:35:34 +01001547 * On success, the key slot is locked. It is the responsibility of the caller
1548 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001549 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001550 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001551 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001552 * \param[out] p_slot On success, a pointer to the prepared slot.
1553 * \param[out] p_drv On any return, the driver for the key, if any.
1554 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001555 *
1556 * \retval #PSA_SUCCESS
1557 * The key slot is ready to receive key material.
1558 * \return If this function fails, the key slot is an invalid state.
1559 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001560 */
1561static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001562 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001563 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001564 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001566{
1567 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001568 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001569 psa_key_slot_t *slot;
1570
Gilles Peskinedf179142019-07-15 22:02:14 +02001571 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001572 *p_drv = NULL;
1573
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 status = psa_validate_key_attributes(attributes, p_drv);
1575 if (status != PSA_SUCCESS) {
1576 return status;
1577 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001578
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1580 if (status != PSA_SUCCESS) {
1581 return status;
1582 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 slot = *p_slot;
1584
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001585 /* We're storing the declared bit-size of the key. It's up to each
1586 * creation mechanism to verify that this information is correct.
1587 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001588 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001589 * is optional (import, copy). In case of a volatile key, assign it the
1590 * volatile key identifier associated to the slot returned to contain its
1591 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001592
1593 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001595#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1596 slot->attr.id = volatile_key_id;
1597#else
1598 slot->attr.id.key_id = volatile_key_id;
1599#endif
1600 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001601
Gilles Peskine91e8c332019-08-02 19:19:39 +02001602 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001603 * external-only flags, query `attributes`. Thanks to the check
1604 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001605 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001606 * may have set. */
1607 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001608
Gilles Peskinecbaff462019-07-12 23:46:04 +02001609#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001610 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001611 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001612 * create the key file in internal storage, create the
1613 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001614 * persistent data. This is done by starting a transaction that will
1615 * encompass these three actions.
1616 * For registering a volatile key, we just need to find an appropriate
1617 * slot number inside the SE. Since the key is designated volatile, creating
1618 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001619 /* The first thing to do is to find a slot number for the new key.
1620 * We save the slot number in persistent storage as part of the
1621 * transaction data. It will be needed to recover if the power
1622 * fails during the key creation process, to clean up on the secure
1623 * element side after restarting. Obtaining a slot number from the
1624 * secure element driver updates its persistent state, but we do not yet
1625 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001626 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001628 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1630 &slot_number);
1631 if (status != PSA_SUCCESS) {
1632 return status;
1633 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1636 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001637 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001638 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001639 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 status = psa_crypto_save_transaction();
1641 if (status != PSA_SUCCESS) {
1642 (void) psa_crypto_stop_transaction();
1643 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001644 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001645 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001646
1647 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001649 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001652 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001654 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001655#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001658}
Gilles Peskine4747d192019-04-17 15:05:45 +02001659
1660/** Finalize the creation of a key once its key material has been set.
1661 *
1662 * This entails writing the key to persistent storage.
1663 *
1664 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001665 * See the documentation of psa_start_key_creation() for the intended use
1666 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001667 *
Ronald Cron5c522922020-11-14 16:35:34 +01001668 * If the finalization succeeds, the function unlocks the key slot (it was
1669 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1670 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001671 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001672 * \param[in,out] slot Pointer to the slot with key material.
1673 * \param[in] driver The secure element driver for the key,
1674 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001675 * \param[out] key On success, identifier of the key. Note that the
1676 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001677 *
1678 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001679 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001680 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1681 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1682 * \retval #PSA_ERROR_ALREADY_EXISTS
1683 * \retval #PSA_ERROR_DATA_INVALID
1684 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001685 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001686 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001687 * \return If this function fails, the key slot is an invalid state.
1688 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001689 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001690static psa_status_t psa_finish_key_creation(
1691 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001692 psa_se_drv_table_entry_t *driver,
1693 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001694{
1695 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001696 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001697 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001698
1699#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001701#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001703 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001704 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001706
Gilles Peskineb46bef22019-07-30 21:32:04 +02001707#if defined(static_assert)
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 static_assert(sizeof(slot_number) ==
1709 sizeof(data.slot_number),
1710 "Slot number size does not match psa_se_key_data_storage_t");
Gilles Peskineb46bef22019-07-30 21:32:04 +02001711#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1713 status = psa_save_persistent_key(&slot->attr,
1714 (uint8_t *) &data,
1715 sizeof(data));
1716 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001717#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1718 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001719 /* Key material is saved in export representation in the slot, so
1720 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 status = psa_save_persistent_key(&slot->attr,
1722 slot->key.data,
1723 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001724 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001725 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001726#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1727
Gilles Peskinecbaff462019-07-12 23:46:04 +02001728#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001729 /* Finish the transaction for a key creation. This does not
1730 * happen when registering an existing key. Detect this case
1731 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001732 * creation of a persistent key in a secure element requires a transaction,
1733 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (driver != NULL &&
1735 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1736 status = psa_save_se_persistent_data(driver);
1737 if (status != PSA_SUCCESS) {
1738 psa_destroy_persistent_key(slot->attr.id);
1739 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001740 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001742 }
1743#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1744
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001746 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 status = psa_unlock_key_slot(slot);
1748 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001749 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001751 }
Ronald Cron50972942020-11-14 11:28:25 +01001752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001754}
1755
1756/** Abort the creation of a key.
1757 *
1758 * You may call this function after calling psa_start_key_creation(),
1759 * or after psa_finish_key_creation() fails. In other circumstances, this
1760 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001761 * See the documentation of psa_start_key_creation() for the intended use
1762 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001763 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001764 * \param[in,out] slot Pointer to the slot with key material.
1765 * \param[in] driver The secure element driver for the key,
1766 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001767 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001768static void psa_fail_key_creation(psa_key_slot_t *slot,
1769 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001770{
Gilles Peskine011e4282019-06-26 18:34:38 +02001771 (void) driver;
1772
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001776
1777#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001778 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001779 * element, and the failure happened later (when saving metadata
1780 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001781 * element.
1782 * https://github.com/ARMmbed/mbed-crypto/issues/217
1783 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001784
Gilles Peskined7729582019-08-05 15:55:54 +02001785 /* Abort the ongoing transaction if any (there may not be one if
1786 * the creation process failed before starting one, or if the
1787 * key creation is a registration of a key in a secure element).
1788 * Earlier functions must already have done what it takes to undo any
1789 * partial creation. All that's left is to update the transaction data
1790 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001792#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1793
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001795}
1796
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001797/** Validate optional attributes during key creation.
1798 *
1799 * Some key attributes are optional during key creation. If they are
1800 * specified in the attributes structure, check that they are consistent
1801 * with the data in the slot.
1802 *
1803 * This function should be called near the end of key creation, after
1804 * the slot in memory is fully populated but before saving persistent data.
1805 */
1806static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001807 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001809{
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 if (attributes->core.type != 0) {
1811 if (attributes->core.type != slot->attr.type) {
1812 return PSA_ERROR_INVALID_ARGUMENT;
1813 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001814 }
1815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (attributes->domain_parameters_size != 0) {
John Durkop0e005192020-10-31 22:06:54 -07001817#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1819 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001820 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001821 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001822 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001823
Ronald Cron90857082020-11-25 14:58:33 +01001824 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 slot->attr.type,
1826 slot->key.data,
1827 slot->key.bytes,
1828 &rsa);
1829 if (status != PSA_SUCCESS) {
1830 return status;
1831 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 mbedtls_mpi_init(&actual);
1834 mbedtls_mpi_init(&required);
1835 ret = mbedtls_rsa_export(rsa,
1836 NULL, NULL, NULL, NULL, &actual);
1837 mbedtls_rsa_free(rsa);
1838 mbedtls_free(rsa);
1839 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 }
1842 ret = mbedtls_mpi_read_binary(&required,
1843 attributes->domain_parameters,
1844 attributes->domain_parameters_size);
1845 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001846 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 }
1848 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001849 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 }
1851rsa_exit:
1852 mbedtls_mpi_free(&actual);
1853 mbedtls_mpi_free(&required);
1854 if (ret != 0) {
1855 return mbedtls_to_psa_error(ret);
1856 }
1857 } else
John Durkop9814fa22020-11-04 12:28:15 -08001858#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1859 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001862 }
1863 }
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 if (attributes->core.bits != 0) {
1866 if (attributes->core.bits != slot->attr.bits) {
1867 return PSA_ERROR_INVALID_ARGUMENT;
1868 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 }
1870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001872}
1873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1875 const uint8_t *data,
1876 size_t data_length,
1877 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001878{
1879 psa_status_t status;
1880 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001881 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001882 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301883 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884
Ronald Cron81709fc2020-11-14 12:10:32 +01001885 *key = MBEDTLS_SVC_KEY_ID_INIT;
1886
Gilles Peskine0f84d622019-09-12 19:03:13 +02001887 /* Reject zero-length symmetric keys (including raw data key objects).
1888 * This also rejects any key which might be encoded as an empty string,
1889 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 if (data_length == 0) {
1891 return PSA_ERROR_INVALID_ARGUMENT;
1892 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001893
Archana449608b2021-09-08 15:36:05 +05301894 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 if (data_length > SIZE_MAX / 8) {
1896 return PSA_ERROR_NOT_SUPPORTED;
1897 }
Archana6ed4bda2021-08-04 10:47:15 +05301898
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1900 &slot, &driver);
1901 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001902 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001905 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301906 * storage ( thus not in the case of importing a key in a secure element
1907 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1908 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (slot->key.data == NULL) {
1910 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05301911 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 attributes, data, data_length, &storage_size);
1913 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05301914 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 }
Archanad8a83dc2021-06-14 10:04:16 +05301916 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 status = psa_allocate_buffer_to_slot(slot, storage_size);
1918 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001919 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001921 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001922
1923 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 status = psa_driver_wrapper_import_key(attributes,
1925 data, data_length,
1926 slot->key.data,
1927 slot->key.bytes,
1928 &slot->key.bytes, &bits);
1929 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001930 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001932
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001934 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001936 status = PSA_ERROR_INVALID_ARGUMENT;
1937 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001938 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001939
Archana6ed4bda2021-08-04 10:47:15 +05301940 /* Enforce a size limit, and in particular ensure that the bit
1941 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05301943 status = PSA_ERROR_NOT_SUPPORTED;
1944 goto exit;
1945 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 status = psa_validate_optional_attributes(slot, attributes);
1947 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02001948 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001950
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001952exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (status != PSA_SUCCESS) {
1954 psa_fail_key_creation(slot, driver);
1955 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001956
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001958}
1959
Gilles Peskined7729582019-08-05 15:55:54 +02001960#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1961psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02001963{
1964 psa_status_t status;
1965 psa_key_slot_t *slot = NULL;
1966 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001967 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001968
1969 /* Leaving attributes unspecified is not currently supported.
1970 * It could make sense to query the key type and size from the
1971 * secure element, but not all secure elements support this
1972 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
1974 return PSA_ERROR_NOT_SUPPORTED;
1975 }
1976 if (psa_get_key_bits(attributes) == 0) {
1977 return PSA_ERROR_NOT_SUPPORTED;
1978 }
Gilles Peskined7729582019-08-05 15:55:54 +02001979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
1981 &slot, &driver);
1982 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02001983 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Gilles Peskined7729582019-08-05 15:55:54 +02001985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02001987
1988exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 if (status != PSA_SUCCESS) {
1990 psa_fail_key_creation(slot, driver);
1991 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001992
Gilles Peskined7729582019-08-05 15:55:54 +02001993 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 psa_close_key(key);
1995 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02001996}
1997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2000 const psa_key_attributes_t *specified_attributes,
2001 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002002{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002004 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002005 psa_key_slot_t *source_slot = NULL;
2006 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002007 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002008 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302009 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002010
Ronald Cron81709fc2020-11-14 12:10:32 +01002011 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2012
Archana8a180362021-07-05 02:18:48 +05302013 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2015 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002016 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002018
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 status = psa_validate_optional_attributes(source_slot,
2020 specified_attributes);
2021 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002024
Archana9d17bf42021-09-10 06:22:44 +05302025 /* The target key type and number of bits have been validated by
2026 * psa_validate_optional_attributes() to be either equal to zero or
2027 * equal to the ones of the source key. So it is safe to inherit
2028 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302029 * */
Archana9d17bf42021-09-10 06:22:44 +05302030 actual_attributes.core.bits = source_slot->attr.bits;
2031 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302032
2033
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 status = psa_restrict_key_policy(source_slot->attr.type,
2035 &actual_attributes.core.policy,
2036 &source_slot->attr.policy);
2037 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002038 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2042 &target_slot, &driver);
2043 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002044 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 }
2046 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2047 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302048 /*
Archana9d17bf42021-09-10 06:22:44 +05302049 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302050 * the source key would need to be exported as plaintext and re-imported
2051 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302052 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302053 * appropriate API invocations from the application, if needed.
2054 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002055 status = PSA_ERROR_NOT_SUPPORTED;
2056 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002057 }
Archana8a180362021-07-05 02:18:48 +05302058 /*
2059 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302060 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302061 * - For opaque keys this translates to an invocation of the drivers'
2062 * copy_key entry point through the dispatch layer.
2063 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2065 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2066 &storage_size);
2067 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302068 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 }
Archana374fe5b2021-09-08 15:50:28 +05302070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2072 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302073 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 }
Archana374fe5b2021-09-08 15:50:28 +05302075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 status = psa_driver_wrapper_copy_key(&actual_attributes,
2077 source_slot->key.data,
2078 source_slot->key.bytes,
2079 target_slot->key.data,
2080 target_slot->key.bytes,
2081 &target_slot->key.bytes);
2082 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302083 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 }
2085 } else {
2086 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302087 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 source_slot->key.bytes);
2089 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302090 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 }
Archana8a180362021-07-05 02:18:48 +05302092 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (status != PSA_SUCCESS) {
2096 psa_fail_key_creation(target_slot, driver);
2097 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002102}
2103
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002104
2105
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002106/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002107/* Message digests */
2108/****************************************************************/
2109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002111{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002112 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (operation->id == 0) {
2114 return PSA_SUCCESS;
2115 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002116
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002118 operation->id = 0;
2119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002121}
2122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2124 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002125{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002127
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002128 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002130 status = PSA_ERROR_BAD_STATE;
2131 goto exit;
2132 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002135 status = PSA_ERROR_INVALID_ARGUMENT;
2136 goto exit;
2137 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002138
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002139 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2140 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002144
2145exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 if (status != PSA_SUCCESS) {
2147 psa_hash_abort(operation);
2148 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002149
2150 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002151}
2152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2154 const uint8_t *input,
2155 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002157 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002160 status = PSA_ERROR_BAD_STATE;
2161 goto exit;
2162 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002163
Steven Cooremanc8288352021-03-04 14:02:19 +01002164 /* Don't require hash implementations to behave correctly on a
2165 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 if (input_length == 0) {
2167 return PSA_SUCCESS;
2168 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002171
2172exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (status != PSA_SUCCESS) {
2174 psa_hash_abort(operation);
2175 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002178}
2179
Gilles Peskine449bd832023-01-11 14:50:10 +01002180psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2181 uint8_t *hash,
2182 size_t hash_size,
2183 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002184{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002185 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 if (operation->id == 0) {
2187 return PSA_ERROR_BAD_STATE;
2188 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002189
Steven Cooreman1e582352021-02-18 17:24:37 +01002190 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 operation, hash, hash_size, hash_length);
2192 psa_hash_abort(operation);
2193 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194}
2195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2197 const uint8_t *hash,
2198 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002199{
Ronald Cron69a63422021-10-18 09:47:58 +02002200 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002202 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 operation,
2204 actual_hash, sizeof(actual_hash),
2205 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002208 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002212 status = PSA_ERROR_INVALID_SIGNATURE;
2213 goto exit;
2214 }
2215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002217 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002219
2220exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2222 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002223 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002227}
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229psa_status_t psa_hash_compute(psa_algorithm_t alg,
2230 const uint8_t *input, size_t input_length,
2231 uint8_t *hash, size_t hash_size,
2232 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002233{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002234 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (!PSA_ALG_IS_HASH(alg)) {
2236 return PSA_ERROR_INVALID_ARGUMENT;
2237 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2240 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002241}
2242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243psa_status_t psa_hash_compare(psa_algorithm_t alg,
2244 const uint8_t *input, size_t input_length,
2245 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002246{
Ronald Cron69a63422021-10-18 09:47:58 +02002247 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002248 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (!PSA_ALG_IS_HASH(alg)) {
2251 return PSA_ERROR_INVALID_ARGUMENT;
2252 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002253
Steven Cooreman1e582352021-02-18 17:24:37 +01002254 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 alg, input, input_length,
2256 actual_hash, sizeof(actual_hash),
2257 &actual_hash_length);
2258 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 }
2261 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002262 status = PSA_ERROR_INVALID_SIGNATURE;
2263 goto exit;
2264 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002266 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002268
2269exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2271 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002272}
2273
Gilles Peskine449bd832023-01-11 14:50:10 +01002274psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2275 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002276{
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if (source_operation->id == 0 ||
2278 target_operation->id != 0) {
2279 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002280 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2283 target_operation);
2284 if (status != PSA_SUCCESS) {
2285 psa_hash_abort(target_operation);
2286 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002289}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290
2291
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002292/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002293/* MAC */
2294/****************************************************************/
2295
Gilles Peskine449bd832023-01-11 14:50:10 +01002296psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002297{
Steven Cooremane6804192021-03-19 18:28:56 +01002298 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 if (operation->id == 0) {
2300 return PSA_SUCCESS;
2301 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002304 operation->mac_size = 0;
2305 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002306 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002309}
2310
Ronald Cron2dff3b22021-06-17 16:33:22 +02002311static psa_status_t psa_mac_finalize_alg_and_key_validation(
2312 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002313 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002315{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 psa_key_type_t key_type = psa_get_key_type(attributes);
2318 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if (!PSA_ALG_IS_MAC(alg)) {
2321 return PSA_ERROR_INVALID_ARGUMENT;
2322 }
Steven Cooremane6804192021-03-19 18:28:56 +01002323
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002324 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 status = psa_mac_key_can_do(alg, key_type);
2326 if (status != PSA_SUCCESS) {
2327 return status;
2328 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002329
Steven Cooremand1a68f12021-05-10 11:13:41 +02002330 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002332
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002334 /* A very short MAC is too short for security since it can be
2335 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2336 * so we make this our minimum, even though 32 bits is still
2337 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002339 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2342 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002343 /* It's impossible to "truncate" to a larger length than the full length
2344 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002346 }
2347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002349 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2350 * that is disabled in the compile-time configuration. The result can
2351 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2352 * configuration into account. In this case, force a return of
2353 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2354 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2355 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2356 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2357 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002359 }
2360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002362}
2363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2365 mbedtls_svc_key_id_t key,
2366 psa_algorithm_t alg,
2367 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002368{
2369 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2370 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002371 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002372
2373 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002375 status = PSA_ERROR_BAD_STATE;
2376 goto exit;
2377 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002378
2379 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 key,
2381 &slot,
2382 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2383 alg);
2384 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002385 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002387
2388 psa_key_attributes_t attributes = {
2389 .core = slot->attr
2390 };
2391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2393 &operation->mac_size);
2394 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002395 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002397
2398 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002399 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 if (is_sign) {
2401 status = psa_driver_wrapper_mac_sign_setup(operation,
2402 &attributes,
2403 slot->key.data,
2404 slot->key.bytes,
2405 alg);
2406 } else {
2407 status = psa_driver_wrapper_mac_verify_setup(operation,
2408 &attributes,
2409 slot->key.data,
2410 slot->key.bytes,
2411 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002413
Gilles Peskinefbfac682018-07-08 20:51:54 +02002414exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (status != PSA_SUCCESS) {
2416 psa_mac_abort(operation);
2417 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002418
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002420
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002422}
2423
Gilles Peskine449bd832023-01-11 14:50:10 +01002424psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2425 mbedtls_svc_key_id_t key,
2426 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002427{
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002429}
2430
Gilles Peskine449bd832023-01-11 14:50:10 +01002431psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2432 mbedtls_svc_key_id_t key,
2433 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002434{
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002436}
2437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2439 const uint8_t *input,
2440 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441{
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (operation->id == 0) {
2443 return PSA_ERROR_BAD_STATE;
2444 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002445
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002446 /* Don't require hash implementations to behave correctly on a
2447 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 if (input_length == 0) {
2449 return PSA_SUCCESS;
2450 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2453 input, input_length);
2454 if (status != PSA_SUCCESS) {
2455 psa_mac_abort(operation);
2456 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002459}
2460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2462 uint8_t *mac,
2463 size_t mac_size,
2464 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002465{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002466 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2467 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002470 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002471 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002472 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002475 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002476 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002477 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002478
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002479 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2480 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002482 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002483 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002484 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002487 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002488 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002489 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 status = psa_driver_wrapper_mac_sign_finish(operation,
2492 mac, operation->mac_size,
2493 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002494
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002495exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002496 /* In case of success, set the potential excess room in the output buffer
2497 * to an invalid value, to avoid potentially leaking a longer MAC.
2498 * In case of error, set the output length and content to a safe default,
2499 * such that in case the caller misses an error check, the output would be
2500 * an unachievable MAC.
2501 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002503 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002504 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002505 }
mohammad16036df908f2018-04-02 08:34:15 -07002506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 if (mac_size > operation->mac_size) {
2508 memset(&mac[operation->mac_size], '!',
2509 mac_size - operation->mac_size);
2510 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002515}
2516
Gilles Peskine449bd832023-01-11 14:50:10 +01002517psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2518 const uint8_t *mac,
2519 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002520{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2522 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002525 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002526 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002527 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002528
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002530 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002531 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002532 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002535 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002536 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002537 }
2538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 status = psa_driver_wrapper_mac_verify_finish(operation,
2540 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002541
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002542exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002546}
2547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2549 psa_algorithm_t alg,
2550 const uint8_t *input,
2551 size_t input_length,
2552 uint8_t *mac,
2553 size_t mac_size,
2554 size_t *mac_length,
2555 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002556{
2557 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002558 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2559 psa_key_slot_t *slot;
2560 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561
Ronald Cron51131b52021-06-17 17:17:20 +02002562 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 key,
2564 &slot,
2565 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2566 alg);
2567 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002568 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002570
Ronald Cron51131b52021-06-17 17:17:20 +02002571 psa_key_attributes_t attributes = {
2572 .core = slot->attr
2573 };
2574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2576 &operation_mac_size);
2577 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002578 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002582 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002583 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002584 }
2585
2586 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 &attributes,
2588 slot->key.data, slot->key.bytes,
2589 alg,
2590 input, input_length,
2591 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002592
2593exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002594 /* In case of success, set the potential excess room in the output buffer
2595 * to an invalid value, to avoid potentially leaking a longer MAC.
2596 * In case of error, set the output length and content to a safe default,
2597 * such that in case the caller misses an error check, the output would be
2598 * an unachievable MAC.
2599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002601 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002602 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002603 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (mac_size > operation_mac_size) {
2605 memset(&mac[operation_mac_size], '!', mac_size - operation_mac_size);
2606 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002611}
2612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002614 psa_algorithm_t alg,
2615 const uint8_t *input,
2616 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 uint8_t *mac,
2618 size_t mac_size,
2619 size_t *mac_length)
2620{
2621 return psa_mac_compute_internal(key, alg,
2622 input, input_length,
2623 mac, mac_size, mac_length, 1);
2624}
2625
2626psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2627 psa_algorithm_t alg,
2628 const uint8_t *input,
2629 size_t input_length,
2630 const uint8_t *mac,
2631 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002632{
2633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002634 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2635 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 status = psa_mac_compute_internal(key, alg,
2638 input, input_length,
2639 actual_mac, sizeof(actual_mac),
2640 &actual_mac_length, 0);
2641 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002642 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002646 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002647 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002648 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002650 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002651 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002652 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002653
2654exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002658}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002659
Gilles Peskinee59236f2018-01-27 23:32:46 +01002660/****************************************************************/
2661/* Asymmetric cryptography */
2662/****************************************************************/
2663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2665 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002666{
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (input_is_message) {
2668 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2669 return PSA_ERROR_INVALID_ARGUMENT;
2670 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2673 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2674 return PSA_ERROR_INVALID_ARGUMENT;
2675 }
2676 }
2677 } else {
2678 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2679 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002680 }
2681 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002684}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2687 int input_is_message,
2688 psa_algorithm_t alg,
2689 const uint8_t *input,
2690 size_t input_length,
2691 uint8_t *signature,
2692 size_t signature_size,
2693 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002694{
2695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2696 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2697 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002698
2699 *signature_length = 0;
2700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 status = psa_sign_verify_check_alg(input_is_message, alg);
2702 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002703 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002705
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002706 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002707 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002708 * buffer can in principle be empty since it doesn't actually have
2709 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (signature_size == 0) {
2711 return PSA_ERROR_BUFFER_TOO_SMALL;
2712 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002713
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002714 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 key, &slot,
2716 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2717 PSA_KEY_USAGE_SIGN_HASH,
2718 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002721 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002725 status = PSA_ERROR_INVALID_ARGUMENT;
2726 goto exit;
2727 }
2728
2729 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002731 };
2732
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002734 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002735 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002736 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 signature, signature_size, signature_length);
2738 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002739
2740 status = psa_driver_wrapper_sign_hash(
2741 &attributes, slot->key.data, slot->key.bytes,
2742 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002744 }
2745
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002746
2747exit:
2748 /* Fill the unused part of the output buffer (the whole buffer on error,
2749 * the trailing part on success) with something that isn't a valid signature
2750 * (barring an attack on the signature and deliberately-crafted input),
2751 * in case the caller doesn't check the return status properly. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 if (status == PSA_SUCCESS) {
2753 memset(signature + *signature_length, '!',
2754 signature_size - *signature_length);
2755 } else {
2756 memset(signature, '!', signature_size);
2757 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002758 /* If signature_size is 0 then we have nothing to do. We must not call
2759 * memset because signature may be NULL in this case. */
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002764}
2765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2767 int input_is_message,
2768 psa_algorithm_t alg,
2769 const uint8_t *input,
2770 size_t input_length,
2771 const uint8_t *signature,
2772 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002773{
2774 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2775 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2776 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 status = psa_sign_verify_check_alg(input_is_message, alg);
2779 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002780 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002782
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002783 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 key, &slot,
2785 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2786 PSA_KEY_USAGE_VERIFY_HASH,
2787 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 if (status != PSA_SUCCESS) {
2790 return status;
2791 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002792
2793 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002795 };
2796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002798 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002799 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002800 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 signature, signature_length);
2802 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002803 status = psa_driver_wrapper_verify_hash(
2804 &attributes, slot->key.data, slot->key.bytes,
2805 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002807 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002812
2813}
2814
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002815psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002816 const psa_key_attributes_t *attributes,
2817 const uint8_t *key_buffer,
2818 size_t key_buffer_size,
2819 psa_algorithm_t alg,
2820 const uint8_t *input,
2821 size_t input_length,
2822 uint8_t *signature,
2823 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825{
2826 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002829 size_t hash_length;
2830 uint8_t hash[PSA_HASH_MAX_SIZE];
2831
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002832 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 PSA_ALG_SIGN_GET_HASH(alg),
2834 input, input_length,
2835 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002838 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002840
2841 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 attributes, key_buffer, key_buffer_size,
2843 alg, hash, hash_length,
2844 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002845 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002848}
2849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2851 psa_algorithm_t alg,
2852 const uint8_t *input,
2853 size_t input_length,
2854 uint8_t *signature,
2855 size_t signature_size,
2856 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002857{
2858 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002859 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002861}
2862
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002863psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002864 const psa_key_attributes_t *attributes,
2865 const uint8_t *key_buffer,
2866 size_t key_buffer_size,
2867 psa_algorithm_t alg,
2868 const uint8_t *input,
2869 size_t input_length,
2870 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002872{
2873 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002876 size_t hash_length;
2877 uint8_t hash[PSA_HASH_MAX_SIZE];
2878
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002879 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 PSA_ALG_SIGN_GET_HASH(alg),
2881 input, input_length,
2882 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002885 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002887
2888 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 attributes, key_buffer, key_buffer_size,
2890 alg, hash, hash_length,
2891 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002892 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002895}
2896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
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-arm5b446522021-04-20 12:11:35 +02002903{
2904 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002905 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002907}
2908
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002909psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002910 const psa_key_attributes_t *attributes,
2911 const uint8_t *key_buffer, size_t key_buffer_size,
2912 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002914{
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2916 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2917 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002918#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2920 return mbedtls_psa_rsa_sign_hash(
2921 attributes,
2922 key_buffer, key_buffer_size,
2923 alg, hash, hash_length,
2924 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002925#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2926 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 } else {
2928 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002929 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2931 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002932#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2934 return mbedtls_psa_ecdsa_sign_hash(
2935 attributes,
2936 key_buffer, key_buffer_size,
2937 alg, hash, hash_length,
2938 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01002939#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2940 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 } else {
2942 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01002943 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002944 }
Ronald Cron4501c982021-03-19 20:09:32 +01002945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 (void) key_buffer;
2947 (void) key_buffer_size;
2948 (void) hash;
2949 (void) hash_length;
2950 (void) signature;
2951 (void) signature_size;
2952 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01002953
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01002955}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002956
Gilles Peskine449bd832023-01-11 14:50:10 +01002957psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
2958 psa_algorithm_t alg,
2959 const uint8_t *hash,
2960 size_t hash_length,
2961 uint8_t *signature,
2962 size_t signature_size,
2963 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002964{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002965 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002966 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03002968}
2969
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002970psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002971 const psa_key_attributes_t *attributes,
2972 const uint8_t *key_buffer, size_t key_buffer_size,
2973 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03002975{
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
2977 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2978 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002979#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2981 return mbedtls_psa_rsa_verify_hash(
2982 attributes,
2983 key_buffer, key_buffer_size,
2984 alg, hash, hash_length,
2985 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01002986#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2987 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 } else {
2989 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02002990 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
2992 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002993#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2995 return mbedtls_psa_ecdsa_verify_hash(
2996 attributes,
2997 key_buffer, key_buffer_size,
2998 alg, hash, hash_length,
2999 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003000#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3001 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 } else {
3003 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003004 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003005 }
Ronald Cron4501c982021-03-19 20:09:32 +01003006
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 (void) key_buffer;
3008 (void) key_buffer_size;
3009 (void) hash;
3010 (void) hash_length;
3011 (void) signature;
3012 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003015}
3016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3018 psa_algorithm_t alg,
3019 const uint8_t *hash,
3020 size_t hash_length,
3021 const uint8_t *signature,
3022 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003023{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003024 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003025 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003027}
3028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3030 psa_algorithm_t alg,
3031 const uint8_t *input,
3032 size_t input_length,
3033 const uint8_t *salt,
3034 size_t salt_length,
3035 uint8_t *output,
3036 size_t output_size,
3037 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003038{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003039 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003040 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003041 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003042
Darryl Green5cc689a2018-07-24 15:34:10 +01003043 (void) input;
3044 (void) input_length;
3045 (void) salt;
3046 (void) output;
3047 (void) output_size;
3048
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003049 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003050
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3052 return PSA_ERROR_INVALID_ARGUMENT;
3053 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003054
Ronald Cron5c522922020-11-14 16:35:34 +01003055 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3057 if (status != PSA_SUCCESS) {
3058 return status;
3059 }
3060 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3061 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003062 status = PSA_ERROR_INVALID_ARGUMENT;
3063 goto exit;
3064 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003065
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003066 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003068 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003069
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003070 status = psa_driver_wrapper_asymmetric_encrypt(
3071 &attributes, slot->key.data, slot->key.bytes,
3072 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003074exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003078}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3081 psa_algorithm_t alg,
3082 const uint8_t *input,
3083 size_t input_length,
3084 const uint8_t *salt,
3085 size_t salt_length,
3086 uint8_t *output,
3087 size_t output_size,
3088 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003089{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003091 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003092 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003093
Darryl Green5cc689a2018-07-24 15:34:10 +01003094 (void) input;
3095 (void) input_length;
3096 (void) salt;
3097 (void) output;
3098 (void) output_size;
3099
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003100 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3103 return PSA_ERROR_INVALID_ARGUMENT;
3104 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003105
Ronald Cron5c522922020-11-14 16:35:34 +01003106 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3108 if (status != PSA_SUCCESS) {
3109 return status;
3110 }
3111 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112 status = PSA_ERROR_INVALID_ARGUMENT;
3113 goto exit;
3114 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003116 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003118 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003119
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003120 status = psa_driver_wrapper_asymmetric_decrypt(
3121 &attributes, slot->key.data, slot->key.bytes,
3122 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003124
3125exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003129}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003130
Paul Elliott9fe12f62022-11-30 19:16:02 +00003131/****************************************************************/
3132/* Asymmetric interruptible cryptography */
3133/****************************************************************/
3134
3135void psa_interruptible_set_max_ops(uint32_t max_ops)
3136{
3137 psa_driver_wrapper_interruptible_set_max_ops(max_ops);
3138}
3139
3140uint32_t psa_interruptible_get_max_ops(void)
3141{
3142 return psa_driver_wrapper_interruptible_get_max_ops();
3143}
3144
3145
3146uint32_t psa_sign_hash_get_num_ops(
3147 const psa_sign_hash_interruptible_operation_t *operation)
3148{
Paul Elliott296ede92022-12-15 17:00:30 +00003149 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003150}
3151
3152uint32_t psa_verify_hash_get_num_ops(
3153 const psa_verify_hash_interruptible_operation_t *operation)
3154{
Paul Elliott296ede92022-12-15 17:00:30 +00003155 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003156}
3157
Paul Elliott59ad9452022-12-18 15:09:02 +00003158static psa_status_t psa_sign_hash_abort_internal(
3159 psa_sign_hash_interruptible_operation_t *operation)
3160{
3161 if (operation->id == 0) {
3162 /* The object has (apparently) been initialized but it is not (yet)
3163 * in use. It's ok to call abort on such an object, and there's
3164 * nothing to do. */
3165 return PSA_SUCCESS;
3166 }
3167
3168 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3169
3170 status = psa_driver_wrapper_sign_hash_abort(operation);
3171
3172 operation->id = 0;
3173
3174 return status;
3175}
3176
Paul Elliott9fe12f62022-11-30 19:16:02 +00003177psa_status_t psa_sign_hash_start(
3178 psa_sign_hash_interruptible_operation_t *operation,
3179 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3180 const uint8_t *hash, size_t hash_length)
3181{
3182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3183 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3184 psa_key_slot_t *slot;
3185
3186 /* Check that start has not been previously called. */
3187 if (operation->id != 0) {
3188 return PSA_ERROR_BAD_STATE;
3189 }
3190
3191
3192 status = psa_sign_verify_check_alg(0, alg);
3193 if (status != PSA_SUCCESS) {
3194 return status;
3195 }
3196
3197 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3198 PSA_KEY_USAGE_SIGN_HASH,
3199 alg);
3200
3201 if (status != PSA_SUCCESS) {
3202 goto exit;
3203 }
3204
3205 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3206 status = PSA_ERROR_INVALID_ARGUMENT;
3207 goto exit;
3208 }
3209
3210 psa_key_attributes_t attributes = {
3211 .core = slot->attr
3212 };
3213
Paul Elliott296ede92022-12-15 17:00:30 +00003214 /* Ensure ops count gets reset, in case of operation re-use. */
3215 operation->num_ops = 0;
3216
Paul Elliott9fe12f62022-11-30 19:16:02 +00003217 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3218 slot->key.data,
3219 slot->key.bytes, alg,
3220 hash, hash_length);
3221exit:
3222
3223 if (status != PSA_SUCCESS) {
Paul Elliott59ad9452022-12-18 15:09:02 +00003224 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003225 }
3226
3227 unlock_status = psa_unlock_key_slot(slot);
3228
3229 return (status == PSA_SUCCESS) ? unlock_status : status;
3230
3231}
3232
3233
3234psa_status_t psa_sign_hash_complete(
3235 psa_sign_hash_interruptible_operation_t *operation,
3236 uint8_t *signature, size_t signature_size,
3237 size_t *signature_length)
3238{
3239 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3240
3241 *signature_length = 0;
3242
3243 /* Check that start has been called first. */
3244 if (operation->id == 0) {
3245 status = PSA_ERROR_BAD_STATE;
3246 goto exit;
3247 }
3248
Paul Elliott096abc42023-02-03 18:33:23 +00003249 /* Immediately reject a zero-length signature buffer. This guarantees that
3250 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003251 if (signature_size == 0) {
3252 status = PSA_ERROR_BUFFER_TOO_SMALL;
3253 goto exit;
3254 }
3255
3256 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3257 signature_size,
3258 signature_length);
3259exit:
3260
Paul Elliott296ede92022-12-15 17:00:30 +00003261 /* Update ops count with work done. */
3262 operation->num_ops += psa_driver_wrapper_sign_hash_get_num_ops(operation);
3263
Paul Elliott9fe12f62022-11-30 19:16:02 +00003264 if (status != PSA_OPERATION_INCOMPLETE) {
3265 /* Fill the unused part of the output buffer (the whole buffer on error,
3266 * the trailing part on success) with something that isn't a valid
3267 * signature (barring an attack on the signature and
3268 * deliberately-crafted input), in case the caller doesn't check the
3269 * return status properly.*/
3270 if (status == PSA_SUCCESS) {
3271 memset(signature + *signature_length, '!',
3272 signature_size - *signature_length);
3273 } else if (signature_size > 0) {
3274 memset(signature, '!', signature_size);
3275 }
3276 /* If signature_size is 0 then we have nothing to do. We must not
3277 * call memset because signature may be NULL in this case.*/
3278
Paul Elliott59ad9452022-12-18 15:09:02 +00003279 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003280 }
3281
3282 return status;
3283}
3284
3285psa_status_t psa_sign_hash_abort(
3286 psa_sign_hash_interruptible_operation_t *operation)
3287{
Paul Elliott59ad9452022-12-18 15:09:02 +00003288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3289
3290 status = psa_sign_hash_abort_internal(operation);
3291
3292 /* We clear the number of ops done here, so that it is not cleared when
3293 * the operation fails or succeeds, only on manual abort. */
3294 operation->num_ops = 0;
3295
3296 return status;
3297}
3298
3299static psa_status_t psa_verify_hash_abort_internal(
3300 psa_verify_hash_interruptible_operation_t *operation)
3301{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003302 if (operation->id == 0) {
3303 /* The object has (apparently) been initialized but it is not (yet)
3304 * in use. It's ok to call abort on such an object, and there's
3305 * nothing to do. */
3306 return PSA_SUCCESS;
3307 }
3308
Paul Elliott59ad9452022-12-18 15:09:02 +00003309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3310
3311 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003312
3313 operation->id = 0;
3314
Paul Elliott59ad9452022-12-18 15:09:02 +00003315 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003316}
3317
3318psa_status_t psa_verify_hash_start(
3319 psa_verify_hash_interruptible_operation_t *operation,
3320 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3321 const uint8_t *hash, size_t hash_length,
3322 const uint8_t *signature, size_t signature_length)
3323{
3324 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3325 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3326 psa_key_slot_t *slot;
3327
3328 /* Check that start has not been previously called. */
3329 if (operation->id != 0) {
3330 return PSA_ERROR_BAD_STATE;
3331 }
3332
3333 status = psa_sign_verify_check_alg(0, alg);
3334 if (status != PSA_SUCCESS) {
3335 return status;
3336 }
3337
3338 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3339 PSA_KEY_USAGE_VERIFY_HASH,
3340 alg);
3341
3342 if (status != PSA_SUCCESS) {
3343 return status;
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_verify_hash_start(operation, &attributes,
3354 slot->key.data,
3355 slot->key.bytes,
3356 alg, hash, hash_length,
3357 signature, signature_length);
3358
3359 if (status != PSA_SUCCESS) {
Paul Elliott59ad9452022-12-18 15:09:02 +00003360 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003361 }
3362
3363 unlock_status = psa_unlock_key_slot(slot);
3364
3365 return (status == PSA_SUCCESS) ? unlock_status : status;
3366
3367 return status;
3368}
3369
3370psa_status_t psa_verify_hash_complete(
3371 psa_verify_hash_interruptible_operation_t *operation)
3372{
3373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3374
3375 /* Check that start has been called first. */
3376 if (operation->id == 0) {
3377 status = PSA_ERROR_BAD_STATE;
3378 goto exit;
3379 }
3380
3381 status = psa_driver_wrapper_verify_hash_complete(operation);
3382
3383exit:
3384
Paul Elliott296ede92022-12-15 17:00:30 +00003385 /* Update ops count with work done. */
3386 operation->num_ops += psa_driver_wrapper_verify_hash_get_num_ops(
3387 operation);
3388
Paul Elliott9fe12f62022-11-30 19:16:02 +00003389 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliott59ad9452022-12-18 15:09:02 +00003390 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003391 }
3392
3393 return status;
3394}
3395
3396psa_status_t psa_verify_hash_abort(
3397 psa_verify_hash_interruptible_operation_t *operation)
3398{
Paul Elliott59ad9452022-12-18 15:09:02 +00003399 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003400
Paul Elliott59ad9452022-12-18 15:09:02 +00003401 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003402
Paul Elliott59ad9452022-12-18 15:09:02 +00003403 /* We clear the number of ops done here, so that it is not cleared when
3404 * the operation fails or succeeds, only on manual abort. */
3405 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003406
Paul Elliott59ad9452022-12-18 15:09:02 +00003407 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003408}
3409
Paul Elliott588f8ed2022-12-02 18:10:26 +00003410/****************************************************************/
3411/* Asymmetric interruptible cryptography internal */
3412/* implementations */
3413/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003414
Paul Elliott588f8ed2022-12-02 18:10:26 +00003415static uint32_t mbedtls_psa_interruptible_max_ops =
3416 PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3417
3418void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3419{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003420 mbedtls_psa_interruptible_max_ops = max_ops;
3421
Paul Elliott588f8ed2022-12-02 18:10:26 +00003422#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3423 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3424 defined(MBEDTLS_ECP_RESTARTABLE)
3425
3426 /* Internal implementation uses zero to indicate infinite number max ops,
3427 * therefore avoid this value, and set to minimum possible. */
3428 if (max_ops == 0) {
3429 max_ops = 1;
3430 }
3431
Paul Elliott588f8ed2022-12-02 18:10:26 +00003432 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003433#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3434 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3435 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3436}
3437
3438uint32_t mbedtls_psa_interruptible_get_max_ops(void)
3439{
3440 return mbedtls_psa_interruptible_max_ops;
3441}
3442
3443uint32_t mbedtls_psa_sign_hash_get_num_ops(
3444 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3445{
3446#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3447 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3448 defined(MBEDTLS_ECP_RESTARTABLE)
3449
3450 return operation->restart_ctx.ecp.ops_done;
3451#else
3452 (void) operation;
3453 return 0;
3454#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3455 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3456 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3457}
3458
3459uint32_t mbedtls_psa_verify_hash_get_num_ops(
3460 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3461{
3462 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3463 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3464 defined(MBEDTLS_ECP_RESTARTABLE)
3465
3466 return operation->restart_ctx.ecp.ops_done;
3467#else
3468 (void) operation;
3469 return 0;
3470#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3471 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3472 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3473}
3474
3475psa_status_t mbedtls_psa_sign_hash_start(
3476 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3477 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3478 size_t key_buffer_size, psa_algorithm_t alg,
3479 const uint8_t *hash, size_t hash_length)
3480{
3481 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3482
Paul Elliott068fe072023-01-16 13:59:15 +00003483 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3484 return PSA_ERROR_NOT_SUPPORTED;
3485 }
3486
3487 if (!PSA_ALG_IS_ECDSA(alg)) {
3488 return PSA_ERROR_INVALID_ARGUMENT;
3489 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003490
3491#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003492 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3493 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003494
Paul Elliott068fe072023-01-16 13:59:15 +00003495 /* Ensure default is set even if
3496 * mbedtls_psa_interruptible_set_max_ops() has not been called. */
3497 mbedtls_psa_interruptible_set_max_ops(
3498 mbedtls_psa_interruptible_get_max_ops());
Paul Elliott588f8ed2022-12-02 18:10:26 +00003499
Paul Elliott068fe072023-01-16 13:59:15 +00003500 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3501 attributes->core.bits,
3502 key_buffer,
3503 key_buffer_size,
3504 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003505
Paul Elliott068fe072023-01-16 13:59:15 +00003506 if (status != PSA_SUCCESS) {
3507 return status;
3508 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003509
Paul Elliott068fe072023-01-16 13:59:15 +00003510 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003511
Paul Elliott1bc59df2023-02-05 13:41:57 +00003512 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliott068fe072023-01-16 13:59:15 +00003513 operation->ctx->grp.pbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003514
Paul Elliott068fe072023-01-16 13:59:15 +00003515 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
3516 operation->md_alg = mbedtls_hash_info_md_from_psa(hash_alg);
3517 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003518
Paul Elliott068fe072023-01-16 13:59:15 +00003519 operation->hash = hash;
3520 operation->hash_length = hash_length;
3521
3522 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003523
3524#else
Paul Elliott068fe072023-01-16 13:59:15 +00003525 (void) operation;
3526 (void) key_buffer;
3527 (void) key_buffer_size;
3528 (void) alg;
3529 (void) hash;
3530 (void) hash_length;
3531 (void) status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003532
Paul Elliott068fe072023-01-16 13:59:15 +00003533 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003534#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3535 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3536 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003537}
3538
3539psa_status_t mbedtls_psa_sign_hash_complete(
3540 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3541 uint8_t *signature, size_t signature_size,
3542 size_t *signature_length)
3543{
3544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott46845252023-02-03 14:59:11 +00003545 mbedtls_mpi r;
3546 mbedtls_mpi s;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003547
3548#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3549 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3550 defined(MBEDTLS_ECP_RESTARTABLE)
3551
Paul Elliott1bc59df2023-02-05 13:41:57 +00003552 if (signature_size < 2 * operation->coordinate_bytes) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003553 return PSA_ERROR_BUFFER_TOO_SMALL;
3554 }
3555
Paul Elliott46845252023-02-03 14:59:11 +00003556 mbedtls_mpi_init(&r);
3557 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003558
3559 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003560
Paul Elliott588f8ed2022-12-02 18:10:26 +00003561#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3562 status = mbedtls_to_psa_error(
3563 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003564 &r,
3565 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003566 &operation->ctx->d,
3567 operation->hash,
3568 operation->hash_length,
3569 operation->md_alg,
3570 mbedtls_psa_get_random,
3571 MBEDTLS_PSA_RANDOM_STATE,
3572 &operation->restart_ctx));
3573#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3574 return PSA_ERROR_NOT_SUPPORTED;
3575#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3576 } else {
3577
3578 status = mbedtls_to_psa_error(
3579 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003580 &r,
3581 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003582 &operation->ctx->d,
3583 operation->hash,
3584 operation->hash_length,
3585 mbedtls_psa_get_random,
3586 MBEDTLS_PSA_RANDOM_STATE,
3587 mbedtls_psa_get_random,
3588 MBEDTLS_PSA_RANDOM_STATE,
3589 &operation->restart_ctx));
3590 }
3591
3592 if (status != PSA_SUCCESS) {
3593 return status;
3594 } else {
3595 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003596 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003597 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003598 operation->coordinate_bytes)
3599 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003600
3601 if (status != PSA_SUCCESS) {
3602 return status;
3603 }
3604
3605 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003606 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003607 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003608 operation->coordinate_bytes,
3609 operation->coordinate_bytes)
3610 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003611
3612 if (status != PSA_SUCCESS) {
3613 return status;
3614 }
3615
Paul Elliott1bc59df2023-02-05 13:41:57 +00003616 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003617
3618 return PSA_SUCCESS;
3619 }
3620 #else
3621
3622 (void) operation;
3623 (void) status;
3624 (void) signature;
3625 (void) signature_size;
3626 (void) signature_length;
3627
3628 return PSA_ERROR_NOT_SUPPORTED;
3629
3630#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3631 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3632 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3633}
3634
3635psa_status_t mbedtls_psa_sign_hash_abort(
3636 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3637{
3638
3639#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3640 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3641 defined(MBEDTLS_ECP_RESTARTABLE)
3642
3643 if (operation->ctx) {
3644 mbedtls_ecdsa_free(operation->ctx);
3645 mbedtls_free(operation->ctx);
3646 }
3647
3648 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3649
Paul Elliott588f8ed2022-12-02 18:10:26 +00003650 return PSA_SUCCESS;
3651
3652#else
3653
3654 (void) operation;
3655
3656 return PSA_ERROR_NOT_SUPPORTED;
3657
3658#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3659 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3660 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3661}
3662
3663psa_status_t mbedtls_psa_verify_hash_start(
3664 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3665 const psa_key_attributes_t *attributes,
3666 const uint8_t *key_buffer, size_t key_buffer_size,
3667 psa_algorithm_t alg,
3668 const uint8_t *hash, size_t hash_length,
3669 const uint8_t *signature, size_t signature_length)
3670{
3671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003672 size_t coordinate_bytes = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003673
Paul Elliott068fe072023-01-16 13:59:15 +00003674 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3675 return PSA_ERROR_NOT_SUPPORTED;
3676 }
3677
3678 if (!PSA_ALG_IS_ECDSA(alg)) {
3679 return PSA_ERROR_INVALID_ARGUMENT;
3680 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003681
3682#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003683 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3684 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003685
Paul Elliott068fe072023-01-16 13:59:15 +00003686 /* Ensure default is set even if
3687 * mbedtls_psa_interruptible_set_max_ops() has not been called. */
3688 mbedtls_psa_interruptible_set_max_ops(
3689 mbedtls_psa_interruptible_get_max_ops());
Paul Elliott588f8ed2022-12-02 18:10:26 +00003690
Paul Elliott068fe072023-01-16 13:59:15 +00003691 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3692 attributes->core.bits,
3693 key_buffer,
3694 key_buffer_size,
3695 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003696
Paul Elliott068fe072023-01-16 13:59:15 +00003697 if (status != PSA_SUCCESS) {
3698 return status;
3699 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700
Paul Elliott1bc59df2023-02-05 13:41:57 +00003701 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.pbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003702
Paul Elliott1bc59df2023-02-05 13:41:57 +00003703 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003704 return PSA_ERROR_INVALID_SIGNATURE;
3705 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003706
Paul Elliott068fe072023-01-16 13:59:15 +00003707 mbedtls_mpi_init(&operation->r);
3708 status = mbedtls_to_psa_error(
3709 mbedtls_mpi_read_binary(&operation->r,
3710 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003711 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003712
Paul Elliott068fe072023-01-16 13:59:15 +00003713 if (status != PSA_SUCCESS) {
3714 return status;
3715 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003716
Paul Elliott068fe072023-01-16 13:59:15 +00003717 mbedtls_mpi_init(&operation->s);
3718 status = mbedtls_to_psa_error(
3719 mbedtls_mpi_read_binary(&operation->s,
3720 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003721 coordinate_bytes,
3722 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003723
Paul Elliott068fe072023-01-16 13:59:15 +00003724 if (status != PSA_SUCCESS) {
3725 return status;
3726 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003727
Paul Elliott068fe072023-01-16 13:59:15 +00003728 /* Check whether the public part is loaded. If not, load it. */
3729 if (mbedtls_ecp_is_zero(&operation->ctx->Q)) {
3730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003731
Paul Elliott068fe072023-01-16 13:59:15 +00003732 ret = mbedtls_ecp_mul(&operation->ctx->grp,
3733 &operation->ctx->Q,
3734 &operation->ctx->d,
3735 &operation->ctx->grp.G,
3736 mbedtls_psa_get_random,
3737 MBEDTLS_PSA_RANDOM_STATE);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003738
Paul Elliott068fe072023-01-16 13:59:15 +00003739 if (ret != 0) {
3740 return mbedtls_to_psa_error(ret);
3741 }
3742 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743
Paul Elliott068fe072023-01-16 13:59:15 +00003744 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745
Paul Elliott068fe072023-01-16 13:59:15 +00003746 operation->hash = hash;
3747 operation->hash_length = hash_length;
3748
3749 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003750#else
Paul Elliott068fe072023-01-16 13:59:15 +00003751 (void) operation;
3752 (void) key_buffer;
3753 (void) key_buffer_size;
3754 (void) alg;
3755 (void) hash;
3756 (void) hash_length;
3757 (void) signature;
3758 (void) signature_length;
3759 (void) status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003760
Paul Elliott068fe072023-01-16 13:59:15 +00003761 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3763 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3764 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765}
3766
3767psa_status_t mbedtls_psa_verify_hash_complete(
3768 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3769{
3770
3771#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3772 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3773 defined(MBEDTLS_ECP_RESTARTABLE)
3774
3775 return mbedtls_to_psa_error(
3776 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3777 operation->hash,
3778 operation->hash_length,
3779 &operation->ctx->Q,
3780 &operation->r,
3781 &operation->s,
3782 &operation->restart_ctx));
3783
3784#else
3785 (void) operation;
3786
3787 return PSA_ERROR_NOT_SUPPORTED;
3788
3789#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3790 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3791 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3792}
3793
3794psa_status_t mbedtls_psa_verify_hash_abort(
3795 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3796{
3797
3798#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3799 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3800 defined(MBEDTLS_ECP_RESTARTABLE)
3801
3802 if (operation->ctx) {
3803 mbedtls_ecdsa_free(operation->ctx);
3804 mbedtls_free(operation->ctx);
3805 }
3806
3807 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3808
3809 mbedtls_mpi_free(&operation->r);
3810 mbedtls_mpi_free(&operation->s);
3811
3812 return PSA_SUCCESS;
3813
3814#else
3815 (void) operation;
3816
3817 return PSA_ERROR_NOT_SUPPORTED;
3818
3819#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3820 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3821 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3822}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003823
mohammad1603503973b2018-03-12 15:59:30 +02003824/****************************************************************/
3825/* Symmetric cryptography */
3826/****************************************************************/
3827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3829 mbedtls_svc_key_id_t key,
3830 psa_algorithm_t alg,
3831 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003832{
3833 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3834 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003835 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3837 PSA_KEY_USAGE_ENCRYPT :
3838 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02003839
3840 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003842 status = PSA_ERROR_BAD_STATE;
3843 goto exit;
3844 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003845
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003847 status = PSA_ERROR_INVALID_ARGUMENT;
3848 goto exit;
3849 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003850
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3852 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003853 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003855
Ronald Cron49fafa92021-03-10 08:34:23 +01003856 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003857 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003858 * so we only set it (in the driver wrapper) after resources have been
3859 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003860 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003862 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003864 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 }
3866 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003867
Ronald Crona4af55f2020-12-14 14:36:06 +01003868 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003870 };
3871
Ronald Cronab99ac22020-10-01 16:38:28 +02003872 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 if (cipher_operation == MBEDTLS_ENCRYPT) {
3874 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3875 &attributes,
3876 slot->key.data,
3877 slot->key.bytes,
3878 alg);
3879 } else {
3880 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3881 &attributes,
3882 slot->key.data,
3883 slot->key.bytes,
3884 alg);
3885 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003886
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003887exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (status != PSA_SUCCESS) {
3889 psa_cipher_abort(operation);
3890 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003891
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003893
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003895}
3896
Gilles Peskine449bd832023-01-11 14:50:10 +01003897psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3898 mbedtls_svc_key_id_t key,
3899 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003900{
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003902}
3903
Gilles Peskine449bd832023-01-11 14:50:10 +01003904psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3905 mbedtls_svc_key_id_t key,
3906 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003907{
Gilles Peskine449bd832023-01-11 14:50:10 +01003908 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003909}
3910
Gilles Peskine449bd832023-01-11 14:50:10 +01003911psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3912 uint8_t *iv,
3913 size_t iv_size,
3914 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003915{
Ronald Cron6d051732020-10-01 14:10:20 +02003916 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003917 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3918 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01003919
Gilles Peskine449bd832023-01-11 14:50:10 +01003920 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003921 status = PSA_ERROR_BAD_STATE;
3922 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003923 }
3924
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003926 status = PSA_ERROR_BAD_STATE;
3927 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003928 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003929
Ronald Cron2fb90522021-07-05 12:31:44 +02003930 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01003932 status = PSA_ERROR_BUFFER_TOO_SMALL;
3933 goto exit;
3934 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003935
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02003937 status = PSA_ERROR_GENERIC_ERROR;
3938 goto exit;
3939 }
3940
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 status = psa_generate_random(local_iv, default_iv_length);
3942 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01003943 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 }
Ronald Cron5618a392021-03-26 09:52:26 +01003945
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 status = psa_driver_wrapper_cipher_set_iv(operation,
3947 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01003948
3949exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 if (status == PSA_SUCCESS) {
3951 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02003952 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003953 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003954 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02003955 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02003957 }
Ronald Cron6d051732020-10-01 14:10:20 +02003958
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003960}
3961
Gilles Peskine449bd832023-01-11 14:50:10 +01003962psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
3963 const uint8_t *iv,
3964 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003965{
Ronald Cron6d051732020-10-01 14:10:20 +02003966 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003967
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003969 status = PSA_ERROR_BAD_STATE;
3970 goto exit;
3971 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003972
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003974 status = PSA_ERROR_BAD_STATE;
3975 goto exit;
3976 }
Ronald Crona0d68172021-03-26 10:15:08 +01003977
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003979 status = PSA_ERROR_INVALID_ARGUMENT;
3980 goto exit;
3981 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003982
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 status = psa_driver_wrapper_cipher_set_iv(operation,
3984 iv,
3985 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02003986
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003987exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03003989 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003990 } else {
3991 psa_cipher_abort(operation);
3992 }
3993 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003994}
3995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
3997 const uint8_t *input,
3998 size_t input_length,
3999 uint8_t *output,
4000 size_t output_size,
4001 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004002{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004006 status = PSA_ERROR_BAD_STATE;
4007 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004008 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004011 status = PSA_ERROR_BAD_STATE;
4012 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004013 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004014
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 status = psa_driver_wrapper_cipher_update(operation,
4016 input,
4017 input_length,
4018 output,
4019 output_size,
4020 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004021
4022exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (status != PSA_SUCCESS) {
4024 psa_cipher_abort(operation);
4025 }
Ronald Cron6d051732020-10-01 14:10:20 +02004026
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004028}
4029
Gilles Peskine449bd832023-01-11 14:50:10 +01004030psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4031 uint8_t *output,
4032 size_t output_size,
4033 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004034{
David Saadab4ecc272019-02-14 13:48:10 +02004035 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004038 status = PSA_ERROR_BAD_STATE;
4039 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004040 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004041
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004043 status = PSA_ERROR_BAD_STATE;
4044 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004045 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 status = psa_driver_wrapper_cipher_finish(operation,
4048 output,
4049 output_size,
4050 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004051
4052exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (status == PSA_SUCCESS) {
4054 return psa_cipher_abort(operation);
4055 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004056 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004058
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004060 }
mohammad1603503973b2018-03-12 15:59:30 +02004061}
4062
Gilles Peskine449bd832023-01-11 14:50:10 +01004063psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004064{
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004066 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004067 * in use. It's ok to call abort on such an object, and there's
4068 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004070 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004073
Ronald Cron49fafa92021-03-10 08:34:23 +01004074 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004075 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004076 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004077
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004079}
4080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4082 psa_algorithm_t alg,
4083 const uint8_t *input,
4084 size_t input_length,
4085 uint8_t *output,
4086 size_t output_size,
4087 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004088{
4089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004090 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004091 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004092 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4093 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004094
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004096 status = PSA_ERROR_INVALID_ARGUMENT;
4097 goto exit;
4098 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004099
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4101 PSA_KEY_USAGE_ENCRYPT,
4102 alg);
4103 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004104 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004105 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004106
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004107 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004109 };
4110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4112 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004113 status = PSA_ERROR_GENERIC_ERROR;
4114 goto exit;
4115 }
4116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 if (default_iv_length > 0) {
4118 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004119 status = PSA_ERROR_BUFFER_TOO_SMALL;
4120 goto exit;
4121 }
4122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 status = psa_generate_random(local_iv, default_iv_length);
4124 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004125 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004127 }
4128
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004129 status = psa_driver_wrapper_cipher_encrypt(
4130 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004131 alg, local_iv, default_iv_length, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 mbedtls_buffer_offset(output, default_iv_length),
4133 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004134
4135exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 unlock_status = psa_unlock_key_slot(slot);
4137 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004138 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004139 }
Ronald Cron23919522021-07-08 19:00:07 +02004140
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 if (status == PSA_SUCCESS) {
4142 if (default_iv_length > 0) {
4143 memcpy(output, local_iv, default_iv_length);
4144 }
4145 *output_length += default_iv_length;
4146 } else {
4147 *output_length = 0;
4148 }
4149
4150 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004151}
4152
Gilles Peskine449bd832023-01-11 14:50:10 +01004153psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4154 psa_algorithm_t alg,
4155 const uint8_t *input,
4156 size_t input_length,
4157 uint8_t *output,
4158 size_t output_size,
4159 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004160{
4161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004162 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004163 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004166 status = PSA_ERROR_INVALID_ARGUMENT;
4167 goto exit;
4168 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4171 PSA_KEY_USAGE_DECRYPT,
4172 alg);
4173 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004174 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004176
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004177 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004179 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004180
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4182 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004183 status = PSA_ERROR_INVALID_ARGUMENT;
4184 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004186 status = PSA_ERROR_INVALID_ARGUMENT;
4187 goto exit;
4188 }
4189
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004190 status = psa_driver_wrapper_cipher_decrypt(
4191 &attributes, slot->key.data, slot->key.bytes,
4192 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004194
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004195exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 unlock_status = psa_unlock_key_slot(slot);
4197 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004198 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004200
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004202 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 }
Ronald Cron23919522021-07-08 19:00:07 +02004204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004206}
4207
4208
mohammad16035955c982018-04-26 00:53:03 +03004209/****************************************************************/
4210/* AEAD */
4211/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004212
Paul Elliottbaff51c2021-09-28 17:44:45 +01004213/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004214static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004215{
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004217}
4218
4219/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004220static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4221 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004222{
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004226#if defined(PSA_WANT_ALG_GCM)
4227 case PSA_ALG_GCM:
4228 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 * arbitrarily large nonces. Please note that we do not generally
4230 * recommend the usage of nonces of greater length than
4231 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4232 * size, which can then lead to collisions if you encrypt a very
4233 * large number of messages.*/
4234 if (nonce_length != 0) {
4235 return PSA_SUCCESS;
4236 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004237 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004238#endif /* PSA_WANT_ALG_GCM */
4239#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004240 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 if (nonce_length >= 7 && nonce_length <= 13) {
4242 return PSA_SUCCESS;
4243 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004244 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004245#endif /* PSA_WANT_ALG_CCM */
4246#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004247 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (nonce_length == 12) {
4249 return PSA_SUCCESS;
4250 } else if (nonce_length == 8) {
4251 return PSA_ERROR_NOT_SUPPORTED;
4252 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004253 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004254#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004255 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004256 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004258 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004261}
4262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004264{
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4266 return PSA_ERROR_INVALID_ARGUMENT;
4267 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004268
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004270}
4271
Gilles Peskine449bd832023-01-11 14:50:10 +01004272psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4273 psa_algorithm_t alg,
4274 const uint8_t *nonce,
4275 size_t nonce_length,
4276 const uint8_t *additional_data,
4277 size_t additional_data_length,
4278 const uint8_t *plaintext,
4279 size_t plaintext_length,
4280 uint8_t *ciphertext,
4281 size_t ciphertext_size,
4282 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004283{
Ronald Cron215633c2021-03-16 17:15:37 +01004284 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4285 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004286
mohammad1603f08a5502018-06-03 15:05:47 +03004287 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004288
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 status = psa_aead_check_algorithm(alg);
4290 if (status != PSA_SUCCESS) {
4291 return status;
4292 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004293
Ronald Cron9a986162021-03-26 12:40:07 +01004294 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4296 if (status != PSA_SUCCESS) {
4297 return status;
4298 }
mohammad16035955c982018-04-26 00:53:03 +03004299
Ronald Cron215633c2021-03-16 17:15:37 +01004300 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004302 };
mohammad16035955c982018-04-26 00:53:03 +03004303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 status = psa_aead_check_nonce_length(alg, nonce_length);
4305 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004306 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004308
Ronald Cronde822812021-03-17 16:08:20 +01004309 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004310 &attributes, slot->key.data, slot->key.bytes,
4311 alg,
4312 nonce, nonce_length,
4313 additional_data, additional_data_length,
4314 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4318 memset(ciphertext, 0, ciphertext_size);
4319 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004320
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004321exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004325}
4326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4328 psa_algorithm_t alg,
4329 const uint8_t *nonce,
4330 size_t nonce_length,
4331 const uint8_t *additional_data,
4332 size_t additional_data_length,
4333 const uint8_t *ciphertext,
4334 size_t ciphertext_length,
4335 uint8_t *plaintext,
4336 size_t plaintext_size,
4337 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004338{
Ronald Cron215633c2021-03-16 17:15:37 +01004339 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4340 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004341
Gilles Peskineee652a32018-06-01 19:23:52 +02004342 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004343
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 status = psa_aead_check_algorithm(alg);
4345 if (status != PSA_SUCCESS) {
4346 return status;
4347 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004348
Ronald Cron9a986162021-03-26 12:40:07 +01004349 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4351 if (status != PSA_SUCCESS) {
4352 return status;
4353 }
mohammad16035955c982018-04-26 00:53:03 +03004354
Ronald Cron215633c2021-03-16 17:15:37 +01004355 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004357 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 status = psa_aead_check_nonce_length(alg, nonce_length);
4360 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004361 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004363
Ronald Cronde822812021-03-17 16:08:20 +01004364 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004365 &attributes, slot->key.data, slot->key.bytes,
4366 alg,
4367 nonce, nonce_length,
4368 additional_data, additional_data_length,
4369 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 if (status != PSA_SUCCESS && plaintext_size != 0) {
4373 memset(plaintext, 0, plaintext_size);
4374 }
mohammad160360a64d02018-06-03 17:20:42 +03004375
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004376exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004378
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 return status;
mohammad16035955c982018-04-26 00:53:03 +03004380}
4381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4383{
4384 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004387#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004389 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4391 return PSA_ERROR_INVALID_ARGUMENT;
4392 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004393 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004394#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004395
Przemek Stekiel86679c72022-10-06 17:06:56 +02004396#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004398 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4400 return PSA_ERROR_INVALID_ARGUMENT;
4401 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004402 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004403#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004404
Przemek Stekiel86679c72022-10-06 17:06:56 +02004405#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004407 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (tag_len != 16) {
4409 return PSA_ERROR_INVALID_ARGUMENT;
4410 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004411 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004412#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004413
4414 default:
4415 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004417 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004419}
4420
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004421/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004422static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4423 int is_encrypt,
4424 mbedtls_svc_key_id_t key,
4425 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004426{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4428 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4429 psa_key_slot_t *slot = NULL;
4430 psa_key_usage_t key_usage = 0;
4431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 status = psa_aead_check_algorithm(alg);
4433 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004434 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004438 status = PSA_ERROR_BAD_STATE;
4439 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004440 }
4441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (operation->nonce_set || operation->lengths_set ||
4443 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004444 status = PSA_ERROR_BAD_STATE;
4445 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004446 }
4447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004449 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004451 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4455 alg);
4456 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004457 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004459
4460 psa_key_attributes_t attributes = {
4461 .core = slot->attr
4462 };
4463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004465 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (is_encrypt) {
4469 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4470 &attributes,
4471 slot->key.data,
4472 slot->key.bytes,
4473 alg);
4474 } else {
4475 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4476 &attributes,
4477 slot->key.data,
4478 slot->key.bytes,
4479 alg);
4480 }
4481 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004482 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004484
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004486
4487exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004491 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004493 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 } else {
4495 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004496 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004499}
4500
Paul Elliott302ff6b2021-04-20 18:10:30 +01004501/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004502psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4503 mbedtls_svc_key_id_t key,
4504 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004505{
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004507}
4508
4509/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004510psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4511 mbedtls_svc_key_id_t key,
4512 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004513{
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004515}
4516
4517/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004518psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4519 uint8_t *nonce,
4520 size_t nonce_size,
4521 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004522{
4523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004524 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01004525 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004526
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004527 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004530 status = PSA_ERROR_BAD_STATE;
4531 goto exit;
4532 }
4533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004535 status = PSA_ERROR_BAD_STATE;
4536 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004537 }
4538
Paul Elliotte193ea82021-10-01 13:00:16 +01004539 /* For CCM, this size may not be correct according to the PSA
4540 * specification. The PSA Crypto 1.0.1 specification states:
4541 *
4542 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4543 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4544 *
4545 * However this restriction that L has to be the smallest integer is not
4546 * applied in practice, and it is not implementable here since the
4547 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4549 operation->alg);
4550 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004551 status = PSA_ERROR_BUFFER_TOO_SMALL;
4552 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004553 }
4554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 status = psa_generate_random(local_nonce, required_nonce_size);
4556 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004557 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004561
Paul Elliott39dc6b82021-05-11 19:16:09 +01004562exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (status == PSA_SUCCESS) {
4564 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004565 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 } else {
4567 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004568 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004571}
4572
4573/* Set the nonce for a multipart authenticated encryption or decryption
4574 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004575psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4576 const uint8_t *nonce,
4577 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004578{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004579 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004582 status = PSA_ERROR_BAD_STATE;
4583 goto exit;
4584 }
4585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004587 status = PSA_ERROR_BAD_STATE;
4588 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004589 }
4590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4592 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004593 status = PSA_ERROR_INVALID_ARGUMENT;
4594 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004595 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4598 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004599
Paul Elliott39dc6b82021-05-11 19:16:09 +01004600exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004602 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 } else {
4604 psa_aead_abort(operation);
4605 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004608}
4609
4610/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004611psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4612 size_t ad_length,
4613 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004614{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004618 status = PSA_ERROR_BAD_STATE;
4619 goto exit;
4620 }
4621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (operation->lengths_set || operation->ad_started ||
4623 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004624 status = PSA_ERROR_BAD_STATE;
4625 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004626 }
4627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004629#if defined(PSA_WANT_ALG_GCM)
4630 case PSA_ALG_GCM:
4631 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 * bits. Without the guard this code will generate warnings on 32bit
4633 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004634#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if (((uint64_t) ad_length) >> 61 != 0 ||
4636 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004637 status = PSA_ERROR_INVALID_ARGUMENT;
4638 goto exit;
4639 }
Paul Elliott325d3742021-09-27 17:56:28 +01004640#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004641 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004642#endif /* PSA_WANT_ALG_GCM */
4643#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004644 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004646 status = PSA_ERROR_INVALID_ARGUMENT;
4647 goto exit;
4648 }
4649 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004650#endif /* PSA_WANT_ALG_CCM */
4651#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004652 case PSA_ALG_CHACHA20_POLY1305:
4653 /* No length restrictions for ChaChaPoly. */
4654 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004655#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004656 default:
4657 break;
4658 }
Paul Elliott325d3742021-09-27 17:56:28 +01004659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4661 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004662
Paul Elliott39dc6b82021-05-11 19:16:09 +01004663exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004665 operation->ad_remaining = ad_length;
4666 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004667 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 } else {
4669 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004670 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004673}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004674
4675/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004676psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4677 const uint8_t *input,
4678 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004679{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004680 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004683 status = PSA_ERROR_BAD_STATE;
4684 goto exit;
4685 }
4686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004688 status = PSA_ERROR_BAD_STATE;
4689 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004690 }
4691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if (operation->lengths_set) {
4693 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004694 status = PSA_ERROR_INVALID_ARGUMENT;
4695 goto exit;
4696 }
4697
4698 operation->ad_remaining -= input_length;
4699 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004700#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004702 status = PSA_ERROR_BAD_STATE;
4703 goto exit;
4704 }
4705#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 status = psa_driver_wrapper_aead_update_ad(operation, input,
4708 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004709
Paul Elliott39dc6b82021-05-11 19:16:09 +01004710exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004712 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 } else {
4714 psa_aead_abort(operation);
4715 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004718}
4719
4720/* Encrypt or decrypt a message fragment in an active multipart AEAD
4721 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004722psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4723 const uint8_t *input,
4724 size_t input_length,
4725 uint8_t *output,
4726 size_t output_size,
4727 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004728{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004729 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004730
4731 *output_length = 0;
4732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004734 status = PSA_ERROR_BAD_STATE;
4735 goto exit;
4736 }
4737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004739 status = PSA_ERROR_BAD_STATE;
4740 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004741 }
4742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004744 /* Additional data length was supplied, but not all the additional
4745 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004747 status = PSA_ERROR_INVALID_ARGUMENT;
4748 goto exit;
4749 }
4750
4751 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004753 status = PSA_ERROR_INVALID_ARGUMENT;
4754 goto exit;
4755 }
4756
4757 operation->body_remaining -= input_length;
4758 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004759#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004761 status = PSA_ERROR_BAD_STATE;
4762 goto exit;
4763 }
4764#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004765
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4767 output, output_size,
4768 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004769
Paul Elliott39dc6b82021-05-11 19:16:09 +01004770exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004772 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 } else {
4774 psa_aead_abort(operation);
4775 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004776
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004778}
4779
Gilles Peskine449bd832023-01-11 14:50:10 +01004780static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004781{
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (operation->id == 0 || !operation->nonce_set) {
4783 return PSA_ERROR_BAD_STATE;
4784 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004785
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4787 operation->body_remaining != 0)) {
4788 return PSA_ERROR_INVALID_ARGUMENT;
4789 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004792}
4793
Paul Elliott302ff6b2021-04-20 18:10:30 +01004794/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004795psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4796 uint8_t *ciphertext,
4797 size_t ciphertext_size,
4798 size_t *ciphertext_length,
4799 uint8_t *tag,
4800 size_t tag_size,
4801 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004802{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004803 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4804
Paul Elliott302ff6b2021-04-20 18:10:30 +01004805 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004806 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004807
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 status = psa_aead_final_checks(operation);
4809 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004810 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004814 status = PSA_ERROR_BAD_STATE;
4815 goto exit;
4816 }
4817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4819 ciphertext_size,
4820 ciphertext_length,
4821 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004822
Paul Elliott39dc6b82021-05-11 19:16:09 +01004823exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004824 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004825 * the zero tag size, make sure the tag is set to something implausible.
4826 * Even if the operation succeeds, make sure we clear the rest of the
4827 * buffer to prevent potential leakage of anything previously placed in
4828 * the same buffer.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (tag != NULL) {
4830 if (status != PSA_SUCCESS) {
4831 memset(tag, '!', tag_size);
4832 } else if (*tag_length < tag_size) {
4833 memset(tag + *tag_length, '!', (tag_size - *tag_length));
4834 }
Paul Elliottec95cc92021-09-19 22:33:09 +01004835 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004836
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004840}
4841
4842/* Finish authenticating and decrypting a message in a multipart AEAD
4843 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004844psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4845 uint8_t *plaintext,
4846 size_t plaintext_size,
4847 size_t *plaintext_length,
4848 const uint8_t *tag,
4849 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004850{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004851 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4852
Paul Elliott302ff6b2021-04-20 18:10:30 +01004853 *plaintext_length = 0;
4854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 status = psa_aead_final_checks(operation);
4856 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004857 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004861 status = PSA_ERROR_BAD_STATE;
4862 goto exit;
4863 }
4864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 status = psa_driver_wrapper_aead_verify(operation, plaintext,
4866 plaintext_size,
4867 plaintext_length,
4868 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004869
4870exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004874}
4875
4876/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004877psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004878{
4879 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01004882 /* The object has (apparently) been initialized but it is not (yet)
4883 * in use. It's ok to call abort on such an object, and there's
4884 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004886 }
4887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01004891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004893}
4894
Gilles Peskinee59236f2018-01-27 23:32:46 +01004895/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004896/* Generators */
4897/****************************************************************/
4898
Przemek Stekiel69c46792022-06-10 12:59:51 +02004899#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004900 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04004901 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
4902 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
John Durkop07cc04a2020-11-16 22:08:34 -08004903#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004904#endif /* At least one builtin KDF */
4905
Przemek Stekiel69c46792022-06-10 12:59:51 +02004906#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004907 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4908 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4909static psa_status_t psa_key_derivation_start_hmac(
4910 psa_mac_operation_t *operation,
4911 psa_algorithm_t hash_alg,
4912 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02004914{
4915 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4916 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
4918 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
4919 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02004920
Steven Cooreman72f736a2021-05-07 14:14:37 +02004921 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02004923
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 status = psa_driver_wrapper_mac_sign_setup(operation,
4925 &attributes,
4926 hmac_key, hmac_key_length,
4927 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02004928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 psa_reset_key_attributes(&attributes);
4930 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02004931}
4932#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004933
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004934#define HKDF_STATE_INIT 0 /* no input yet */
4935#define HKDF_STATE_STARTED 1 /* got salt */
4936#define HKDF_STATE_KEYED 2 /* got key */
4937#define HKDF_STATE_OUTPUT 3 /* output started */
4938
Gilles Peskinecbe66502019-05-16 16:59:18 +02004939static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004941{
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
4943 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
4944 } else {
4945 return operation->alg;
4946 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004947}
4948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004950{
4951 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
4953 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004954 /* The object has (apparently) been initialized but it is not
4955 * in use. It's ok to call abort on such an object, and there's
4956 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004958#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
4960 mbedtls_free(operation->ctx.hkdf.info);
4961 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
4962 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004963#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08004964#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4965 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4967 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
4968 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4969 if (operation->ctx.tls12_prf.secret != NULL) {
4970 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
4971 operation->ctx.tls12_prf.secret_length);
4972 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooremana6df6042021-04-29 19:32:25 +02004973 }
4974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (operation->ctx.tls12_prf.seed != NULL) {
4976 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
4977 operation->ctx.tls12_prf.seed_length);
4978 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01004979 }
4980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 if (operation->ctx.tls12_prf.label != NULL) {
4982 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
4983 operation->ctx.tls12_prf.label_length);
4984 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01004985 }
4986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if (operation->ctx.tls12_prf.other_secret != NULL) {
4988 mbedtls_platform_zeroize(operation->ctx.tls12_prf.other_secret,
4989 operation->ctx.tls12_prf.other_secret_length);
4990 mbedtls_free(operation->ctx.tls12_prf.other_secret);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02004991 }
4992
Steven Cooremana6df6042021-04-29 19:32:25 +02004993 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004994
4995 /* We leave the fields Ai and output_block to be erased safely by the
4996 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004998#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4999 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005000#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5002 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5003 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5004 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005005#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005006 {
5007 status = PSA_ERROR_BAD_STATE;
5008 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 mbedtls_platform_zeroize(operation, sizeof(*operation));
5010 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005011}
5012
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005013psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005015{
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005017 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005019 }
5020
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005021 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005023}
5024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5026 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005027{
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 if (operation->alg == 0) {
5029 return PSA_ERROR_BAD_STATE;
5030 }
5031 if (capacity > operation->capacity) {
5032 return PSA_ERROR_INVALID_ARGUMENT;
5033 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005034 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005036}
5037
Przemek Stekiel69c46792022-06-10 12:59:51 +02005038#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005039/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005040static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5041 psa_algorithm_t kdf_alg,
5042 uint8_t *output,
5043 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005044{
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5046 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005047 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005048 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005049#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005051#else
5052 const uint8_t last_block = 0xff;
5053#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005054
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (hkdf->state < HKDF_STATE_KEYED ||
5056 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005057#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005059#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 )) {
5061 return PSA_ERROR_BAD_STATE;
5062 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005063 hkdf->state = HKDF_STATE_OUTPUT;
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005066 /* Copy what remains of the current block */
5067 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005069 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 }
5071 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005072 output += n;
5073 output_length -= n;
5074 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005076 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005078 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005079 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005080 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005081 * object was corrupted or if this function is called directly
5082 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 if (hkdf->block_number == last_block) {
5084 return PSA_ERROR_BAD_STATE;
5085 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005086
5087 /* We need a new block */
5088 ++hkdf->block_number;
5089 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5092 hash_alg,
5093 hkdf->prk,
5094 hash_length);
5095 if (status != PSA_SUCCESS) {
5096 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005097 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005098
5099 if (hkdf->block_number != 1) {
5100 status = psa_mac_update(&hkdf->hmac,
5101 hkdf->output_block,
5102 hash_length);
5103 if (status != PSA_SUCCESS) {
5104 return status;
5105 }
5106 }
5107 status = psa_mac_update(&hkdf->hmac,
5108 hkdf->info,
5109 hkdf->info_length);
5110 if (status != PSA_SUCCESS) {
5111 return status;
5112 }
5113 status = psa_mac_update(&hkdf->hmac,
5114 &hkdf->block_number, 1);
5115 if (status != PSA_SUCCESS) {
5116 return status;
5117 }
5118 status = psa_mac_sign_finish(&hkdf->hmac,
5119 hkdf->output_block,
5120 sizeof(hkdf->output_block),
5121 &hmac_output_length);
5122 if (status != PSA_SUCCESS) {
5123 return status;
5124 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005125 }
5126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005128}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005129#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005130
John Durkop07cc04a2020-11-16 22:08:34 -08005131#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5132 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005133static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5134 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005136{
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5138 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005139 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5140 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005141 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005142
Janos Follath7742fee2019-06-17 12:58:10 +01005143 /* We can't be wanting more output after block 0xff, otherwise
5144 * the capacity check in psa_key_derivation_output_bytes() would have
5145 * prevented this call. It could happen only if the operation
5146 * object was corrupted or if this function is called directly
5147 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (tls12_prf->block_number == 0xff) {
5149 return PSA_ERROR_CORRUPTION_DETECTED;
5150 }
Janos Follath7742fee2019-06-17 12:58:10 +01005151
5152 /* We need a new block */
5153 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005154 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005155
5156 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5157 *
5158 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5159 *
5160 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5161 * HMAC_hash(secret, A(2) + seed) +
5162 * HMAC_hash(secret, A(3) + seed) + ...
5163 *
5164 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005165 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005166 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005167 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005168 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005169 * is currently extracted as `output_block` and where i is
5170 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005171 */
5172
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 status = psa_key_derivation_start_hmac(&hmac,
5174 hash_alg,
5175 tls12_prf->secret,
5176 tls12_prf->secret_length);
5177 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005178 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005180
5181 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005183 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5184 * the variable seed and in this instance means it in the context of the
5185 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 status = psa_mac_update(&hmac,
5187 tls12_prf->label,
5188 tls12_prf->label_length);
5189 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005190 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 }
5192 status = psa_mac_update(&hmac,
5193 tls12_prf->seed,
5194 tls12_prf->seed_length);
5195 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005196 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 }
5198 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005199 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5201 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005202 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005204 }
5205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 status = psa_mac_sign_finish(&hmac,
5207 tls12_prf->Ai, hash_length,
5208 &hmac_output_length);
5209 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005210 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 }
5212 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005213 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005215
5216 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 status = psa_key_derivation_start_hmac(&hmac,
5218 hash_alg,
5219 tls12_prf->secret,
5220 tls12_prf->secret_length);
5221 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005222 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 }
5224 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5225 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005226 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 }
5228 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5229 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005230 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 }
5232 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5233 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005234 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 }
5236 status = psa_mac_sign_finish(&hmac,
5237 tls12_prf->output_block, hash_length,
5238 &hmac_output_length);
5239 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005240 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005242
Janos Follath7742fee2019-06-17 12:58:10 +01005243
5244cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 cleanup_status = psa_mac_abort(&hmac);
5246 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005247 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005249
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005251}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005252
Janos Follath844eb0e2019-06-19 12:10:49 +01005253static psa_status_t psa_key_derivation_tls12_prf_read(
5254 psa_tls12_prf_key_derivation_t *tls12_prf,
5255 psa_algorithm_t alg,
5256 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005258{
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5260 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005261 psa_status_t status;
5262 uint8_t offset, length;
5263
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005265 case PSA_TLS12_PRF_STATE_LABEL_SET:
5266 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5267 break;
5268 case PSA_TLS12_PRF_STATE_OUTPUT:
5269 break;
5270 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005272 }
5273
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005275 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 if (tls12_prf->left_in_block == 0) {
5277 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5278 alg);
5279 if (status != PSA_SUCCESS) {
5280 return status;
5281 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005282
5283 continue;
5284 }
5285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005287 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005289 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005291
5292 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005294 output += length;
5295 output_length -= length;
5296 tls12_prf->left_in_block -= length;
5297 }
5298
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005300}
John Durkop07cc04a2020-11-16 22:08:34 -08005301#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5302 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005303
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005304#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5305static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5306 psa_tls12_ecjpake_to_pms_t *ecjpake,
5307 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005309{
5310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005311 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005312
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 if (output_length != 32) {
5314 return PSA_ERROR_INVALID_ARGUMENT;
5315 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005316
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5318 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5319 &output_size);
5320 if (status != PSA_SUCCESS) {
5321 return status;
5322 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 if (output_size != output_length) {
5325 return PSA_ERROR_GENERIC_ERROR;
5326 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005327
Gilles Peskine449bd832023-01-11 14:50:10 +01005328 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005329}
5330#endif
5331
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005332psa_status_t psa_key_derivation_output_bytes(
5333 psa_key_derivation_operation_t *operation,
5334 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005336{
5337 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005339
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005341 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005343 }
5344
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005346 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005347 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005348 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005349 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005350 goto exit;
5351 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005353 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005354 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005355 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5356 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005357 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005358 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005360 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005361 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005362
Przemek Stekiel69c46792022-06-10 12:59:51 +02005363#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5365 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5366 output, output_length);
5367 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005368#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005369#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5370 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5372 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5373 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5374 kdf_alg, output,
5375 output_length);
5376 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005377#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5378 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005379#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005381 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5383 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005384#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
5385
Gilles Peskineeab56e42018-07-12 17:12:33 +02005386 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005387 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005389 }
5390
5391exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005393 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005394 * This allows us to differentiate between exhausted operations and
5395 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5396 * operations. */
5397 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005399 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005401 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005403}
5404
David Brown7807bf72021-02-09 16:28:23 -07005405#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005406static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005407{
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if (data_size >= 8) {
5409 mbedtls_des_key_set_parity(data);
5410 }
5411 if (data_size >= 16) {
5412 mbedtls_des_key_set_parity(data + 8);
5413 }
5414 if (data_size >= 24) {
5415 mbedtls_des_key_set_parity(data + 16);
5416 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005417}
David Brown7807bf72021-02-09 16:28:23 -07005418#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005419
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005420/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 * ECC keys on a Weierstrass elliptic curve require the generation
5422 * of a private key which is an integer
5423 * in the range [1, N - 1], where N is the boundary of the private key domain:
5424 * N is the prime p for Diffie-Hellman, or the order of the
5425 * curve’s base point for ECC.
5426 *
5427 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5428 * This function generates the private key using the following process:
5429 *
5430 * 1. Draw a byte string of length ceiling(m/8) bytes.
5431 * 2. If m is not a multiple of 8, set the most significant
5432 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5433 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5434 * 4. If k > N - 2, discard the result and return to step 1.
5435 * 5. Output k + 1 as the private key.
5436 *
5437 * This method allows compliance to NIST standards, specifically the methods titled
5438 * Key-Pair Generation by Testing Candidates in the following publications:
5439 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5440 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5441 * Diffie-Hellman keys.
5442 *
5443 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5444 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5445 *
5446 * Note: Function allocates memory for *data buffer, so given *data should be
5447 * always NULL.
5448 */
Przemek Stekiel7fc07512022-03-04 14:41:11 +01005449#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
5450 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
5451 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
5452 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
5453 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005454static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005455 psa_key_slot_t *slot,
5456 size_t bits,
5457 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005458 uint8_t **data
5459 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005460{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005461 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005462 mbedtls_mpi k;
5463 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005466
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 mbedtls_mpi_init(&k);
5468 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005469
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005470 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005472 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005474
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005476 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005477 goto cleanup;
5478 }
5479
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005480 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005482
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005484
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005485 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005486 /* Let m be the bit size of N. */
5487 size_t m = ecp_group.nbits;
5488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 size_t m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005490
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005491 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005493
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005494 /* Note: This function is always called with *data == NULL and it
5495 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 *data = mbedtls_calloc(1, m_bytes);
5497 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005498 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005499 goto cleanup;
5500 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005503 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005505 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005507
5508 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005510 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005511 * (8 * ceiling(m/8) - m) bits of the first byte in
5512 * the string to zero.
5513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005515 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005516 }
5517
5518 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 * big-endian byte string.
5520 */
5521 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005522
5523 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 * Result of comparison is returned. When it indicates error
5525 * then this function is called again.
5526 */
5527 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005528 }
5529
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005530 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5532 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005533cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (ret != 0) {
5535 status = mbedtls_to_psa_error(ret);
5536 }
5537 if (status != PSA_SUCCESS) {
5538 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005539 *data = NULL;
5540 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 mbedtls_mpi_free(&k);
5542 mbedtls_mpi_free(&diff_N_2);
5543 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005544}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005545
5546/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5547 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5548 *
5549 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5550 * draw a 32-byte string and process it as specified in
5551 * Elliptic Curves for Security [RFC7748] §5.
5552 *
5553 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5554 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5555 *
5556 * Note: Function allocates memory for *data buffer, so given *data should be
5557 * always NULL.
5558 */
5559
5560static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5561 size_t bits,
5562 psa_key_derivation_operation_t *operation,
5563 uint8_t **data
5564 )
5565{
5566 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005567 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005570 case 255:
5571 output_length = 32;
5572 break;
5573 case 448:
5574 output_length = 56;
5575 break;
5576 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005578 break;
5579 }
5580
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005582
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 if (*data == NULL) {
5584 return PSA_ERROR_INSUFFICIENT_MEMORY;
5585 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005586
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005588
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005590 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005594 case 255:
5595 (*data)[0] &= 248;
5596 (*data)[31] &= 127;
5597 (*data)[31] |= 64;
5598 break;
5599 case 448:
5600 (*data)[0] &= 252;
5601 (*data)[55] |= 128;
5602 break;
5603 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005605 break;
5606 }
5607
5608 return status;
5609}
Przemek Stekiel7fc07512022-03-04 14:41:11 +01005610#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
5611 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
5612 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
5613 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
5614 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005615
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005616static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005617 psa_key_slot_t *slot,
5618 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005620{
5621 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305623 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005624 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005625
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5627 return PSA_ERROR_INVALID_ARGUMENT;
5628 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005629
Przemek Stekiel7fc07512022-03-04 14:41:11 +01005630#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
5631 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
5632 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
5633 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
5634 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5636 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5637 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005638 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5640 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005641 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 }
5643 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005644 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5646 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005647 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005649 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005650 } else
Przemek Stekiel7fc07512022-03-04 14:41:11 +01005651#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
5652 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
5653 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
5654 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
5655 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (key_type_is_raw_bytes(slot->attr.type)) {
5657 if (bits % 8 != 0) {
5658 return PSA_ERROR_INVALID_ARGUMENT;
5659 }
5660 data = mbedtls_calloc(1, bytes);
5661 if (data == NULL) {
5662 return PSA_ERROR_INSUFFICIENT_MEMORY;
5663 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005664
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 status = psa_key_derivation_output_bytes(operation, data, bytes);
5666 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005667 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 }
David Brown12ca5032021-02-11 11:02:00 -07005669#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5671 psa_des_set_key_parity(data, bytes);
5672 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005673#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 } else {
5675 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005676 }
Ronald Crondd04d422020-11-28 15:14:42 +01005677
Ronald Cronbf33c932020-11-28 18:06:53 +01005678 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005679 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005681 };
5682
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5684 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5685 &storage_size);
5686 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305687 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 }
Archanad8a83dc2021-06-14 10:04:16 +05305689 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 status = psa_allocate_buffer_to_slot(slot, storage_size);
5691 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305692 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 }
Archanad8a83dc2021-06-14 10:04:16 +05305694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 status = psa_driver_wrapper_import_key(&attributes,
5696 data, bytes,
5697 slot->key.data,
5698 slot->key.bytes,
5699 &slot->key.bytes, &bits);
5700 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01005701 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005703
5704exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 mbedtls_free(data);
5706 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005707}
5708
Gilles Peskine449bd832023-01-11 14:50:10 +01005709psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
5710 psa_key_derivation_operation_t *operation,
5711 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005712{
5713 psa_status_t status;
5714 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005715 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005716
Ronald Cron81709fc2020-11-14 12:10:32 +01005717 *key = MBEDTLS_SVC_KEY_ID_INIT;
5718
Gilles Peskine0f84d622019-09-12 19:03:13 +02005719 /* Reject any attempt to create a zero-length key so that we don't
5720 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 if (psa_get_key_bits(attributes) == 0) {
5722 return PSA_ERROR_INVALID_ARGUMENT;
5723 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005724
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 if (operation->alg == PSA_ALG_NONE) {
5726 return PSA_ERROR_BAD_STATE;
5727 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005728
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 if (!operation->can_output_key) {
5730 return PSA_ERROR_NOT_PERMITTED;
5731 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005732
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
5734 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005735#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005737 /* Deriving a key in a secure element is not implemented yet. */
5738 status = PSA_ERROR_NOT_SUPPORTED;
5739 }
5740#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 if (status == PSA_SUCCESS) {
5742 status = psa_generate_derived_key_internal(slot,
5743 attributes->core.bits,
5744 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005745 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 if (status == PSA_SUCCESS) {
5747 status = psa_finish_key_creation(slot, driver, key);
5748 }
5749 if (status != PSA_SUCCESS) {
5750 psa_fail_key_creation(slot, driver);
5751 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005752
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005754}
5755
Gilles Peskineeab56e42018-07-12 17:12:33 +02005756
5757
5758/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005759/* Key derivation */
5760/****************************************************************/
5761
Steven Cooreman932ffb72021-02-15 12:14:32 +01005762#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005763static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005764{
5765#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 if (PSA_ALG_IS_HKDF(kdf_alg)) {
5767 return 1;
5768 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005769#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02005770#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
5772 return 1;
5773 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02005774#endif
5775#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
5777 return 1;
5778 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005779#endif
5780#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
5782 return 1;
5783 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005784#endif
5785#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5787 return 1;
5788 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005789#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005790#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5792 return 1;
5793 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005794#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005796}
5797
Gilles Peskine449bd832023-01-11 14:50:10 +01005798static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005799{
5800 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 psa_status_t status = psa_hash_setup(&operation, alg);
5802 psa_hash_abort(&operation);
5803 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005804}
5805
Gilles Peskine969c5d62019-01-16 15:53:06 +01005806static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005807 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005809{
Janos Follath5fe19732019-06-20 15:09:30 +01005810 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5811 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01005813
Gilles Peskine969c5d62019-01-16 15:53:06 +01005814 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 if (!is_kdf_alg_supported(kdf_alg)) {
5816 return PSA_ERROR_NOT_SUPPORTED;
5817 }
John Durkop07cc04a2020-11-16 22:08:34 -08005818
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005819 /* All currently supported key derivation algorithms (apart from
Andrzej Kurek702776f2022-09-16 06:22:44 -04005820 * ecjpake to pms) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5822 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
5823 if (kdf_alg != PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5824 if (hash_size == 0) {
5825 return PSA_ERROR_NOT_SUPPORTED;
5826 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005827
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005828 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
5829 * we might fail later, which is somewhat unfriendly and potentially
5830 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 psa_status_t status = psa_hash_try_support(hash_alg);
5832 if (status != PSA_SUCCESS) {
5833 return status;
5834 }
5835 } else {
5836 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005837 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5840 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
5841 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
5842 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005843 }
Andrzej Kurek77638292022-09-16 12:24:52 -04005844#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04005845 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
5847 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005848 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04005850#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
5851 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 operation->capacity = 255 * hash_size;
5853 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005854}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005855
Gilles Peskine449bd832023-01-11 14:50:10 +01005856static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005857{
5858#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 if (alg == PSA_ALG_ECDH) {
5860 return PSA_SUCCESS;
5861 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005862#endif
5863 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005865}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01005866
5867static int psa_key_derivation_allows_free_form_secret_input(
5868 psa_algorithm_t kdf_alg)
5869{
5870#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
5871 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5872 return 0;
5873 }
5874#endif
5875 (void) kdf_alg;
5876 return 1;
5877}
John Durkop07cc04a2020-11-16 22:08:34 -08005878#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
5881 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005882{
5883 psa_status_t status;
5884
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (operation->alg != 0) {
5886 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005887 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005888
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
5890 return PSA_ERROR_INVALID_ARGUMENT;
5891 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
5892#if defined(AT_LEAST_ONE_BUILTIN_KDF)
5893 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
5894 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
5895 status = psa_key_agreement_try_support(ka_alg);
5896 if (status != PSA_SUCCESS) {
5897 return status;
5898 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01005899 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
5900 return PSA_ERROR_INVALID_ARGUMENT;
5901 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
5903#else
5904 return PSA_ERROR_NOT_SUPPORTED;
5905#endif /* AT_LEAST_ONE_BUILTIN_KDF */
5906 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
5907#if defined(AT_LEAST_ONE_BUILTIN_KDF)
5908 status = psa_key_derivation_setup_kdf(operation, alg);
5909#else
5910 return PSA_ERROR_NOT_SUPPORTED;
5911#endif /* AT_LEAST_ONE_BUILTIN_KDF */
5912 } else {
5913 return PSA_ERROR_INVALID_ARGUMENT;
5914 }
5915
5916 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005917 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 }
5919 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005920}
5921
Przemek Stekiel69c46792022-06-10 12:59:51 +02005922#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005923static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
5924 psa_algorithm_t kdf_alg,
5925 psa_key_derivation_step_t step,
5926 const uint8_t *data,
5927 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005928{
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005930 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02005932 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005933#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
5935 return PSA_ERROR_INVALID_ARGUMENT;
5936 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005937#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (hkdf->state != HKDF_STATE_INIT) {
5939 return PSA_ERROR_BAD_STATE;
5940 } else {
5941 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5942 hash_alg,
5943 data, data_length);
5944 if (status != PSA_SUCCESS) {
5945 return status;
5946 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005947 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005949 }
Gilles Peskine03410b52019-05-16 16:05:19 +02005950 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005951#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02005953 /* We shouldn't be in different state as HKDF_EXPAND only allows
5954 * two inputs: SECRET (this case) and INFO which does not modify
5955 * the state. It could happen only if the hkdf
5956 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 if (hkdf->state != HKDF_STATE_INIT) {
5958 return PSA_ERROR_BAD_STATE;
5959 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005960
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02005961 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
5963 return PSA_ERROR_INVALID_ARGUMENT;
5964 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 memcpy(hkdf->prk, data, data_length);
5967 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005968#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005969 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02005970 /* HKDF: If no salt was provided, use an empty salt.
5971 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02005973#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
5975 return PSA_ERROR_BAD_STATE;
5976 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02005977#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5979 hash_alg,
5980 NULL, 0);
5981 if (status != PSA_SUCCESS) {
5982 return status;
5983 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005984 hkdf->state = HKDF_STATE_STARTED;
5985 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 if (hkdf->state != HKDF_STATE_STARTED) {
5987 return PSA_ERROR_BAD_STATE;
5988 }
5989 status = psa_mac_update(&hkdf->hmac,
5990 data, data_length);
5991 if (status != PSA_SUCCESS) {
5992 return status;
5993 }
5994 status = psa_mac_sign_finish(&hkdf->hmac,
5995 hkdf->prk,
5996 sizeof(hkdf->prk),
5997 &data_length);
5998 if (status != PSA_SUCCESS) {
5999 return status;
6000 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006001 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006002
Gilles Peskine2b522db2019-04-12 15:11:49 +02006003 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006004 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006005#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006007 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006009 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006011#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006012 {
6013 /* Block 0 is empty, and the next block will be
6014 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006016 }
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006019 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006020#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6022 return PSA_ERROR_INVALID_ARGUMENT;
6023 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006024#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006025#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6027 hkdf->state == HKDF_STATE_INIT) {
6028 return PSA_ERROR_BAD_STATE;
6029 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006030#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (hkdf->state == HKDF_STATE_OUTPUT) {
6032 return PSA_ERROR_BAD_STATE;
6033 }
6034 if (hkdf->info_set) {
6035 return PSA_ERROR_BAD_STATE;
6036 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006037 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 if (data_length != 0) {
6039 hkdf->info = mbedtls_calloc(1, data_length);
6040 if (hkdf->info == NULL) {
6041 return PSA_ERROR_INSUFFICIENT_MEMORY;
6042 }
6043 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006044 }
6045 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006047 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006049 }
6050}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006051#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006052
John Durkop07cc04a2020-11-16 22:08:34 -08006053#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6054 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006055static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6056 const uint8_t *data,
6057 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006058{
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6060 return PSA_ERROR_BAD_STATE;
6061 }
Janos Follathf08e2652019-06-13 09:05:41 +01006062
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 if (data_length != 0) {
6064 prf->seed = mbedtls_calloc(1, data_length);
6065 if (prf->seed == NULL) {
6066 return PSA_ERROR_INSUFFICIENT_MEMORY;
6067 }
Janos Follathf08e2652019-06-13 09:05:41 +01006068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006070 prf->seed_length = data_length;
6071 }
Janos Follathf08e2652019-06-13 09:05:41 +01006072
Gilles Peskine43f958b2020-12-13 14:55:14 +01006073 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006076}
6077
Gilles Peskine449bd832023-01-11 14:50:10 +01006078static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6079 const uint8_t *data,
6080 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006081{
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6083 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6084 return PSA_ERROR_BAD_STATE;
6085 }
Janos Follath81550542019-06-13 14:26:34 +01006086
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (data_length != 0) {
6088 prf->secret = mbedtls_calloc(1, data_length);
6089 if (prf->secret == NULL) {
6090 return PSA_ERROR_INSUFFICIENT_MEMORY;
6091 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006094 prf->secret_length = data_length;
6095 }
Janos Follath81550542019-06-13 14:26:34 +01006096
Gilles Peskine43f958b2020-12-13 14:55:14 +01006097 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006100}
6101
Gilles Peskine449bd832023-01-11 14:50:10 +01006102static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6103 const uint8_t *data,
6104 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006105{
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6107 return PSA_ERROR_BAD_STATE;
6108 }
Janos Follath63028dd2019-06-13 09:15:47 +01006109
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 if (data_length != 0) {
6111 prf->label = mbedtls_calloc(1, data_length);
6112 if (prf->label == NULL) {
6113 return PSA_ERROR_INSUFFICIENT_MEMORY;
6114 }
Janos Follath63028dd2019-06-13 09:15:47 +01006115
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006117 prf->label_length = data_length;
6118 }
Janos Follath63028dd2019-06-13 09:15:47 +01006119
Gilles Peskine43f958b2020-12-13 14:55:14 +01006120 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006121
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006123}
6124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6126 psa_key_derivation_step_t step,
6127 const uint8_t *data,
6128 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006129{
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006131 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006133 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006135 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006137 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006139 }
6140}
John Durkop07cc04a2020-11-16 22:08:34 -08006141#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6142 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6143
6144#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6145static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6146 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006147 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006149{
6150 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6152 4 + data_length + prf->other_secret_length :
6153 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006154
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6156 return PSA_ERROR_INVALID_ARGUMENT;
6157 }
John Durkop07cc04a2020-11-16 22:08:34 -08006158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 uint8_t *pms = mbedtls_calloc(1, pms_len);
6160 if (pms == NULL) {
6161 return PSA_ERROR_INSUFFICIENT_MEMORY;
6162 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006163 uint8_t *cur = pms;
6164
6165 /* pure-PSK:
6166 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006167 *
6168 * The premaster secret is formed as follows: if the PSK is N octets
6169 * long, concatenate a uint16 with the value N, N zero octets, a second
6170 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006171 *
6172 * mixed-PSK:
6173 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6174 * follows: concatenate a uint16 with the length of the other secret,
6175 * the other secret itself, uint16 with the length of PSK, and the
6176 * PSK itself.
6177 * For details please check:
6178 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6179 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6180 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006181 */
6182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6184 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6185 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6186 if (prf->other_secret_length != 0) {
6187 memcpy(cur, prf->other_secret, prf->other_secret_length);
6188 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006189 cur += prf->other_secret_length;
6190 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 } else {
6192 *cur++ = MBEDTLS_BYTE_1(data_length);
6193 *cur++ = MBEDTLS_BYTE_0(data_length);
6194 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006195 cur += data_length;
6196 }
6197
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 *cur++ = MBEDTLS_BYTE_1(data_length);
6199 *cur++ = MBEDTLS_BYTE_0(data_length);
6200 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006201 cur += data_length;
6202
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08006204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 mbedtls_platform_zeroize(pms, pms_len);
6206 mbedtls_free(pms);
6207 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006208}
Janos Follath6660f0e2019-06-17 08:44:03 +01006209
Przemek Stekiele47201b2022-04-19 13:53:28 +02006210static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6211 psa_tls12_prf_key_derivation_t *prf,
6212 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006214{
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6216 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006217 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006218
6219 if (data_length != 0) {
6220 prf->other_secret = mbedtls_calloc(1, data_length);
6221 if (prf->other_secret == NULL) {
6222 return PSA_ERROR_INSUFFICIENT_MEMORY;
6223 }
6224
6225 memcpy(prf->other_secret, data, data_length);
6226 prf->other_secret_length = data_length;
6227 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006228 prf->other_secret_length = 0;
6229 }
6230
6231 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6232
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006234}
6235
Janos Follath6660f0e2019-06-17 08:44:03 +01006236static psa_status_t psa_tls12_prf_psk_to_ms_input(
6237 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006238 psa_key_derivation_step_t step,
6239 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006241{
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006243 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 return psa_tls12_prf_psk_to_ms_set_key(prf,
6245 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006246 break;
6247 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6249 data,
6250 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006251 break;
6252 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006254 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006255
Przemek Stekiele47201b2022-04-19 13:53:28 +02006256 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006257}
John Durkop07cc04a2020-11-16 22:08:34 -08006258#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006259
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006260#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6261static psa_status_t psa_tls12_ecjpake_to_pms_input(
6262 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006263 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006264 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006266{
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6268 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6269 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006270 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006271
6272 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 if (data[0] != 0x04) {
6274 return PSA_ERROR_INVALID_ARGUMENT;
6275 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006276
6277 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006281}
6282#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskineb8965192019-09-24 16:21:10 +02006283/** Check whether the given key type is acceptable for the given
6284 * input step of a key derivation.
6285 *
6286 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6287 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6288 * Both secret and non-secret inputs can alternatively have the type
6289 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6290 * that the input was passed as a buffer rather than via a key object.
6291 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006292static int psa_key_derivation_check_input_type(
6293 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006295{
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006297 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 if (key_type == PSA_KEY_TYPE_DERIVE) {
6299 return PSA_SUCCESS;
6300 }
6301 if (key_type == PSA_KEY_TYPE_NONE) {
6302 return PSA_SUCCESS;
6303 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006304 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006305 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (key_type == PSA_KEY_TYPE_DERIVE) {
6307 return PSA_SUCCESS;
6308 }
6309 if (key_type == PSA_KEY_TYPE_NONE) {
6310 return PSA_SUCCESS;
6311 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006312 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006313 case PSA_KEY_DERIVATION_INPUT_LABEL:
6314 case PSA_KEY_DERIVATION_INPUT_SALT:
6315 case PSA_KEY_DERIVATION_INPUT_INFO:
6316 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6318 return PSA_SUCCESS;
6319 }
6320 if (key_type == PSA_KEY_TYPE_NONE) {
6321 return PSA_SUCCESS;
6322 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006323 break;
6324 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006326}
6327
Janos Follathb80a94e2019-06-12 15:54:46 +01006328static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006329 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006330 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006331 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006332 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006334{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006335 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006337
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 status = psa_key_derivation_check_input_type(step, key_type);
6339 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006340 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006342
Przemek Stekiel69c46792022-06-10 12:59:51 +02006343#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6345 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6346 step, data, data_length);
6347 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006348#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006349#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6351 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6352 step, data, data_length);
6353 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006354#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6355#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6357 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6358 step, data, data_length);
6359 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006360#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006361#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006363 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6365 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006366#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006367 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006368 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006369 (void) data;
6370 (void) data_length;
6371 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006373 }
6374
Gilles Peskine224b0d62019-09-23 18:13:17 +02006375exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 if (status != PSA_SUCCESS) {
6377 psa_key_derivation_abort(operation);
6378 }
6379 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006380}
6381
Janos Follath51f4a0f2019-06-14 11:35:55 +01006382psa_status_t psa_key_derivation_input_bytes(
6383 psa_key_derivation_operation_t *operation,
6384 psa_key_derivation_step_t step,
6385 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006387{
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 return psa_key_derivation_input_internal(operation, step,
6389 PSA_KEY_TYPE_NONE,
6390 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006391}
6392
Janos Follath51f4a0f2019-06-14 11:35:55 +01006393psa_status_t psa_key_derivation_input_key(
6394 psa_key_derivation_operation_t *operation,
6395 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006397{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006399 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006400 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006401
Ronald Cron5c522922020-11-14 16:35:34 +01006402 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6404 if (status != PSA_SUCCESS) {
6405 psa_key_derivation_abort(operation);
6406 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006407 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006408
6409 /* Passing a key object as a SECRET input unlocks the permission
6410 * to output to a key object. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006412 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006414
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 status = psa_key_derivation_input_internal(operation,
6416 step, slot->attr.type,
6417 slot->key.data,
6418 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006423}
Gilles Peskineea0fb492018-07-12 17:17:20 +02006424
6425
6426
6427/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02006428/* Key agreement */
6429/****************************************************************/
6430
Gilles Peskine449bd832023-01-11 14:50:10 +01006431psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
6432 const uint8_t *key_buffer,
6433 size_t key_buffer_size,
6434 psa_algorithm_t alg,
6435 const uint8_t *peer_key,
6436 size_t peer_key_length,
6437 uint8_t *shared_secret,
6438 size_t shared_secret_size,
6439 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006440{
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08006442#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006443 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
6445 key_buffer_size, alg,
6446 peer_key, peer_key_length,
6447 shared_secret,
6448 shared_secret_size,
6449 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006450#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006451 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01006452 (void) attributes;
6453 (void) key_buffer;
6454 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01006455 (void) peer_key;
6456 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006457 (void) shared_secret;
6458 (void) shared_secret_size;
6459 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006461 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006462}
Gilles Peskine01d718c2018-09-18 12:01:02 +02006463
Aditya Deshpande17845b82022-10-13 17:21:01 +01006464/** Internal function for raw key agreement
6465 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01006466 * to the driver's implementation if a driver is present.
6467 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01006468 * (psa_key_agreement_raw_builtin).
6469 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006470static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
6471 psa_key_slot_t *private_key,
6472 const uint8_t *peer_key,
6473 size_t peer_key_length,
6474 uint8_t *shared_secret,
6475 size_t shared_secret_size,
6476 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006477{
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6479 return PSA_ERROR_NOT_SUPPORTED;
6480 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01006481
6482 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01006484 };
6485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 return psa_driver_wrapper_key_agreement(&attributes,
6487 private_key->key.data,
6488 private_key->key.bytes, alg,
6489 peer_key, peer_key_length,
6490 shared_secret,
6491 shared_secret_size,
6492 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006493}
6494
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006495/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006496 * to potentially free embedded data structures and wipe confidential data.
6497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006498static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
6499 psa_key_derivation_step_t step,
6500 psa_key_slot_t *private_key,
6501 const uint8_t *peer_key,
6502 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02006503{
6504 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00006505 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02006506 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02006508
6509 /* Step 1: run the secret agreement algorithm to generate the shared
6510 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 status = psa_key_agreement_raw_internal(ka_alg,
6512 private_key,
6513 peer_key, peer_key_length,
6514 shared_secret,
6515 sizeof(shared_secret),
6516 &shared_secret_length);
6517 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02006518 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02006520
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006521 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006522 * the shared secret. A shared secret is permitted wherever a key
6523 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 status = psa_key_derivation_input_internal(operation, step,
6525 PSA_KEY_TYPE_DERIVE,
6526 shared_secret,
6527 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02006528exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
6530 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02006531}
6532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
6534 psa_key_derivation_step_t step,
6535 mbedtls_svc_key_id_t private_key,
6536 const uint8_t *peer_key,
6537 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02006538{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006539 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006540 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006541 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
6544 return PSA_ERROR_INVALID_ARGUMENT;
6545 }
Ronald Cron5c522922020-11-14 16:35:34 +01006546 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6548 if (status != PSA_SUCCESS) {
6549 return status;
6550 }
6551 status = psa_key_agreement_internal(operation, step,
6552 slot,
6553 peer_key, peer_key_length);
6554 if (status != PSA_SUCCESS) {
6555 psa_key_derivation_abort(operation);
6556 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006557 /* If a private key has been added as SECRET, we allow the derived
6558 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006560 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006562 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006563
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006567}
6568
Gilles Peskine449bd832023-01-11 14:50:10 +01006569psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
6570 mbedtls_svc_key_id_t private_key,
6571 const uint8_t *peer_key,
6572 size_t peer_key_length,
6573 uint8_t *output,
6574 size_t output_size,
6575 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006576{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006577 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006578 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006579 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006580
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02006582 status = PSA_ERROR_INVALID_ARGUMENT;
6583 goto exit;
6584 }
Ronald Cron5c522922020-11-14 16:35:34 +01006585 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
6587 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02006588 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006590
Gilles Peskine3e561302022-04-14 00:17:15 +02006591 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
6592 * for the output size. The PSA specification only guarantees that this
6593 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
6594 * but it might be nice to allow smaller buffers if the output fits.
6595 * At the time of writing this comment, with only ECDH implemented,
6596 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
6597 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
6598 * be exact for it as well. */
6599 size_t expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
6601 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02006602 status = PSA_ERROR_BUFFER_TOO_SMALL;
6603 goto exit;
6604 }
6605
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 status = psa_key_agreement_raw_internal(alg, slot,
6607 peer_key, peer_key_length,
6608 output, output_size,
6609 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006610
6611exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02006613 /* If an error happens and is not handled properly, the output
6614 * may be used as a key to protect sensitive data. Arrange for such
6615 * a key to be random, which is likely to result in decryption or
6616 * verification errors. This is better than filling the buffer with
6617 * some constant data such as zeros, which would result in the data
6618 * being protected with a reproducible, easily knowable key.
6619 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02006621 *output_length = output_size;
6622 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02006625
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006627}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006628
6629
Gilles Peskine30524eb2020-11-13 17:02:26 +01006630
Gilles Peskine86a440b2018-11-12 18:39:40 +01006631/****************************************************************/
6632/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006633/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006634
Gilles Peskine30524eb2020-11-13 17:02:26 +01006635/** Initialize the PSA random generator.
6636 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006637static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01006638{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006639#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006641#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6642
Gilles Peskine30524eb2020-11-13 17:02:26 +01006643 /* Set default configuration if
6644 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006646 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 }
6648 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006649 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01006653#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6654 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6655 /* The PSA entropy injection feature depends on using NV seed as an entropy
6656 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 mbedtls_entropy_add_source(&rng->entropy,
6658 mbedtls_nv_seed_poll, NULL,
6659 MBEDTLS_ENTROPY_BLOCK_SIZE,
6660 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01006661#endif
6662
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006664#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006665}
6666
6667/** Deinitialize the PSA random generator.
6668 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006669static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01006670{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006671#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006673#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
6675 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006676#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006677}
6678
6679/** Seed the PSA random generator.
6680 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006681static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01006682{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006683#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6684 /* Do nothing: the external RNG seeds itself. */
6685 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006687#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006688 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
6690 drbg_seed, sizeof(drbg_seed) - 1);
6691 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006692#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006693}
6694
Gilles Peskine449bd832023-01-11 14:50:10 +01006695psa_status_t psa_generate_random(uint8_t *output,
6696 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006697{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006698 GUARD_MODULE_INITIALIZED;
6699
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006700#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6701
6702 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
6704 output, output_size,
6705 &output_length);
6706 if (status != PSA_SUCCESS) {
6707 return status;
6708 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006709 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00006710 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 if (output_length != output_size) {
6712 return PSA_ERROR_INSUFFICIENT_ENTROPY;
6713 }
6714 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006715
6716#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006719 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6721 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6722 output_size);
6723 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
6724 output, request_size);
6725 if (ret != 0) {
6726 return mbedtls_to_psa_error(ret);
6727 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01006728 output_size -= request_size;
6729 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006730 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006732#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006733}
6734
Gilles Peskine8814fc42020-12-14 15:33:44 +01006735/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006736 *
6737 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6738 * `psa_generate_random(...)`. The state parameter is ignored since the
6739 * PSA API doesn't support passing an explicit state.
6740 *
6741 * In the non-external case, psa_generate_random() calls an
6742 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6743 * and semantics as mbedtls_psa_get_random(). As an optimization,
6744 * instead of doing this back-and-forth between the PSA API and the
6745 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6746 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006748#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6749int mbedtls_psa_get_random(void *p_rng,
6750 unsigned char *output,
6751 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01006752{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006753 /* This function takes a pointer to the RNG state because that's what
6754 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6755 * its own state internally and doesn't let the caller access that state.
6756 * So we just ignore the state parameter, and in practice we'll pass
6757 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006758 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 psa_status_t status = psa_generate_random(output, output_size);
6760 if (status == PSA_SUCCESS) {
6761 return 0;
6762 } else {
6763 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
6764 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01006765}
6766#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6767
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006768#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00006769#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006770
Gilles Peskine449bd832023-01-11 14:50:10 +01006771psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
6772 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006773{
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 if (global_data.initialized) {
6775 return PSA_ERROR_NOT_PERMITTED;
6776 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006777
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
6779 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
6780 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
6781 return PSA_ERROR_INVALID_ARGUMENT;
6782 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006783
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006785}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006786#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006787
Ronald Cron3772afe2021-02-08 16:10:05 +01006788/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02006789 *
Ronald Cron3772afe2021-02-08 16:10:05 +01006790 * \param type The key type
6791 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02006792 *
6793 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01006794 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02006795 * \retval #PSA_ERROR_INVALID_ARGUMENT
6796 * The size in bits of the key is not valid.
6797 * \retval #PSA_ERROR_NOT_SUPPORTED
6798 * The type and/or the size in bits of the key or the combination of
6799 * the two is not supported.
6800 */
Ronald Cron3772afe2021-02-08 16:10:05 +01006801static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006803{
Ronald Cronf3bb7612020-10-02 20:11:59 +02006804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 if (key_type_is_raw_bytes(type)) {
6807 status = psa_validate_unstructured_key_bit_size(type, bits);
6808 if (status != PSA_SUCCESS) {
6809 return status;
6810 }
6811 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006812#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
6814 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
6815 return PSA_ERROR_NOT_SUPPORTED;
6816 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006817
Ronald Cron01b2aba2020-10-05 09:42:02 +02006818 /* Accept only byte-aligned keys, for the same reasons as
6819 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 if (bits % 8 != 0) {
6821 return PSA_ERROR_NOT_SUPPORTED;
6822 }
6823 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006824#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006825
Ronald Cron5c4d3862020-12-07 11:07:24 +01006826#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01006828 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 return PSA_SUCCESS;
6830 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006831#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006832 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006834 }
6835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006837}
6838
Ronald Cron55ed0592020-10-05 10:30:40 +02006839psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006840 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006842{
6843 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006844 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 if ((attributes->domain_parameters == NULL) &&
6847 (attributes->domain_parameters_size != 0)) {
6848 return PSA_ERROR_INVALID_ARGUMENT;
6849 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02006850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 if (key_type_is_raw_bytes(type)) {
6852 status = psa_generate_random(key_buffer, key_buffer_size);
6853 if (status != PSA_SUCCESS) {
6854 return status;
6855 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006856
David Brown12ca5032021-02-11 11:02:00 -07006857#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 if (type == PSA_KEY_TYPE_DES) {
6859 psa_des_set_key_parity(key_buffer, key_buffer_size);
6860 }
David Brown8107e312021-02-12 08:08:46 -07006861#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01006863
Jaeden Amero424fa932021-05-14 08:34:32 +01006864#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
6865 defined(MBEDTLS_GENPRIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
6867 return mbedtls_psa_rsa_generate_key(attributes,
6868 key_buffer,
6869 key_buffer_size,
6870 key_buffer_length);
6871 } else
Jaeden Amero424fa932021-05-14 08:34:32 +01006872#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
6873 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006874
John Durkop9814fa22020-11-04 12:28:15 -08006875#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
6877 return mbedtls_psa_ecp_generate_key(attributes,
6878 key_buffer,
6879 key_buffer_size,
6880 key_buffer_length);
6881 } else
John Durkop9814fa22020-11-04 12:28:15 -08006882#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006883 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 (void) key_buffer_length;
6885 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02006886 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006889}
Darryl Green0c6575a2018-11-07 16:05:30 +00006890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
6892 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006893{
6894 psa_status_t status;
6895 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006896 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02006897 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02006898
Ronald Cron81709fc2020-11-14 12:10:32 +01006899 *key = MBEDTLS_SVC_KEY_ID_INIT;
6900
Gilles Peskine0f84d622019-09-12 19:03:13 +02006901 /* Reject any attempt to create a zero-length key so that we don't
6902 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 if (psa_get_key_bits(attributes) == 0) {
6904 return PSA_ERROR_INVALID_ARGUMENT;
6905 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006906
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02006907 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
6909 return PSA_ERROR_INVALID_ARGUMENT;
6910 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02006911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
6913 &slot, &driver);
6914 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02006915 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 }
Gilles Peskine11792082019-08-06 18:36:36 +02006917
Ronald Cron977c2472020-10-13 08:32:21 +02006918 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05306919 * storage ( thus not in the case of generating a key in a secure element
6920 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
6921 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 if (slot->key.data == NULL) {
6923 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
6924 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01006925 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 attributes->core.type, attributes->core.bits);
6927 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01006928 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 }
Ronald Cron3772afe2021-02-08 16:10:05 +01006930
6931 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 attributes->core.type,
6933 attributes->core.bits);
6934 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02006935 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 attributes, &key_buffer_size);
6937 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01006938 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 }
Ronald Cron977c2472020-10-13 08:32:21 +02006940 }
Ronald Cron977c2472020-10-13 08:32:21 +02006941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
6943 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02006944 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 }
Ronald Cron977c2472020-10-13 08:32:21 +02006946 }
6947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 status = psa_driver_wrapper_generate_key(attributes,
6949 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02006950
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (status != PSA_SUCCESS) {
6952 psa_remove_key_data_from_memory(slot);
6953 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02006954
Gilles Peskine11792082019-08-06 18:36:36 +02006955exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 if (status == PSA_SUCCESS) {
6957 status = psa_finish_key_creation(slot, driver, key);
6958 }
6959 if (status != PSA_SUCCESS) {
6960 psa_fail_key_creation(slot, driver);
6961 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006962
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006964}
6965
Gilles Peskinee59236f2018-01-27 23:32:46 +01006966/****************************************************************/
6967/* Module setup */
6968/****************************************************************/
6969
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006970#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006971psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 void (* entropy_init)(mbedtls_entropy_context *ctx),
6973 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01006974{
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
6976 return PSA_ERROR_BAD_STATE;
6977 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01006978 global_data.rng.entropy_init = entropy_init;
6979 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01006981}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006982#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006985{
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 psa_wipe_all_key_slots();
6987 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
6988 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01006989 }
6990 /* Wipe all remaining data, including configuration.
6991 * In particular, this sets all state indicator to the value
6992 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02006994
6995 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01006997}
6998
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006999#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7000/** Recover a transaction that was interrupted by a power failure.
7001 *
7002 * This function is called during initialization, before psa_crypto_init()
7003 * returns. If this function returns a failure status, the initialization
7004 * fails.
7005 */
7006static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007008{
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007010 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7011 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 /* TODO - fall through to the failure case until this
7013 * is implemented.
7014 * https://github.com/ARMmbed/mbed-crypto/issues/218
7015 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007016 default:
7017 /* We found an unsupported transaction in the storage.
7018 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007020 }
7021}
7022#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007025{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007026 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007027
Gilles Peskinec6b69072018-11-20 21:42:52 +01007028 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 if (global_data.initialized != 0) {
7030 return PSA_SUCCESS;
7031 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007032
Gilles Peskine30524eb2020-11-13 17:02:26 +01007033 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007035 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 status = mbedtls_psa_random_seed(&global_data.rng);
7037 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007038 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007040 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 status = psa_initialize_key_slots();
7043 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007044 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007046
Ronald Cron9ba76912021-04-10 16:57:30 +02007047 /* Init drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 status = psa_driver_wrapper_init();
7049 if (status != PSA_SUCCESS) {
Gilles Peskined9348f22019-10-01 15:22:29 +02007050 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 }
Gilles Peskined9348f22019-10-01 15:22:29 +02007052
Gilles Peskine4b734222019-07-24 15:56:31 +02007053#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 status = psa_crypto_load_transaction();
7055 if (status == PSA_SUCCESS) {
7056 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7057 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007058 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 }
7060 status = psa_crypto_stop_transaction();
7061 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007062 /* There's no transaction to complete. It's all good. */
7063 status = PSA_SUCCESS;
7064 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007065#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007066
Gilles Peskinec6b69072018-11-20 21:42:52 +01007067 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007068 global_data.initialized = 1;
7069
7070exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (status != PSA_SUCCESS) {
7072 mbedtls_psa_crypto_free();
7073 }
7074 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007075}
7076
7077#endif /* MBEDTLS_PSA_CRYPTO_C */