blob: 954abea594cd1ece2db2d6994d1e5beae066d989 [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"
Gilles Peskinea5905292018-02-07 20:59:33 +010084
Gilles Peskine996deb12018-08-01 15:45:45 +020085#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
86
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020087#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
88 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
89 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020090#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020091#endif
92
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010093/****************************************************************/
94/* Global data, support functions and library management */
95/****************************************************************/
96
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097static int key_type_is_raw_bytes( psa_key_type_t type )
98{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020099 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200100}
101
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100102/* Values for psa_global_data_t::rng_state */
103#define RNG_NOT_INITIALIZED 0
104#define RNG_INITIALIZED 1
105#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100106
Gilles Peskine2d277862018-06-18 15:41:12 +0200107typedef struct
108{
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 \
122 if( global_data.initialized == 0 ) \
123 return( PSA_ERROR_BAD_STATE );
124
Steven Cooreman01164162020-07-20 15:31:37 +0200125psa_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. */
130 int low_level_ret = - ( -ret & 0x007f );
131 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100132 {
133 case 0:
134 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100135
136 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
137 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100138 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200139 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
140 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
141 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
142 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
143 case MBEDTLS_ERR_ASN1_INVALID_DATA:
144 return( PSA_ERROR_INVALID_ARGUMENT );
145 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
146 return( PSA_ERROR_INSUFFICIENT_MEMORY );
147 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
148 return( PSA_ERROR_BUFFER_TOO_SMALL );
149
Jaeden Amero93e21112019-02-20 13:57:28 +0000150#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000151 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000152#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100153 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
154 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100155
156 case MBEDTLS_ERR_CCM_BAD_INPUT:
157 return( PSA_ERROR_INVALID_ARGUMENT );
158 case MBEDTLS_ERR_CCM_AUTH_FAILED:
159 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100160
Gilles Peskine26869f22019-05-06 15:25:00 +0200161 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
162 return( PSA_ERROR_INVALID_ARGUMENT );
163
164 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
165 return( PSA_ERROR_BAD_STATE );
166 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
167 return( PSA_ERROR_INVALID_SIGNATURE );
168
Gilles Peskinea5905292018-02-07 20:59:33 +0100169 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
170 return( PSA_ERROR_NOT_SUPPORTED );
171 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
172 return( PSA_ERROR_INVALID_ARGUMENT );
173 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
174 return( PSA_ERROR_INSUFFICIENT_MEMORY );
175 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
176 return( PSA_ERROR_INVALID_PADDING );
177 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200178 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100179 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
180 return( PSA_ERROR_INVALID_SIGNATURE );
181 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200182 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100183
Gilles Peskine82e57d12020-11-13 21:31:17 +0100184#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
185 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100186 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
187 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100188 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
189 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
190 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
191 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
192 return( PSA_ERROR_NOT_SUPPORTED );
193 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
194 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100195#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
197 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
198 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100199
Gilles Peskinee59236f2018-01-27 23:32:46 +0100200 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
201 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
202 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
203 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100204
205 case MBEDTLS_ERR_GCM_AUTH_FAILED:
206 return( PSA_ERROR_INVALID_SIGNATURE );
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200207 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
208 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100209 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200210 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100211
Gilles Peskine82e57d12020-11-13 21:31:17 +0100212#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
213 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100214 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
215 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100216 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
219 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
220 return( PSA_ERROR_NOT_SUPPORTED );
221 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
222 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
223#endif
224
Gilles Peskinea5905292018-02-07 20:59:33 +0100225 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
226 return( PSA_ERROR_NOT_SUPPORTED );
227 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
228 return( PSA_ERROR_INVALID_ARGUMENT );
229 case MBEDTLS_ERR_MD_ALLOC_FAILED:
230 return( PSA_ERROR_INSUFFICIENT_MEMORY );
231 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
232 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
Gilles Peskinef76aa772018-10-29 19:24:33 +0100234 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
235 return( PSA_ERROR_STORAGE_FAILURE );
236 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
237 return( PSA_ERROR_INVALID_ARGUMENT );
238 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
239 return( PSA_ERROR_INVALID_ARGUMENT );
240 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
241 return( PSA_ERROR_BUFFER_TOO_SMALL );
242 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
243 return( PSA_ERROR_INVALID_ARGUMENT );
244 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
245 return( PSA_ERROR_INVALID_ARGUMENT );
246 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
247 return( PSA_ERROR_INVALID_ARGUMENT );
248 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_MEMORY );
250
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100251 case MBEDTLS_ERR_PK_ALLOC_FAILED:
252 return( PSA_ERROR_INSUFFICIENT_MEMORY );
253 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
254 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
255 return( PSA_ERROR_INVALID_ARGUMENT );
256 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100257 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100258 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
259 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
262 return( PSA_ERROR_NOT_SUPPORTED );
263 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
264 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
265 return( PSA_ERROR_NOT_PERMITTED );
266 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_PK_INVALID_ALG:
269 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
270 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
271 return( PSA_ERROR_NOT_SUPPORTED );
272 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
273 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200274 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
275 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100276
Gilles Peskineff2d2002019-05-06 15:26:23 +0200277 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
278 return( PSA_ERROR_HARDWARE_FAILURE );
279 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
280 return( PSA_ERROR_NOT_SUPPORTED );
281
Gilles Peskinea5905292018-02-07 20:59:33 +0100282 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
283 return( PSA_ERROR_INVALID_ARGUMENT );
284 case MBEDTLS_ERR_RSA_INVALID_PADDING:
285 return( PSA_ERROR_INVALID_PADDING );
286 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
287 return( PSA_ERROR_HARDWARE_FAILURE );
288 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
289 return( PSA_ERROR_INVALID_ARGUMENT );
290 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
291 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200292 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100293 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
294 return( PSA_ERROR_INVALID_SIGNATURE );
295 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
296 return( PSA_ERROR_BUFFER_TOO_SMALL );
297 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100298 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200299
itayzafrir5c753392018-05-08 11:18:38 +0300300 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300301 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300302 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300303 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
304 return( PSA_ERROR_BUFFER_TOO_SMALL );
305 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
306 return( PSA_ERROR_NOT_SUPPORTED );
307 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
308 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
309 return( PSA_ERROR_INVALID_SIGNATURE );
310 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
311 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100312 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
313 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100314
Janos Follatha13b9052019-11-22 12:48:59 +0000315 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
316 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300317
Gilles Peskinee59236f2018-01-27 23:32:46 +0100318 default:
David Saadab4ecc272019-02-14 13:48:10 +0200319 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100320 }
321}
322
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200323
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200324
325
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100326/****************************************************************/
327/* Key management */
328/****************************************************************/
329
John Durkop9814fa22020-11-04 12:28:15 -0800330#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800331 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cronf467d632021-11-19 18:02:34 +0100332 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
333 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
334 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100335mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100336 size_t bits,
337 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200338{
339 switch( curve )
340 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100341 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100342 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100343 {
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 Peskine228abc52019-12-03 17:24:19 +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 Peskine228abc52019-12-03 17:24:19 +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 Peskine228abc52019-12-03 17:24:19 +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 Peskine228abc52019-12-03 17:24:19 +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 Peskine228abc52019-12-03 17:24:19 +0100362 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100363 case 528:
364 if( bits_is_sloppy )
365 return( MBEDTLS_ECP_DP_SECP521R1 );
366 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100367#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100368 }
369 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100370
Paul Elliott8ff510a2020-06-02 17:19:28 +0100371 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100372 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100373 {
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 Peskine228abc52019-12-03 17:24:19 +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 Peskine228abc52019-12-03 17:24:19 +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 Peskine228abc52019-12-03 17:24:19 +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 Peskine2fa6b5f2021-01-27 15:44:45 +0100390 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100391 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100392#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100393 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100394 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100395 case 256:
396 if( bits_is_sloppy )
397 return( MBEDTLS_ECP_DP_CURVE25519 );
398 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 Peskine228abc52019-12-03 17:24:19 +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 Peskine2fa6b5f2021-01-27 15:44:45 +0100408 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100409 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100410#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100411 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100413#endif
414#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100415 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100416 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100417#endif
418#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100419 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100420 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100421#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100422 }
423 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200424 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100426 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200428}
John Durkop9814fa22020-11-04 12:28:15 -0800429#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cronf467d632021-11-19 18:02:34 +0100430 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
431 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
432 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
433 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200434
Archana4d7ae1d2021-07-07 02:50:22 +0530435psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530436 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200437{
438 /* Check that the bit size is acceptable for the key type */
439 switch( type )
440 {
441 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200442 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200443 case PSA_KEY_TYPE_DERIVE:
444 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:
447 if( bits != 128 && bits != 192 && bits != 256 )
448 return( PSA_ERROR_INVALID_ARGUMENT );
449 break;
450#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200451#if defined(PSA_WANT_KEY_TYPE_ARIA)
452 case PSA_KEY_TYPE_ARIA:
453 if( bits != 128 && bits != 192 && bits != 256 )
454 return( PSA_ERROR_INVALID_ARGUMENT );
455 break;
456#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100457#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200458 case PSA_KEY_TYPE_CAMELLIA:
459 if( bits != 128 && bits != 192 && bits != 256 )
460 return( PSA_ERROR_INVALID_ARGUMENT );
461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_DES:
465 if( bits != 64 && bits != 128 && bits != 192 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100469#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200470 case PSA_KEY_TYPE_CHACHA20:
471 if( bits != 256 )
472 return( PSA_ERROR_INVALID_ARGUMENT );
473 break;
474#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 default:
476 return( PSA_ERROR_NOT_SUPPORTED );
477 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200478 if( bits % 8 != 0 )
479 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200480
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200481 return( PSA_SUCCESS );
482}
483
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100484/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100485 *
Steven Cooremancd640932021-03-08 12:00:27 +0100486 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
487 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 *
489 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100490 * \param[in] key_type The key type of the key to be used with the
491 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100492 *
493 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100497 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100499 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100500 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501{
Steven Cooremancd640932021-03-08 12:00:27 +0100502 if( PSA_ALG_IS_HMAC( algorithm ) )
503 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 if( key_type == PSA_KEY_TYPE_HMAC )
505 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100506 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100507
508 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100509 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100510 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
511 * key. */
512 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
513 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
514 {
515 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
516 * the block length (larger than 1) for block ciphers. */
517 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
518 return( PSA_SUCCESS );
519 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100520 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100521
522 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100523}
524
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200525psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
526 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200527{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100528 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200529 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200530
Ronald Cronea0f8a62020-11-25 17:52:23 +0100531 slot->key.data = mbedtls_calloc( 1, buffer_length );
532 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200533 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200534
Ronald Cronea0f8a62020-11-25 17:52:23 +0100535 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200536 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200537}
538
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200539psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
540 const uint8_t* data,
541 size_t data_length )
542{
543 psa_status_t status = psa_allocate_buffer_to_slot( slot,
544 data_length );
545 if( status != PSA_SUCCESS )
546 return( status );
547
Ronald Cronea0f8a62020-11-25 17:52:23 +0100548 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200549 return( PSA_SUCCESS );
550}
551
Ronald Crona0fe59f2020-11-29 11:14:53 +0100552psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100553 const psa_key_attributes_t *attributes,
554 const uint8_t *data, size_t data_length,
555 uint8_t *key_buffer, size_t key_buffer_size,
556 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100557{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100558 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
559 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100560
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200561 /* zero-length keys are never supported. */
562 if( data_length == 0 )
563 return( PSA_ERROR_NOT_SUPPORTED );
564
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100566 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100567 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200568
Archana449608b2021-09-08 15:36:05 +0530569 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
570 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200571 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200572 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573
Ronald Crondd04d422020-11-28 15:14:42 +0100574 /* Copy the key material. */
575 memcpy( key_buffer, data, data_length );
576 *key_buffer_length = data_length;
577 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200578
Steven Cooreman40120f62020-10-29 11:42:22 +0100579 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100580 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100581 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200582 {
John Durkop9814fa22020-11-04 12:28:15 -0800583#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
584 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200586 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100587 return( mbedtls_psa_ecp_import_key( attributes,
588 data, data_length,
589 key_buffer, key_buffer_size,
590 key_buffer_length,
591 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100592 }
John Durkop9814fa22020-11-04 12:28:15 -0800593#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
594 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700595#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
596 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200598 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100599 return( mbedtls_psa_rsa_import_key( attributes,
600 data, data_length,
601 key_buffer, key_buffer_size,
602 key_buffer_length,
603 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200604 }
John Durkop9814fa22020-11-04 12:28:15 -0800605#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
606 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100608
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100609 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100610}
611
Gilles Peskinef603c712019-01-19 13:40:11 +0100612/** Calculate the intersection of two algorithm usage policies.
613 *
614 * Return 0 (which allows no operation) on incompatibility.
615 */
616static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100617 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100618 psa_algorithm_t alg1,
619 psa_algorithm_t alg2 )
620{
Gilles Peskine549ea862019-05-22 11:45:59 +0200621 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100622 if( alg1 == alg2 )
623 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100624 /* If the policies are from the same hash-and-sign family, check
625 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200626 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
627 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100628 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100629 {
Steven Cooreman03488022021-02-18 12:07:20 +0100630 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
631 return( alg2 );
632 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
633 return( alg1 );
634 }
635 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100636 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100637 * restrictive tag length. */
638 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
639 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
640 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
641 {
642 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
643 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100644 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100645
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100646 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100647 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
648 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100649 {
Steven Cooremancd640932021-03-08 12:00:27 +0100650 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
651 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100652 }
653 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100654 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100655 ( alg1_len <= alg2_len ) )
656 {
657 return( alg2 );
658 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100659 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100660 ( alg2_len <= alg1_len ) )
661 {
662 return( alg1 );
663 }
664 }
665 /* If the policies are from the same MAC family, check whether one
666 * of them is a minimum-MAC-length policy. Calculate the most
667 * restrictive tag length. */
668 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
669 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
670 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
671 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100672 /* Validate the combination of key type and algorithm. Since the base
673 * algorithm of alg1 and alg2 are the same, we only need this once. */
674 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100675 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100676
Steven Cooreman31a876d2021-03-03 20:47:40 +0100677 /* Get the (exact or at-least) output lengths for both sides of the
678 * requested intersection. None of the currently supported algorithms
679 * have an output length dependent on the actual key size, so setting it
680 * to a bogus value of 0 is currently OK.
681 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100682 * Note that for at-least-this-length wildcard algorithms, the output
683 * length is set to the shortest allowed length, which allows us to
684 * calculate the most restrictive tag length for the intersection. */
685 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
686 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100687 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100688
Steven Cooremana1d83222021-02-25 10:20:29 +0100689 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100690 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
691 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100692 {
Steven Cooremancd640932021-03-08 12:00:27 +0100693 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100694 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100695
696 /* If only one is an at-least-this-length policy, the intersection would
697 * be the other (fixed-length) policy as long as said fixed length is
698 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100700 {
Steven Cooremancd640932021-03-08 12:00:27 +0100701 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100702 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100703 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100704 {
Steven Cooremancd640932021-03-08 12:00:27 +0100705 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. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100712 if( alg1_len == alg2_len )
713 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100714 }
715 /* If the policies are incompatible, allow nothing. */
716 return( 0 );
717}
718
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100719static int psa_key_algorithm_permits( psa_key_type_t key_type,
720 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200721 psa_algorithm_t requested_alg )
722{
Gilles Peskine549ea862019-05-22 11:45:59 +0200723 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200724 if( requested_alg == policy_alg )
725 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100726 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
727 * and requested_alg is the same hash-and-sign family with any hash,
728 * then requested_alg is compliant with policy_alg. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200729 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100730 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200731 {
Steven Cooreman03488022021-02-18 12:07:20 +0100732 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
733 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
734 }
735 /* If policy_alg is a wildcard AEAD algorithm of the same base as
736 * the requested algorithm, check the requested tag length to be
737 * equal-length or longer than the wildcard-specified length. */
738 if( PSA_ALG_IS_AEAD( policy_alg ) &&
739 PSA_ALG_IS_AEAD( requested_alg ) &&
740 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
741 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100742 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100743 {
744 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
745 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
746 }
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. */
Steven Cooreman03488022021-02-18 12:07:20 +0100749 if( PSA_ALG_IS_MAC( policy_alg ) &&
750 PSA_ALG_IS_MAC( requested_alg ) &&
751 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100752 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100753 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100754 /* Validate the combination of key type and algorithm. Since the policy
755 * and requested algorithms are the same, we only need this once. */
756 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100757 return( 0 );
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(
765 key_type, 0, requested_alg );
766 size_t default_output_length = PSA_MAC_LENGTH(
767 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. */
772 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774
775 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100776 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
778 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
779 {
780 return( 1 );
781 }
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. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100786 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
787 {
788 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100789 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200791 }
Steven Cooremance48e852020-10-05 16:02:45 +0200792 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200793 * a key derivation with that key agreement should also be allowed. This
794 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200795 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
796 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
797 {
798 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
799 policy_alg );
800 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100801 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200802 return( 0 );
803}
804
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100805/** Test whether a policy permits an algorithm.
806 *
807 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100808 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100809 * \note This function requires providing the key type for which the policy is
810 * being validated, since some algorithm policy definitions (e.g. MAC)
811 * have different properties depending on what kind of cipher it is
812 * combined with.
813 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814 * \retval PSA_SUCCESS When \p alg is a specific algorithm
815 * allowed by the \p policy.
816 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
817 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
818 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100819 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100821 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100822 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823{
Steven Cooremand788fab2021-02-25 11:29:17 +0100824 /* '0' is not a valid algorithm */
825 if( alg == 0 )
826 return( PSA_ERROR_INVALID_ARGUMENT );
827
Steven Cooreman7e39f052021-02-23 14:18:32 +0100828 /* A requested algorithm cannot be a wildcard. */
829 if( PSA_ALG_IS_WILDCARD( alg ) )
830 return( PSA_ERROR_INVALID_ARGUMENT );
831
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100832 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
833 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 return( PSA_SUCCESS );
835 else
836 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837}
838
Gilles Peskinef603c712019-01-19 13:40:11 +0100839/** Restrict a key policy based on a constraint.
840 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100841 * \note This function requires providing the key type for which the policy is
842 * being restricted, since some algorithm policy definitions (e.g. MAC)
843 * have different properties depending on what kind of cipher it is
844 * combined with.
845 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100846 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100847 * \param[in,out] policy The policy to restrict.
848 * \param[in] constraint The policy constraint to apply.
849 *
850 * \retval #PSA_SUCCESS
851 * \c *policy contains the intersection of the original value of
852 * \c *policy and \c *constraint.
853 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100854 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100855 * \c *policy is unchanged.
856 */
857static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100858 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100859 psa_key_policy_t *policy,
860 const psa_key_policy_t *constraint )
861{
862 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100863 psa_key_policy_algorithm_intersection( key_type, policy->alg,
864 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200865 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100866 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
867 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
871 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100872 policy->usage &= constraint->usage;
873 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200874 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 return( PSA_SUCCESS );
876}
877
Ronald Cron5c522922020-11-14 16:35:34 +0100878/** Get the description of a key given its identifier and policy constraints
879 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200880 *
Ronald Cron5c522922020-11-14 16:35:34 +0100881 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100882 * nonzero, the key must allow operations with this algorithm. If \p alg is
883 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100884 *
Ronald Cron5c522922020-11-14 16:35:34 +0100885 * In case of a persistent key, the function loads the description of the key
886 * into a key slot if not already done.
887 *
888 * On success, the returned key slot is locked. It is the responsibility of
889 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200890 */
Ronald Cron5c522922020-11-14 16:35:34 +0100891static psa_status_t psa_get_and_lock_key_slot_with_policy(
892 mbedtls_svc_key_id_t key,
893 psa_key_slot_t **p_slot,
894 psa_key_usage_t usage,
895 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100896{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200897 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
898 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100899
Ronald Cron5c522922020-11-14 16:35:34 +0100900 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100901 if( status != PSA_SUCCESS )
902 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100904
905 /* Enforce that usage policy for the key slot contains all the flags
906 * required by the usage parameter. There is one exception: public
907 * keys can always be exported, so we treat public key objects as
908 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200909 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100910 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200911
Gilles Peskine8e338702019-07-30 20:06:31 +0200912 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100913 {
914 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200915 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100916 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100917
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800918 /* Enforce that the usage policy permits the requested algorithm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100919 if( alg != 0 )
920 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100921 status = psa_key_policy_permits( &slot->attr.policy,
922 slot->attr.type,
923 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 if( status != PSA_SUCCESS )
925 goto error;
926 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100927
Darryl Green06fd18d2018-07-16 11:21:11 +0100928 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200929
930error:
931 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100932 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200933
934 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100935}
Darryl Green940d72c2018-07-13 13:18:51 +0100936
Ronald Cron5c522922020-11-14 16:35:34 +0100937/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200938 *
939 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200940 * available, as opposed to a key in a secure element and/or to be used
941 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200942 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200943 * This is a temporary function that may be used instead of
944 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
945 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200946 *
Ronald Cron5c522922020-11-14 16:35:34 +0100947 * On success, the returned key slot is locked. It is the responsibility of the
948 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200949 */
Ronald Cron5c522922020-11-14 16:35:34 +0100950static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
951 mbedtls_svc_key_id_t key,
952 psa_key_slot_t **p_slot,
953 psa_key_usage_t usage,
954 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955{
Ronald Cron5c522922020-11-14 16:35:34 +0100956 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
957 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200958 if( status != PSA_SUCCESS )
959 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200960
Ronald Cronddae0f52021-08-24 15:39:44 +0200961 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 {
Ronald Cron5c522922020-11-14 16:35:34 +0100963 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 *p_slot = NULL;
965 return( PSA_ERROR_NOT_SUPPORTED );
966 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 return( PSA_SUCCESS );
969}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200970
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200971psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000972{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100973 /* Data pointer will always be either a valid pointer or NULL in an
974 * initialized slot, so we can just free it. */
975 if( slot->key.data != NULL )
976 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
977
978 mbedtls_free( slot->key.data );
979 slot->key.data = NULL;
980 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000981
982 return( PSA_SUCCESS );
983}
984
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985/** Completely wipe a slot in memory, including its policy.
986 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100987psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100988{
989 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100990
TRodziewicz18cddc02021-07-13 12:19:15 +0200991 /*
992 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200993 * do our best to report an unexpected lock counter. Assert with
994 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
995 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
996 * function is called as part of the execution of a test suite, the
997 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200998 */
Ronald Cron5c522922020-11-14 16:35:34 +0100999 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001000 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001001 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001002 status = PSA_ERROR_CORRUPTION_DETECTED;
1003 }
1004
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001005 /* Multipart operations may still be using the key. This is safe
1006 * because all multipart operation objects are independent from
1007 * the key slot: if they need to access the key after the setup
1008 * phase, they have a copy of the key. Note that this means that
1009 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001010 /* At this point, key material and other type-specific content has
1011 * been wiped. Clear remaining metadata. We can call memset and not
1012 * zeroize because the metadata is not particularly sensitive. */
1013 memset( slot, 0, sizeof( *slot ) );
1014 return( status );
1015}
1016
Ronald Croncf56a0a2020-08-04 09:51:30 +02001017psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001018{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001019 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001020 psa_status_t status; /* status of the last operation */
1021 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023 psa_se_drv_table_entry_t *driver;
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025
Ronald Croncf56a0a2020-08-04 09:51:30 +02001026 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001027 return( PSA_SUCCESS );
1028
Ronald Cronf2911112020-10-29 17:51:10 +01001029 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001030 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001031 * key, this will load the key description from persistent memory if not
1032 * done yet. We cannot avoid this loading as without it we don't know if
1033 * the key is operated by an SE or not and this information is needed by
1034 * the current implementation.
1035 */
Ronald Cron5c522922020-11-14 16:35:34 +01001036 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001037 if( status != PSA_SUCCESS )
1038 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001039
Ronald Cronf2911112020-10-29 17:51:10 +01001040 /*
1041 * If the key slot containing the key description is under access by the
1042 * library (apart from the present access), the key cannot be destroyed
1043 * yet. For the time being, just return in error. Eventually (to be
1044 * implemented), the key should be destroyed when all accesses have
1045 * stopped.
1046 */
Ronald Cron5c522922020-11-14 16:35:34 +01001047 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001048 {
Ronald Cron5c522922020-11-14 16:35:34 +01001049 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001050 return( PSA_ERROR_GENERIC_ERROR );
1051 }
1052
Gilles Peskine6687cd02021-04-21 22:32:05 +02001053 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1054 {
1055 /* Refuse the destruction of a read-only key (which may or may not work
1056 * if we attempt it, depending on whether the key is merely read-only
1057 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001058 * Just do the best we can, which is to wipe the copy in memory
1059 * (done in this function's cleanup code). */
1060 overall_status = PSA_ERROR_NOT_PERMITTED;
1061 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001062 }
1063
Gilles Peskine354f7672019-07-12 23:46:38 +02001064#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001065 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001066 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001067 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001068 /* For a key in a secure element, we need to do three things:
1069 * remove the key file in internal storage, destroy the
1070 * key inside the secure element, and update the driver's
1071 * persistent data. Start a transaction that will encompass these
1072 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001073 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001074 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001075 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001077 status = psa_crypto_save_transaction( );
1078 if( status != PSA_SUCCESS )
1079 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001080 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001081 /* We should still try to destroy the key in the secure
1082 * element and the key metadata in storage. This is especially
1083 * important if the error is that the storage is full.
1084 * But how to do it exactly without risking an inconsistent
1085 * state after a reset?
1086 * https://github.com/ARMmbed/mbed-crypto/issues/215
1087 */
1088 overall_status = status;
1089 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001090 }
1091
Ronald Cronea0f8a62020-11-25 17:52:23 +01001092 status = psa_destroy_se_key( driver,
1093 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001094 if( overall_status == PSA_SUCCESS )
1095 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001096 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001097#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1098
Darryl Greend49a4992018-06-18 17:27:26 +01001099#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001100 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001101 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 status = psa_destroy_persistent_key( slot->attr.id );
1103 if( overall_status == PSA_SUCCESS )
1104 overall_status = status;
1105
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001106 /* TODO: other slots may have a copy of the same key. We should
1107 * invalidate them.
1108 * https://github.com/ARMmbed/mbed-crypto/issues/214
1109 */
Darryl Greend49a4992018-06-18 17:27:26 +01001110 }
1111#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001112
Gilles Peskinefc762652019-07-22 19:30:34 +02001113#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1114 if( driver != NULL )
1115 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001116 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001117 if( overall_status == PSA_SUCCESS )
1118 overall_status = status;
1119 status = psa_crypto_stop_transaction( );
1120 if( overall_status == PSA_SUCCESS )
1121 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001122 }
1123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1124
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001126 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001128 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 overall_status = status;
1130 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001131}
1132
John Durkop07cc04a2020-11-16 22:08:34 -08001133#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001134 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001135static psa_status_t psa_get_rsa_public_exponent(
1136 const mbedtls_rsa_context *rsa,
1137 psa_key_attributes_t *attributes )
1138{
1139 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001141 uint8_t *buffer = NULL;
1142 size_t buflen;
1143 mbedtls_mpi_init( &mpi );
1144
1145 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1146 if( ret != 0 )
1147 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001148 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1149 {
1150 /* It's the default value, which is reported as an empty string,
1151 * so there's nothing to do. */
1152 goto exit;
1153 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001154
1155 buflen = mbedtls_mpi_size( &mpi );
1156 buffer = mbedtls_calloc( 1, buflen );
1157 if( buffer == NULL )
1158 {
1159 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1160 goto exit;
1161 }
1162 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1163 if( ret != 0 )
1164 goto exit;
1165 attributes->domain_parameters = buffer;
1166 attributes->domain_parameters_size = buflen;
1167
1168exit:
1169 mbedtls_mpi_free( &mpi );
1170 if( ret != 0 )
1171 mbedtls_free( buffer );
1172 return( mbedtls_to_psa_error( ret ) );
1173}
John Durkop07cc04a2020-11-16 22:08:34 -08001174#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001175 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001176
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001177/** Retrieve all the publicly-accessible attributes of a key.
1178 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001179psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001180 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001181{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001183 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001184 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001185
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001186 psa_reset_key_attributes( attributes );
1187
Ronald Cron5c522922020-11-14 16:35:34 +01001188 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001189 if( status != PSA_SUCCESS )
1190 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001191
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001192 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001193 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1194 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1195
1196#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001197 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001198 psa_set_key_slot_number( attributes,
1199 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001200#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001201
Gilles Peskine8e338702019-07-30 20:06:31 +02001202 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001203 {
John Durkop07cc04a2020-11-16 22:08:34 -08001204#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001205 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001206 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001208 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001209 * is not yet implemented.
1210 * https://github.com/ARMmbed/mbed-crypto/issues/216
1211 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001212 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001213 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001214 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001215
Ronald Cron90857082020-11-25 14:58:33 +01001216 status = mbedtls_psa_rsa_load_representation(
1217 slot->attr.type,
1218 slot->key.data,
1219 slot->key.bytes,
1220 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001221 if( status != PSA_SUCCESS )
1222 break;
1223
Steven Cooremana2371e52020-07-28 14:30:39 +02001224 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001226 mbedtls_rsa_free( rsa );
1227 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001228 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001230#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001231 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001232 default:
1233 /* Nothing else to do. */
1234 break;
1235 }
1236
1237 if( status != PSA_SUCCESS )
1238 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001239
Ronald Cron5c522922020-11-14 16:35:34 +01001240 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001241
Ronald Cron5c522922020-11-14 16:35:34 +01001242 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001243}
1244
Gilles Peskinec8000c02019-08-02 20:15:51 +02001245#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1246psa_status_t psa_get_key_slot_number(
1247 const psa_key_attributes_t *attributes,
1248 psa_key_slot_number_t *slot_number )
1249{
1250 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1251 {
1252 *slot_number = attributes->slot_number;
1253 return( PSA_SUCCESS );
1254 }
1255 else
1256 return( PSA_ERROR_INVALID_ARGUMENT );
1257}
1258#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1259
Ronald Crond18b5f82020-11-25 16:46:05 +01001260static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1261 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001262 uint8_t *data,
1263 size_t data_size,
1264 size_t *data_length )
1265{
Ronald Crond18b5f82020-11-25 16:46:05 +01001266 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001267 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001268 memcpy( data, key_buffer, key_buffer_size );
1269 memset( data + key_buffer_size, 0,
1270 data_size - key_buffer_size );
1271 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001272 return( PSA_SUCCESS );
1273}
1274
Ronald Cron7285cda2020-11-26 14:46:37 +01001275psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001276 const psa_key_attributes_t *attributes,
1277 const uint8_t *key_buffer, size_t key_buffer_size,
1278 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001279{
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 psa_key_type_t type = attributes->core.type;
1281
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 if( key_type_is_raw_bytes( type ) ||
1283 PSA_KEY_TYPE_IS_RSA( type ) ||
1284 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001285 {
1286 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 key_buffer, key_buffer_size,
1288 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001289 }
1290 else
1291 {
1292 /* This shouldn't happen in the reference implementation, but
1293 it is valid for a special-purpose implementation to omit
1294 support for exporting certain key types. */
1295 return( PSA_ERROR_NOT_SUPPORTED );
1296 }
1297}
1298
1299psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1300 uint8_t *data,
1301 size_t data_size,
1302 size_t *data_length )
1303{
1304 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1305 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1306 psa_key_slot_t *slot;
1307
Ronald Crone907e552021-01-18 13:22:38 +01001308 /* Reject a zero-length output buffer now, since this can never be a
1309 * valid key representation. This way we know that data must be a valid
1310 * pointer and we can do things like memset(data, ..., data_size). */
1311 if( data_size == 0 )
1312 return( PSA_ERROR_BUFFER_TOO_SMALL );
1313
Ronald Cron9486f9d2020-11-26 13:36:23 +01001314 /* Set the key to empty now, so that even when there are errors, we always
1315 * set data_length to a value between 0 and data_size. On error, setting
1316 * the key to empty is a good choice because an empty key representation is
1317 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001318 *data_length = 0;
1319
Ronald Cron9486f9d2020-11-26 13:36:23 +01001320 /* Export requires the EXPORT flag. There is an exception for public keys,
1321 * which don't require any flag, but
1322 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1323 */
1324 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1325 PSA_KEY_USAGE_EXPORT, 0 );
1326 if( status != PSA_SUCCESS )
1327 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001328
Ronald Crond18b5f82020-11-25 16:46:05 +01001329 psa_key_attributes_t attributes = {
1330 .core = slot->attr
1331 };
Ronald Cron67227982020-11-26 15:16:05 +01001332 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001333 slot->key.data, slot->key.bytes,
1334 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001335
Ronald Cron9486f9d2020-11-26 13:36:23 +01001336 unlock_status = psa_unlock_key_slot( slot );
1337
1338 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1339}
1340
Ronald Cron7285cda2020-11-26 14:46:37 +01001341psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 const psa_key_attributes_t *attributes,
1343 const uint8_t *key_buffer,
1344 size_t key_buffer_size,
1345 uint8_t *data,
1346 size_t data_size,
1347 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001348{
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001350
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001352 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001354 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001355 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001356 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 key_buffer, key_buffer_size,
1358 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001359 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001360
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001362 {
John Durkop0e005192020-10-31 22:06:54 -07001363#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1364 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001365 return( mbedtls_psa_rsa_export_public_key( attributes,
1366 key_buffer,
1367 key_buffer_size,
1368 data,
1369 data_size,
1370 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001371#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001372 /* We don't know how to convert a private RSA key to public. */
1373 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001374#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1375 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001376 }
1377 else
Moran Pekera998bc62018-04-16 18:16:20 +03001378 {
John Durkop6ba40d12020-11-10 08:50:04 -08001379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1380 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001381 return( mbedtls_psa_ecp_export_public_key( attributes,
1382 key_buffer,
1383 key_buffer_size,
1384 data,
1385 data_size,
1386 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001387#else
1388 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001389 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001392 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001393 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001394 else
1395 {
1396 /* This shouldn't happen in the reference implementation, but
1397 it is valid for a special-purpose implementation to omit
1398 support for exporting certain key types. */
1399 return( PSA_ERROR_NOT_SUPPORTED );
1400 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001401}
Ronald Crond18b5f82020-11-25 16:46:05 +01001402
Ronald Croncf56a0a2020-08-04 09:51:30 +02001403psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001404 uint8_t *data,
1405 size_t data_size,
1406 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001407{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001409 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001410 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001411
Ronald Crone907e552021-01-18 13:22:38 +01001412 /* Reject a zero-length output buffer now, since this can never be a
1413 * valid key representation. This way we know that data must be a valid
1414 * pointer and we can do things like memset(data, ..., data_size). */
1415 if( data_size == 0 )
1416 return( PSA_ERROR_BUFFER_TOO_SMALL );
1417
Darryl Greendd8fb772018-11-07 16:00:44 +00001418 /* Set the key to empty now, so that even when there are errors, we always
1419 * set data_length to a value between 0 and data_size. On error, setting
1420 * the key to empty is a good choice because an empty key representation is
1421 * unlikely to be accepted anywhere. */
1422 *data_length = 0;
1423
1424 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001425 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001426 if( status != PSA_SUCCESS )
1427 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001428
Ronald Cron9486f9d2020-11-26 13:36:23 +01001429 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1430 {
1431 status = PSA_ERROR_INVALID_ARGUMENT;
1432 goto exit;
1433 }
1434
Ronald Crond18b5f82020-11-25 16:46:05 +01001435 psa_key_attributes_t attributes = {
1436 .core = slot->attr
1437 };
Ronald Cron67227982020-11-26 15:16:05 +01001438 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001439 &attributes, slot->key.data, slot->key.bytes,
1440 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001441
1442exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001443 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001444
Ronald Cron5c522922020-11-14 16:35:34 +01001445 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001446}
1447
Gilles Peskine91e8c332019-08-02 19:19:39 +02001448#if defined(static_assert)
1449static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1450 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001452 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001453static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001454 "One or more key attribute flag is listed as both internal-only and external-only" );
1455#endif
1456
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001457/** Validate that a key policy is internally well-formed.
1458 *
1459 * This function only rejects invalid policies. It does not validate the
1460 * consistency of the policy with respect to other attributes of the key
1461 * such as the key type.
1462 */
1463static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001464{
1465 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001466 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001467 PSA_KEY_USAGE_ENCRYPT |
1468 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001469 PSA_KEY_USAGE_SIGN_MESSAGE |
1470 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001471 PSA_KEY_USAGE_SIGN_HASH |
1472 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001473 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1475 return( PSA_ERROR_INVALID_ARGUMENT );
1476
Gilles Peskine4747d192019-04-17 15:05:45 +02001477 return( PSA_SUCCESS );
1478}
1479
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001480/** Validate the internal consistency of key attributes.
1481 *
1482 * This function only rejects invalid attribute values. If does not
1483 * validate the consistency of the attributes with any key data that may
1484 * be involved in the creation of the key.
1485 *
1486 * Call this function early in the key creation process.
1487 *
1488 * \param[in] attributes Key attributes for the new key.
1489 * \param[out] p_drv On any return, the driver for the key, if any.
1490 * NULL for a transparent key.
1491 *
1492 */
1493static psa_status_t psa_validate_key_attributes(
1494 const psa_key_attributes_t *attributes,
1495 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001496{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001497 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001498 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001499 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001500
Ronald Cron54b90082020-10-29 15:26:43 +01001501 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001502 if( status != PSA_SUCCESS )
1503 return( status );
1504
Ronald Crond2ed4812020-07-17 16:11:30 +02001505 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001506 if( status != PSA_SUCCESS )
1507 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001508
Ronald Cron65f38a32020-10-23 17:11:13 +02001509 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1510 {
1511 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1512 return( PSA_ERROR_INVALID_ARGUMENT );
1513 }
1514 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001515 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001516 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1517 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001518 }
1519
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001520 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001521 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001522 return( status );
1523
1524 /* Refuse to create overly large keys.
1525 * Note that this doesn't trigger on import if the attributes don't
1526 * explicitly specify a size (so psa_get_key_bits returns 0), so
1527 * psa_import_key() needs its own checks. */
1528 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1529 return( PSA_ERROR_NOT_SUPPORTED );
1530
Gilles Peskine91e8c332019-08-02 19:19:39 +02001531 /* Reject invalid flags. These should not be reachable through the API. */
1532 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1533 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1534 return( PSA_ERROR_INVALID_ARGUMENT );
1535
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536 return( PSA_SUCCESS );
1537}
1538
Gilles Peskine4747d192019-04-17 15:05:45 +02001539/** Prepare a key slot to receive key material.
1540 *
1541 * This function allocates a key slot and sets its metadata.
1542 *
1543 * If this function fails, call psa_fail_key_creation().
1544 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001545 * This function is intended to be used as follows:
1546 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001547 * it with the specified attributes, and in case of a volatile key assign it
1548 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001549 * -# Populate the slot with the key material.
1550 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1551 * In case of failure at any step, stop the sequence and call
1552 * psa_fail_key_creation().
1553 *
Ronald Cron5c522922020-11-14 16:35:34 +01001554 * On success, the key slot is locked. It is the responsibility of the caller
1555 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001556 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001557 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001558 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001559 * \param[out] p_slot On success, a pointer to the prepared slot.
1560 * \param[out] p_drv On any return, the driver for the key, if any.
1561 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001562 *
1563 * \retval #PSA_SUCCESS
1564 * The key slot is ready to receive key material.
1565 * \return If this function fails, the key slot is an invalid state.
1566 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001567 */
1568static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001569 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001570 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001571 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001572 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001573{
1574 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001575 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001576 psa_key_slot_t *slot;
1577
Gilles Peskinedf179142019-07-15 22:02:14 +02001578 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001579 *p_drv = NULL;
1580
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001581 status = psa_validate_key_attributes( attributes, p_drv );
1582 if( status != PSA_SUCCESS )
1583 return( status );
1584
Ronald Cronc4d1b512020-07-31 11:26:37 +02001585 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 if( status != PSA_SUCCESS )
1587 return( status );
1588 slot = *p_slot;
1589
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001590 /* We're storing the declared bit-size of the key. It's up to each
1591 * creation mechanism to verify that this information is correct.
1592 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001593 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001594 * is optional (import, copy). In case of a volatile key, assign it the
1595 * volatile key identifier associated to the slot returned to contain its
1596 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001597
1598 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001599 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1600 {
1601#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1602 slot->attr.id = volatile_key_id;
1603#else
1604 slot->attr.id.key_id = volatile_key_id;
1605#endif
1606 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001607
Gilles Peskine91e8c332019-08-02 19:19:39 +02001608 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001609 * external-only flags, query `attributes`. Thanks to the check
1610 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001611 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001612 * may have set. */
1613 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614
Gilles Peskinecbaff462019-07-12 23:46:04 +02001615#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001616 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001617 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001618 * create the key file in internal storage, create the
1619 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001620 * persistent data. This is done by starting a transaction that will
1621 * encompass these three actions.
1622 * For registering a volatile key, we just need to find an appropriate
1623 * slot number inside the SE. Since the key is designated volatile, creating
1624 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001625 /* The first thing to do is to find a slot number for the new key.
1626 * We save the slot number in persistent storage as part of the
1627 * transaction data. It will be needed to recover if the power
1628 * fails during the key creation process, to clean up on the secure
1629 * element side after restarting. Obtaining a slot number from the
1630 * secure element driver updates its persistent state, but we do not yet
1631 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001632 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001633 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001634 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001635 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001636 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001637 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001638 if( status != PSA_SUCCESS )
1639 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640
1641 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001642 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1644 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001645 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646 psa_crypto_transaction.key.id = slot->attr.id;
1647 status = psa_crypto_save_transaction( );
1648 if( status != PSA_SUCCESS )
1649 {
1650 (void) psa_crypto_stop_transaction( );
1651 return( status );
1652 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001653 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001654
1655 status = psa_copy_key_material_into_slot(
1656 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001657 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001658
1659 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1660 {
1661 /* Key registration only makes sense with a secure element. */
1662 return( PSA_ERROR_INVALID_ARGUMENT );
1663 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001664#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1665
Ronald Cronc4d1b512020-07-31 11:26:37 +02001666 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001667}
Gilles Peskine4747d192019-04-17 15:05:45 +02001668
1669/** Finalize the creation of a key once its key material has been set.
1670 *
1671 * This entails writing the key to persistent storage.
1672 *
1673 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001674 * See the documentation of psa_start_key_creation() for the intended use
1675 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001676 *
Ronald Cron5c522922020-11-14 16:35:34 +01001677 * If the finalization succeeds, the function unlocks the key slot (it was
1678 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1679 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001680 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001681 * \param[in,out] slot Pointer to the slot with key material.
1682 * \param[in] driver The secure element driver for the key,
1683 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001684 * \param[out] key On success, identifier of the key. Note that the
1685 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001686 *
1687 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001688 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001689 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1690 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1691 * \retval #PSA_ERROR_ALREADY_EXISTS
1692 * \retval #PSA_ERROR_DATA_INVALID
1693 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001694 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001695 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001696 * \return If this function fails, the key slot is an invalid state.
1697 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001698 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001699static psa_status_t psa_finish_key_creation(
1700 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001701 psa_se_drv_table_entry_t *driver,
1702 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001703{
1704 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001705 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001706 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001707
1708#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001709 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001710 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001711#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1712 if( driver != NULL )
1713 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 psa_key_slot_number_t slot_number =
1716 psa_key_slot_get_slot_number( slot ) ;
1717
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001719 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720 sizeof( data.slot_number ),
1721 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001722#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001723 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001724 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725 (uint8_t*) &data,
1726 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727 }
1728 else
1729#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1730 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001731 /* Key material is saved in export representation in the slot, so
1732 * just pass the slot buffer for storage. */
1733 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001734 slot->key.data,
1735 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001736 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001737 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001738#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1739
Gilles Peskinecbaff462019-07-12 23:46:04 +02001740#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001741 /* Finish the transaction for a key creation. This does not
1742 * happen when registering an existing key. Detect this case
1743 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001744 * creation of a persistent key in a secure element requires a transaction,
1745 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001746 if( driver != NULL &&
1747 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001748 {
1749 status = psa_save_se_persistent_data( driver );
1750 if( status != PSA_SUCCESS )
1751 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001752 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001753 return( status );
1754 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001755 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001756 }
1757#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1758
Ronald Cron50972942020-11-14 11:28:25 +01001759 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001760 {
1761 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001762 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001763 if( status != PSA_SUCCESS )
1764 *key = MBEDTLS_SVC_KEY_ID_INIT;
1765 }
Ronald Cron50972942020-11-14 11:28:25 +01001766
Gilles Peskine4747d192019-04-17 15:05:45 +02001767 return( status );
1768}
1769
1770/** Abort the creation of a key.
1771 *
1772 * You may call this function after calling psa_start_key_creation(),
1773 * or after psa_finish_key_creation() fails. In other circumstances, this
1774 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001775 * See the documentation of psa_start_key_creation() for the intended use
1776 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001778 * \param[in,out] slot Pointer to the slot with key material.
1779 * \param[in] driver The secure element driver for the key,
1780 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001782static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001783 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001784{
Gilles Peskine011e4282019-06-26 18:34:38 +02001785 (void) driver;
1786
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 if( slot == NULL )
1788 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001789
1790#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001791 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 * element, and the failure happened later (when saving metadata
1793 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001794 * element.
1795 * https://github.com/ARMmbed/mbed-crypto/issues/217
1796 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001797
Gilles Peskined7729582019-08-05 15:55:54 +02001798 /* Abort the ongoing transaction if any (there may not be one if
1799 * the creation process failed before starting one, or if the
1800 * key creation is a registration of a key in a secure element).
1801 * Earlier functions must already have done what it takes to undo any
1802 * partial creation. All that's left is to update the transaction data
1803 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001804 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001805#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1806
Gilles Peskine4747d192019-04-17 15:05:45 +02001807 psa_wipe_key_slot( slot );
1808}
1809
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001810/** Validate optional attributes during key creation.
1811 *
1812 * Some key attributes are optional during key creation. If they are
1813 * specified in the attributes structure, check that they are consistent
1814 * with the data in the slot.
1815 *
1816 * This function should be called near the end of key creation, after
1817 * the slot in memory is fully populated but before saving persistent data.
1818 */
1819static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001820 const psa_key_slot_t *slot,
1821 const psa_key_attributes_t *attributes )
1822{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001823 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001824 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001825 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 return( PSA_ERROR_INVALID_ARGUMENT );
1827 }
1828
1829 if( attributes->domain_parameters_size != 0 )
1830 {
John Durkop0e005192020-10-31 22:06:54 -07001831#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1832 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001833 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001834 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001835 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001836 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001838
Ronald Cron90857082020-11-25 14:58:33 +01001839 psa_status_t status = mbedtls_psa_rsa_load_representation(
1840 slot->attr.type,
1841 slot->key.data,
1842 slot->key.bytes,
1843 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001844 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001845 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001846
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001847 mbedtls_mpi_init( &actual );
1848 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001849 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001851 mbedtls_rsa_free( rsa );
1852 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001853 if( ret != 0 )
1854 goto rsa_exit;
1855 ret = mbedtls_mpi_read_binary( &required,
1856 attributes->domain_parameters,
1857 attributes->domain_parameters_size );
1858 if( ret != 0 )
1859 goto rsa_exit;
1860 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1861 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1862 rsa_exit:
1863 mbedtls_mpi_free( &actual );
1864 mbedtls_mpi_free( &required );
1865 if( ret != 0)
1866 return( mbedtls_to_psa_error( ret ) );
1867 }
1868 else
John Durkop9814fa22020-11-04 12:28:15 -08001869#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1870 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 {
1872 return( PSA_ERROR_INVALID_ARGUMENT );
1873 }
1874 }
1875
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001876 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001878 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001879 return( PSA_ERROR_INVALID_ARGUMENT );
1880 }
1881
1882 return( PSA_SUCCESS );
1883}
1884
Gilles Peskine4747d192019-04-17 15:05:45 +02001885psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001886 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001887 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001888 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001889{
1890 psa_status_t status;
1891 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001892 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001893 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301894 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895
Ronald Cron81709fc2020-11-14 12:10:32 +01001896 *key = MBEDTLS_SVC_KEY_ID_INIT;
1897
Gilles Peskine0f84d622019-09-12 19:03:13 +02001898 /* Reject zero-length symmetric keys (including raw data key objects).
1899 * This also rejects any key which might be encoded as an empty string,
1900 * which is never valid. */
1901 if( data_length == 0 )
1902 return( PSA_ERROR_INVALID_ARGUMENT );
1903
Archana449608b2021-09-08 15:36:05 +05301904 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301905 if( data_length > SIZE_MAX / 8 )
1906 return( PSA_ERROR_NOT_SUPPORTED );
1907
Gilles Peskinedf179142019-07-15 22:02:14 +02001908 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001909 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 if( status != PSA_SUCCESS )
1911 goto exit;
1912
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001913 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301914 * storage ( thus not in the case of importing a key in a secure element
1915 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1916 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001917 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001918 {
Archanad8a83dc2021-06-14 10:04:16 +05301919 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1920 {
Archana449608b2021-09-08 15:36:05 +05301921 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1922 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301923 if( status != PSA_SUCCESS )
1924 goto exit;
1925 }
1926 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001927 if( status != PSA_SUCCESS )
1928 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001929 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001930
1931 bits = slot->attr.bits;
1932 status = psa_driver_wrapper_import_key( attributes,
1933 data, data_length,
1934 slot->key.data,
1935 slot->key.bytes,
1936 &slot->key.bytes, &bits );
1937 if( status != PSA_SUCCESS )
1938 goto exit;
1939
1940 if( slot->attr.bits == 0 )
1941 slot->attr.bits = (psa_key_bits_t) bits;
1942 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001943 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001944 status = PSA_ERROR_INVALID_ARGUMENT;
1945 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001946 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001947
Archana6ed4bda2021-08-04 10:47:15 +05301948 /* Enforce a size limit, and in particular ensure that the bit
1949 * size fits in its representation type.*/
1950 if( bits > PSA_MAX_KEY_BITS )
1951 {
1952 status = PSA_ERROR_NOT_SUPPORTED;
1953 goto exit;
1954 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001955 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001956 if( status != PSA_SUCCESS )
1957 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958
Ronald Cron81709fc2020-11-14 12:10:32 +01001959 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001960exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001962 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001963
Gilles Peskine4747d192019-04-17 15:05:45 +02001964 return( status );
1965}
1966
Gilles Peskined7729582019-08-05 15:55:54 +02001967#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1968psa_status_t mbedtls_psa_register_se_key(
1969 const psa_key_attributes_t *attributes )
1970{
1971 psa_status_t status;
1972 psa_key_slot_t *slot = NULL;
1973 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001974 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001975
1976 /* Leaving attributes unspecified is not currently supported.
1977 * It could make sense to query the key type and size from the
1978 * secure element, but not all secure elements support this
1979 * and the driver HAL doesn't currently support it. */
1980 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1981 return( PSA_ERROR_NOT_SUPPORTED );
1982 if( psa_get_key_bits( attributes ) == 0 )
1983 return( PSA_ERROR_NOT_SUPPORTED );
1984
1985 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001986 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001987 if( status != PSA_SUCCESS )
1988 goto exit;
1989
Ronald Cron81709fc2020-11-14 12:10:32 +01001990 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001991
1992exit:
1993 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001994 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001995
Gilles Peskined7729582019-08-05 15:55:54 +02001996 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001997 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001998 return( status );
1999}
2000#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2001
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002003 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002004 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002005{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002006 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002007 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002008 psa_key_slot_t *source_slot = NULL;
2009 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002010 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002011 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302012 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002013
Ronald Cron81709fc2020-11-14 12:10:32 +01002014 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2015
Archana8a180362021-07-05 02:18:48 +05302016 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002017 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002018 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002019 goto exit;
2020
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002021 status = psa_validate_optional_attributes( source_slot,
2022 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 if( status != PSA_SUCCESS )
2024 goto exit;
2025
Archana9d17bf42021-09-10 06:22:44 +05302026 /* The target key type and number of bits have been validated by
2027 * psa_validate_optional_attributes() to be either equal to zero or
2028 * equal to the ones of the source key. So it is safe to inherit
2029 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302030 * */
Archana9d17bf42021-09-10 06:22:44 +05302031 actual_attributes.core.bits = source_slot->attr.bits;
2032 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302033
2034
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002035 status = psa_restrict_key_policy( source_slot->attr.type,
2036 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002037 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002038 if( status != PSA_SUCCESS )
2039 goto exit;
2040
Ronald Cron81709fc2020-11-14 12:10:32 +01002041 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2042 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002043 if( status != PSA_SUCCESS )
2044 goto exit;
Archana8a180362021-07-05 02:18:48 +05302045 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2046 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002047 {
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 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002064 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2065 {
Archana8a180362021-07-05 02:18:48 +05302066 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302067 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302068 if( status != PSA_SUCCESS )
2069 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302070
Archana8a180362021-07-05 02:18:48 +05302071 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2072 if( status != PSA_SUCCESS )
2073 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302074
Archana8a180362021-07-05 02:18:48 +05302075 status = psa_driver_wrapper_copy_key( &actual_attributes,
2076 source_slot->key.data,
2077 source_slot->key.bytes,
2078 target_slot->key.data,
2079 target_slot->key.bytes,
2080 &target_slot->key.bytes );
2081 if( status != PSA_SUCCESS )
2082 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002083 }
Archana8a180362021-07-05 02:18:48 +05302084 else
2085 {
Archana9d17bf42021-09-10 06:22:44 +05302086 status = psa_copy_key_material_into_slot( target_slot,
2087 source_slot->key.data,
2088 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302089 if( status != PSA_SUCCESS )
2090 goto exit;
2091 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002092 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002093exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002095 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002096
Ronald Cron5c522922020-11-14 16:35:34 +01002097 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002098
Ronald Cron5c522922020-11-14 16:35:34 +01002099 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002100}
2101
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002102
2103
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002104/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002105/* Message digests */
2106/****************************************************************/
2107
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002108psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2109{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002110 /* Aborting a non-active operation is allowed */
2111 if( operation->id == 0 )
2112 return( PSA_SUCCESS );
2113
2114 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2115 operation->id = 0;
2116
2117 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002118}
2119
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002120psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002121 psa_algorithm_t alg )
2122{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002123 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002124
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002125 /* A context must be freshly initialized before it can be set up. */
2126 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002127 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002128 status = PSA_ERROR_BAD_STATE;
2129 goto exit;
2130 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002131
2132 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002133 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002134 status = PSA_ERROR_INVALID_ARGUMENT;
2135 goto exit;
2136 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002137
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002138 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2139 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002140 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2141
Dave Rodgman685b6a72021-06-24 11:49:14 +01002142 status = psa_driver_wrapper_hash_setup( operation, alg );
2143
2144exit:
2145 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002146 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002147
2148 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002149}
2150
2151psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2152 const uint8_t *input,
2153 size_t input_length )
2154{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2156
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002158 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002159 status = PSA_ERROR_BAD_STATE;
2160 goto exit;
2161 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002162
Steven Cooremanc8288352021-03-04 14:02:19 +01002163 /* Don't require hash implementations to behave correctly on a
2164 * zero-length input, which may have an invalid pointer. */
2165 if( input_length == 0 )
2166 return( PSA_SUCCESS );
2167
Dave Rodgman685b6a72021-06-24 11:49:14 +01002168 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2169
2170exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002171 if( status != PSA_SUCCESS )
2172 psa_hash_abort( operation );
2173
2174 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002175}
2176
2177psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2178 uint8_t *hash,
2179 size_t hash_size,
2180 size_t *hash_length )
2181{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002182 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002183 if( operation->id == 0 )
2184 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002185
Steven Cooreman1e582352021-02-18 17:24:37 +01002186 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002187 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002188 psa_hash_abort( operation );
2189 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002190}
2191
Gilles Peskine2d277862018-06-18 15:41:12 +02002192psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2193 const uint8_t *hash,
2194 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195{
Ronald Cron69a63422021-10-18 09:47:58 +02002196 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002198 psa_status_t status = psa_hash_finish(
2199 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002200 actual_hash, sizeof( actual_hash ),
2201 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002202
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002204 goto exit;
2205
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002206 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002207 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002208 status = PSA_ERROR_INVALID_SIGNATURE;
2209 goto exit;
2210 }
2211
Steven Cooreman36876a02021-04-29 16:37:59 +02002212 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002213 status = PSA_ERROR_INVALID_SIGNATURE;
2214
2215exit:
Gilles Peskine60aebec2021-12-13 12:33:18 +01002216 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002217 if( status != PSA_SUCCESS )
2218 psa_hash_abort(operation);
2219
2220 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221}
2222
Gilles Peskine0a749c82019-11-28 19:33:58 +01002223psa_status_t psa_hash_compute( psa_algorithm_t alg,
2224 const uint8_t *input, size_t input_length,
2225 uint8_t *hash, size_t hash_size,
2226 size_t *hash_length )
2227{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002228 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002229 if( !PSA_ALG_IS_HASH( alg ) )
2230 return( PSA_ERROR_INVALID_ARGUMENT );
2231
Steven Cooreman1e582352021-02-18 17:24:37 +01002232 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2233 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002234}
2235
2236psa_status_t psa_hash_compare( psa_algorithm_t alg,
2237 const uint8_t *input, size_t input_length,
2238 const uint8_t *hash, size_t hash_length )
2239{
Ronald Cron69a63422021-10-18 09:47:58 +02002240 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002241 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002242
2243 if( !PSA_ALG_IS_HASH( alg ) )
2244 return( PSA_ERROR_INVALID_ARGUMENT );
2245
Steven Cooreman1e582352021-02-18 17:24:37 +01002246 psa_status_t status = psa_driver_wrapper_hash_compute(
2247 alg, input, input_length,
2248 actual_hash, sizeof(actual_hash),
2249 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002250 if( status != PSA_SUCCESS )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002251 goto exit;
Steven Cooreman84d670d2021-02-18 16:22:53 +01002252 if( actual_hash_length != hash_length )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002253 {
2254 status = PSA_ERROR_INVALID_SIGNATURE;
2255 goto exit;
2256 }
Steven Cooreman36876a02021-04-29 16:37:59 +02002257 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002258 status = PSA_ERROR_INVALID_SIGNATURE;
2259
2260exit:
2261 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
2262 return( status );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002263}
2264
Gilles Peskineeb35d782019-01-22 17:56:16 +01002265psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2266 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002267{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002268 if( source_operation->id == 0 ||
2269 target_operation->id != 0 )
2270 {
2271 return( PSA_ERROR_BAD_STATE );
2272 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002273
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002274 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2275 target_operation );
2276 if( status != PSA_SUCCESS )
2277 psa_hash_abort( target_operation );
2278
2279 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002280}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002281
2282
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002284/* MAC */
2285/****************************************************************/
2286
Steven Cooremane6804192021-03-19 18:28:56 +01002287psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002288{
Steven Cooremane6804192021-03-19 18:28:56 +01002289 /* Aborting a non-active operation is allowed */
2290 if( operation->id == 0 )
2291 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002292
Steven Cooremane6804192021-03-19 18:28:56 +01002293 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002294 operation->mac_size = 0;
2295 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002296 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002297
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002298 return( status );
2299}
2300
Ronald Cron2dff3b22021-06-17 16:33:22 +02002301static psa_status_t psa_mac_finalize_alg_and_key_validation(
2302 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002303 const psa_key_attributes_t *attributes,
2304 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002305{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002306 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002307 psa_key_type_t key_type = psa_get_key_type( attributes );
2308 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002309
Ronald Cron28ea0502021-06-17 16:10:24 +02002310 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002311 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002312
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002313 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002314 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002315 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002316 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002317
Steven Cooremand1a68f12021-05-10 11:13:41 +02002318 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002319 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002320
Ronald Cron79bdd822021-06-17 16:46:44 +02002321 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002322 {
2323 /* A very short MAC is too short for security since it can be
2324 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2325 * so we make this our minimum, even though 32 bits is still
2326 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002327 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002328 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002329
Ronald Cron79bdd822021-06-17 16:46:44 +02002330 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2331 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002332 {
2333 /* It's impossible to "truncate" to a larger length than the full length
2334 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002335 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002336 }
2337
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002338 if( *mac_size > PSA_MAC_MAX_SIZE )
2339 {
2340 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2341 * that is disabled in the compile-time configuration. The result can
2342 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2343 * configuration into account. In this case, force a return of
2344 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2345 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2346 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2347 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2348 * systematically generated tests. */
2349 return( PSA_ERROR_NOT_SUPPORTED );
2350 }
2351
Ronald Cron79bdd822021-06-17 16:46:44 +02002352 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002353}
2354
Gilles Peskinee59236f2018-01-27 23:32:46 +01002355static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2356 mbedtls_svc_key_id_t key,
2357 psa_algorithm_t alg,
2358 int is_sign )
2359{
2360 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2361 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002362 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002363
2364 /* A context must be freshly initialized before it can be set up. */
2365 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002366 {
Dave Rodgman54648242021-06-24 11:49:45 +01002367 status = PSA_ERROR_BAD_STATE;
2368 goto exit;
2369 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002370
2371 status = psa_get_and_lock_key_slot_with_policy(
2372 key,
2373 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002374 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002375 alg );
2376 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002377 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002378
2379 psa_key_attributes_t attributes = {
2380 .core = slot->attr
2381 };
2382
Ronald Cron79bdd822021-06-17 16:46:44 +02002383 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2384 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002385 if( status != PSA_SUCCESS )
2386 goto exit;
2387
2388 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002389 /* Dispatch the MAC setup call with validated input */
2390 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002391 {
Steven Cooremane6804192021-03-19 18:28:56 +01002392 status = psa_driver_wrapper_mac_sign_setup( operation,
2393 &attributes,
2394 slot->key.data,
2395 slot->key.bytes,
2396 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002397 }
2398 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002399 {
Steven Cooremane6804192021-03-19 18:28:56 +01002400 status = psa_driver_wrapper_mac_verify_setup( operation,
2401 &attributes,
2402 slot->key.data,
2403 slot->key.bytes,
2404 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002405 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002406
Gilles Peskinefbfac682018-07-08 20:51:54 +02002407exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002408 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002409 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002410
Ronald Cron5c522922020-11-14 16:35:34 +01002411 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002412
Ronald Cron5c522922020-11-14 16:35:34 +01002413 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414}
2415
Gilles Peskine89167cb2018-07-08 20:12:23 +02002416psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002417 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002418 psa_algorithm_t alg )
2419{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002420 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002421}
2422
2423psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002424 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002425 psa_algorithm_t alg )
2426{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002427 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002428}
2429
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002430psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431 const uint8_t *input,
2432 size_t input_length )
2433{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002434 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002435 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002436
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002437 /* Don't require hash implementations to behave correctly on a
2438 * zero-length input, which may have an invalid pointer. */
2439 if( input_length == 0 )
2440 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002441
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002442 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2443 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002444 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002445 psa_mac_abort( operation );
2446
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002447 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002448}
2449
Steven Cooremana5b860a2021-03-19 19:04:39 +01002450psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002451 uint8_t *mac,
2452 size_t mac_size,
2453 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002454{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2456 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002457
Steven Cooremana5b860a2021-03-19 19:04:39 +01002458 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002459 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002460 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002461 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002462 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002463
Steven Cooreman72f736a2021-05-07 14:14:37 +02002464 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002465 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002466 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002467 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002468 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002469
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002470 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2471 * once all the error checks are done. */
2472 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002473 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002474 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002475 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002476 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002477
2478 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002479 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002480 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002481 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002482 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002483
Steven Cooremana5b860a2021-03-19 19:04:39 +01002484 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002485 mac, operation->mac_size,
2486 mac_length );
2487
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002488exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002489 /* In case of success, set the potential excess room in the output buffer
2490 * to an invalid value, to avoid potentially leaking a longer MAC.
2491 * In case of error, set the output length and content to a safe default,
2492 * such that in case the caller misses an error check, the output would be
2493 * an unachievable MAC.
2494 */
2495 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002496 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002497 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002498 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002499 }
mohammad16036df908f2018-04-02 08:34:15 -07002500
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002501 if( mac_size > operation->mac_size )
2502 memset( &mac[operation->mac_size], '!',
2503 mac_size - operation->mac_size );
2504
Steven Cooremana5b860a2021-03-19 19:04:39 +01002505 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002506
Steven Cooremana5b860a2021-03-19 19:04:39 +01002507 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002508}
2509
Steven Cooremana5b860a2021-03-19 19:04:39 +01002510psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002511 const uint8_t *mac,
2512 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002513{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002514 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2515 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002516
Steven Cooremana5b860a2021-03-19 19:04:39 +01002517 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002518 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002519 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002520 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002521 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002522
Steven Cooreman72f736a2021-05-07 14:14:37 +02002523 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002524 {
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 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002528
2529 if( operation->mac_size != mac_length )
2530 {
2531 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002532 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002533 }
2534
Steven Cooremana5b860a2021-03-19 19:04:39 +01002535 status = psa_driver_wrapper_mac_verify_finish( operation,
2536 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002537
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002538exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002539 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002540
Steven Cooremana5b860a2021-03-19 19:04:39 +01002541 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002542}
2543
Ronald Croncd989b52021-06-18 14:23:33 +02002544static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2545 psa_algorithm_t alg,
2546 const uint8_t *input,
2547 size_t input_length,
2548 uint8_t *mac,
2549 size_t mac_size,
2550 size_t *mac_length,
2551 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002552{
2553 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002554 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2555 psa_key_slot_t *slot;
2556 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002557
Ronald Cron51131b52021-06-17 17:17:20 +02002558 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002559 key,
2560 &slot,
2561 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002562 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002563 if( status != PSA_SUCCESS )
2564 goto exit;
2565
Ronald Cron51131b52021-06-17 17:17:20 +02002566 psa_key_attributes_t attributes = {
2567 .core = slot->attr
2568 };
2569
2570 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2571 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002572 if( status != PSA_SUCCESS )
2573 goto exit;
2574
Ronald Cron51131b52021-06-17 17:17:20 +02002575 if( mac_size < operation_mac_size )
2576 {
2577 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002578 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002579 }
2580
2581 status = psa_driver_wrapper_mac_compute(
2582 &attributes,
2583 slot->key.data, slot->key.bytes,
2584 alg,
2585 input, input_length,
2586 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002587
2588exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002589 /* In case of success, set the potential excess room in the output buffer
2590 * to an invalid value, to avoid potentially leaking a longer MAC.
2591 * In case of error, set the output length and content to a safe default,
2592 * such that in case the caller misses an error check, the output would be
2593 * an unachievable MAC.
2594 */
2595 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002596 {
Ronald Cron51131b52021-06-17 17:17:20 +02002597 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002598 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002599 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002600 if( mac_size > operation_mac_size )
2601 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602
Ronald Cron51131b52021-06-17 17:17:20 +02002603 unlock_status = psa_unlock_key_slot( slot );
2604
2605 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002606}
2607
Ronald Croncd989b52021-06-18 14:23:33 +02002608psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2609 psa_algorithm_t alg,
2610 const uint8_t *input,
2611 size_t input_length,
2612 uint8_t *mac,
2613 size_t mac_size,
2614 size_t *mac_length)
2615{
2616 return( psa_mac_compute_internal( key, alg,
2617 input, input_length,
2618 mac, mac_size, mac_length, 1 ) );
2619}
2620
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002621psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2622 psa_algorithm_t alg,
2623 const uint8_t *input,
2624 size_t input_length,
2625 const uint8_t *mac,
2626 size_t mac_length)
2627{
2628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002629 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2630 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002631
Ronald Crona587cbc2021-06-18 14:51:29 +02002632 status = psa_mac_compute_internal( key, alg,
2633 input, input_length,
2634 actual_mac, sizeof( actual_mac ),
2635 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002636 if( status != PSA_SUCCESS )
2637 goto exit;
2638
Ronald Crona587cbc2021-06-18 14:51:29 +02002639 if( mac_length != actual_mac_length )
2640 {
2641 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002642 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002643 }
2644 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2645 {
2646 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002647 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002648 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002649
2650exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002651 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002652
2653 return ( status );
2654}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002655
Gilles Peskinee59236f2018-01-27 23:32:46 +01002656/****************************************************************/
2657/* Asymmetric cryptography */
2658/****************************************************************/
2659
gabor-mezei-armf0486182021-05-12 11:03:09 +02002660static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002661 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002662{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002663 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002664 {
2665 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2666 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002667
Gilles Peskinef7b41372021-09-22 16:15:05 +02002668 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002669 {
2670 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2671 return( PSA_ERROR_INVALID_ARGUMENT );
2672 }
2673 }
2674 else
2675 {
Mateusz Starzyke6d3eda2021-08-26 11:46:14 +02002676 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002677 return( PSA_ERROR_INVALID_ARGUMENT );
2678 }
2679
2680 return( PSA_SUCCESS );
2681}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002682
2683static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002684 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002685 psa_algorithm_t alg,
2686 const uint8_t * input,
2687 size_t input_length,
2688 uint8_t * signature,
2689 size_t signature_size,
2690 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002691{
2692 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2693 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2694 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002695
2696 *signature_length = 0;
2697
gabor-mezei-armf0486182021-05-12 11:03:09 +02002698 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002699 if( status != PSA_SUCCESS )
2700 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002701
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002702 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002703 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002704 * buffer can in principle be empty since it doesn't actually have
2705 * to be a hash.) */
2706 if( signature_size == 0 )
2707 return( PSA_ERROR_BUFFER_TOO_SMALL );
2708
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002709 status = psa_get_and_lock_key_slot_with_policy(
2710 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002711 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2712 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002713 alg );
2714
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002715 if( status != PSA_SUCCESS )
2716 goto exit;
2717
2718 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2719 {
2720 status = PSA_ERROR_INVALID_ARGUMENT;
2721 goto exit;
2722 }
2723
2724 psa_key_attributes_t attributes = {
2725 .core = slot->attr
2726 };
2727
gabor-mezei-armf0486182021-05-12 11:03:09 +02002728 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002729 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002730 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002731 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002732 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002733 signature, signature_size, signature_length );
2734 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002735 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002736 {
2737
2738 status = psa_driver_wrapper_sign_hash(
2739 &attributes, slot->key.data, slot->key.bytes,
2740 alg, input, input_length,
2741 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002742 }
2743
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002744
2745exit:
2746 /* Fill the unused part of the output buffer (the whole buffer on error,
2747 * the trailing part on success) with something that isn't a valid signature
2748 * (barring an attack on the signature and deliberately-crafted input),
2749 * in case the caller doesn't check the return status properly. */
2750 if( status == PSA_SUCCESS )
2751 memset( signature + *signature_length, '!',
2752 signature_size - *signature_length );
2753 else
2754 memset( signature, '!', signature_size );
2755 /* If signature_size is 0 then we have nothing to do. We must not call
2756 * memset because signature may be NULL in this case. */
2757
2758 unlock_status = psa_unlock_key_slot( slot );
2759
2760 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2761}
2762
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002764 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002765 psa_algorithm_t alg,
2766 const uint8_t * input,
2767 size_t input_length,
2768 const uint8_t * signature,
2769 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002770{
2771 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2772 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2773 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002774
gabor-mezei-armf0486182021-05-12 11:03:09 +02002775 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002776 if( status != PSA_SUCCESS )
2777 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002778
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002779 status = psa_get_and_lock_key_slot_with_policy(
2780 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002781 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2782 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002783 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002784
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002785 if( status != PSA_SUCCESS )
2786 return( status );
2787
2788 psa_key_attributes_t attributes = {
2789 .core = slot->attr
2790 };
2791
gabor-mezei-armf0486182021-05-12 11:03:09 +02002792 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002793 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002794 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002795 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002796 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002797 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002798 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002799 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002800 {
2801 status = psa_driver_wrapper_verify_hash(
2802 &attributes, slot->key.data, slot->key.bytes,
2803 alg, input, input_length,
2804 signature, signature_length );
2805 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002806
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002807 unlock_status = psa_unlock_key_slot( slot );
2808
2809 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002810
2811}
2812
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002813psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002814 const psa_key_attributes_t *attributes,
2815 const uint8_t *key_buffer,
2816 size_t key_buffer_size,
2817 psa_algorithm_t alg,
2818 const uint8_t *input,
2819 size_t input_length,
2820 uint8_t *signature,
2821 size_t signature_size,
2822 size_t *signature_length )
2823{
2824 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825
Gilles Peskinef7b41372021-09-22 16:15:05 +02002826 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002827 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002828 size_t hash_length;
2829 uint8_t hash[PSA_HASH_MAX_SIZE];
2830
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002831 status = psa_driver_wrapper_hash_compute(
2832 PSA_ALG_SIGN_GET_HASH( alg ),
2833 input, input_length,
2834 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002835
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002836 if( status != PSA_SUCCESS )
2837 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002838
2839 return psa_driver_wrapper_sign_hash(
2840 attributes, key_buffer, key_buffer_size,
2841 alg, hash, hash_length,
2842 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002843 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002844
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002845 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002846}
2847
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002848psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2849 psa_algorithm_t alg,
2850 const uint8_t * input,
2851 size_t input_length,
2852 uint8_t * signature,
2853 size_t signature_size,
2854 size_t * signature_length )
2855{
2856 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002857 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002858 signature, signature_size, signature_length );
2859}
2860
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002861psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002862 const psa_key_attributes_t *attributes,
2863 const uint8_t *key_buffer,
2864 size_t key_buffer_size,
2865 psa_algorithm_t alg,
2866 const uint8_t *input,
2867 size_t input_length,
2868 const uint8_t *signature,
2869 size_t signature_length )
2870{
2871 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002872
Gilles Peskinef7b41372021-09-22 16:15:05 +02002873 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002874 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002875 size_t hash_length;
2876 uint8_t hash[PSA_HASH_MAX_SIZE];
2877
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002878 status = psa_driver_wrapper_hash_compute(
2879 PSA_ALG_SIGN_GET_HASH( alg ),
2880 input, input_length,
2881 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002882
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002883 if( status != PSA_SUCCESS )
2884 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002885
2886 return psa_driver_wrapper_verify_hash(
2887 attributes, key_buffer, key_buffer_size,
2888 alg, hash, hash_length,
2889 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002890 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002891
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002892 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002893}
2894
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002895psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2896 psa_algorithm_t alg,
2897 const uint8_t * input,
2898 size_t input_length,
2899 const uint8_t * signature,
2900 size_t signature_length )
2901{
2902 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002903 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002904 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002905}
2906
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002907psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002908 const psa_key_attributes_t *attributes,
2909 const uint8_t *key_buffer, size_t key_buffer_size,
2910 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2911 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002912{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002913 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002914 {
Ronald Cron4501c982021-03-19 20:09:32 +01002915 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2916 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002917 {
Ronald Cron4501c982021-03-19 20:09:32 +01002918#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2919 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2920 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002921 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) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002927 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002928 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002929 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002930 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002931 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002932 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002933 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Ronald Cron4501c982021-03-19 20:09:32 +01002934 {
2935 if( PSA_ALG_IS_ECDSA( alg ) )
2936 {
2937#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2938 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2939 return( mbedtls_psa_ecdsa_sign_hash(
2940 attributes,
2941 key_buffer, key_buffer_size,
2942 alg, hash, hash_length,
2943 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002944#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2945 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002946 }
2947 else
2948 {
2949 return( PSA_ERROR_INVALID_ARGUMENT );
2950 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002951 }
Ronald Cron4501c982021-03-19 20:09:32 +01002952
2953 (void)key_buffer;
2954 (void)key_buffer_size;
2955 (void)hash;
2956 (void)hash_length;
2957 (void)signature;
2958 (void)signature_size;
2959 (void)signature_length;
2960
2961 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002962}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002963
2964psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2965 psa_algorithm_t alg,
2966 const uint8_t *hash,
2967 size_t hash_length,
2968 uint8_t *signature,
2969 size_t signature_size,
2970 size_t *signature_length )
2971{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002972 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002973 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002974 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002975}
2976
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002977psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002978 const psa_key_attributes_t *attributes,
2979 const uint8_t *key_buffer, size_t key_buffer_size,
2980 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2981 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002982{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002983 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002984 {
Ronald Cron4501c982021-03-19 20:09:32 +01002985 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2986 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002987 {
Ronald Cron4501c982021-03-19 20:09:32 +01002988#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2989 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2990 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002991 attributes,
2992 key_buffer, key_buffer_size,
2993 alg, hash, hash_length,
2994 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002995#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2996 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002997 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002998 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002999 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003000 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003001 }
itayzafrir5c753392018-05-08 11:18:38 +03003002 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02003003 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003004 {
Ronald Cron4501c982021-03-19 20:09:32 +01003005 if( PSA_ALG_IS_ECDSA( alg ) )
3006 {
3007#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3008 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3009 return( mbedtls_psa_ecdsa_verify_hash(
3010 attributes,
3011 key_buffer, key_buffer_size,
3012 alg, hash, hash_length,
3013 signature, signature_length ) );
3014#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3015 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3016 }
3017 else
3018 {
3019 return( PSA_ERROR_INVALID_ARGUMENT );
3020 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003021 }
Ronald Cron4501c982021-03-19 20:09:32 +01003022
3023 (void)key_buffer;
3024 (void)key_buffer_size;
3025 (void)hash;
3026 (void)hash_length;
3027 (void)signature;
3028 (void)signature_length;
3029
3030 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003031}
3032
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003033psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3034 psa_algorithm_t alg,
3035 const uint8_t *hash,
3036 size_t hash_length,
3037 const uint8_t *signature,
3038 size_t signature_length )
3039{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003041 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003042 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003043}
3044
Ronald Croncf56a0a2020-08-04 09:51:30 +02003045psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003046 psa_algorithm_t alg,
3047 const uint8_t *input,
3048 size_t input_length,
3049 const uint8_t *salt,
3050 size_t salt_length,
3051 uint8_t *output,
3052 size_t output_size,
3053 size_t *output_length )
3054{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003055 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003056 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003057 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003058
Darryl Green5cc689a2018-07-24 15:34:10 +01003059 (void) input;
3060 (void) input_length;
3061 (void) salt;
3062 (void) output;
3063 (void) output_size;
3064
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003065 *output_length = 0;
3066
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003067 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3068 return( PSA_ERROR_INVALID_ARGUMENT );
3069
Ronald Cron5c522922020-11-14 16:35:34 +01003070 status = psa_get_and_lock_transparent_key_slot_with_policy(
3071 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003072 if( status != PSA_SUCCESS )
3073 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003074 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3075 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003076 {
3077 status = PSA_ERROR_INVALID_ARGUMENT;
3078 goto exit;
3079 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003080
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003081 psa_key_attributes_t attributes = {
3082 .core = slot->attr
3083 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003084
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003085 status = psa_driver_wrapper_asymmetric_encrypt(
3086 &attributes, slot->key.data, slot->key.bytes,
3087 alg, input, input_length, salt, salt_length,
3088 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003089exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003090 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003091
Ronald Cron5c522922020-11-14 16:35:34 +01003092 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003093}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003094
Ronald Croncf56a0a2020-08-04 09:51:30 +02003095psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003096 psa_algorithm_t alg,
3097 const uint8_t *input,
3098 size_t input_length,
3099 const uint8_t *salt,
3100 size_t salt_length,
3101 uint8_t *output,
3102 size_t output_size,
3103 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003105 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003106 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003107 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003108
Darryl Green5cc689a2018-07-24 15:34:10 +01003109 (void) input;
3110 (void) input_length;
3111 (void) salt;
3112 (void) output;
3113 (void) output_size;
3114
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003115 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003116
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003117 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3118 return( PSA_ERROR_INVALID_ARGUMENT );
3119
Ronald Cron5c522922020-11-14 16:35:34 +01003120 status = psa_get_and_lock_transparent_key_slot_with_policy(
3121 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003122 if( status != PSA_SUCCESS )
3123 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003124 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003125 {
3126 status = PSA_ERROR_INVALID_ARGUMENT;
3127 goto exit;
3128 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003129
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003130 psa_key_attributes_t attributes = {
3131 .core = slot->attr
3132 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003134 status = psa_driver_wrapper_asymmetric_decrypt(
3135 &attributes, slot->key.data, slot->key.bytes,
3136 alg, input, input_length, salt, salt_length,
3137 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003138
3139exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003140 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003141
Ronald Cron5c522922020-11-14 16:35:34 +01003142 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003143}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003144
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003145
3146
mohammad1603503973b2018-03-12 15:59:30 +02003147/****************************************************************/
3148/* Symmetric cryptography */
3149/****************************************************************/
3150
Ronald Cronab99ac22020-10-01 16:38:28 +02003151static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3152 mbedtls_svc_key_id_t key,
3153 psa_algorithm_t alg,
3154 mbedtls_operation_t cipher_operation )
3155{
3156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3157 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003158 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003159 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3160 PSA_KEY_USAGE_ENCRYPT :
3161 PSA_KEY_USAGE_DECRYPT );
3162
3163 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003164 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003165 {
Dave Rodgman54648242021-06-24 11:49:45 +01003166 status = PSA_ERROR_BAD_STATE;
3167 goto exit;
3168 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003169
Ronald Cronab99ac22020-10-01 16:38:28 +02003170 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003171 {
Dave Rodgman54648242021-06-24 11:49:45 +01003172 status = PSA_ERROR_INVALID_ARGUMENT;
3173 goto exit;
3174 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003175
Ronald Cronab99ac22020-10-01 16:38:28 +02003176 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3177 if( status != PSA_SUCCESS )
3178 goto exit;
3179
Ronald Cron49fafa92021-03-10 08:34:23 +01003180 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003181 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003182 * so we only set it (in the driver wrapper) after resources have been
3183 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003184 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003185 if( alg == PSA_ALG_ECB_NO_PADDING )
3186 operation->iv_required = 0;
3187 else
3188 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003189 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003190
Ronald Crona4af55f2020-12-14 14:36:06 +01003191 psa_key_attributes_t attributes = {
3192 .core = slot->attr
3193 };
3194
Ronald Cronab99ac22020-10-01 16:38:28 +02003195 /* Try doing the operation through a driver before using software fallback. */
3196 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003197 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3198 &attributes,
3199 slot->key.data,
3200 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003201 alg );
3202 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003203 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3204 &attributes,
3205 slot->key.data,
3206 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003207 alg );
3208
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003209exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003210 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003211 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003212
Ronald Cron5c522922020-11-14 16:35:34 +01003213 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003214
Ronald Cron5c522922020-11-14 16:35:34 +01003215 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003216}
3217
Gilles Peskinefe119512018-07-08 21:39:34 +02003218psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003219 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003220 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003221{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003222 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003223}
3224
Gilles Peskinefe119512018-07-08 21:39:34 +02003225psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003226 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003227 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003228{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003229 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003230}
3231
Gilles Peskinefe119512018-07-08 21:39:34 +02003232psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003233 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003234 size_t iv_size,
3235 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003236{
Ronald Cron6d051732020-10-01 14:10:20 +02003237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003238 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3239 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01003240
Ronald Cron49fafa92021-03-10 08:34:23 +01003241 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003242 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003243 status = PSA_ERROR_BAD_STATE;
3244 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003245 }
3246
Steven Cooreman7df02922020-09-09 15:28:49 +02003247 if( operation->iv_set || ! operation->iv_required )
3248 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003249 status = PSA_ERROR_BAD_STATE;
3250 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003251 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003252
Ronald Cron2fb90522021-07-05 12:31:44 +02003253 default_iv_length = operation->default_iv_length;
3254 if( iv_size < default_iv_length )
Ronald Cron5618a392021-03-26 09:52:26 +01003255 {
3256 status = PSA_ERROR_BUFFER_TOO_SMALL;
3257 goto exit;
3258 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003259
Ronald Cron2fb90522021-07-05 12:31:44 +02003260 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
3261 {
3262 status = PSA_ERROR_GENERIC_ERROR;
3263 goto exit;
3264 }
3265
3266 status = psa_generate_random( local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003267 if( status != PSA_SUCCESS )
3268 goto exit;
3269
3270 status = psa_driver_wrapper_cipher_set_iv( operation,
Ronald Cron2fb90522021-07-05 12:31:44 +02003271 local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003272
3273exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003274 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003275 {
Ronald Cron2fb90522021-07-05 12:31:44 +02003276 memcpy( iv, local_iv, default_iv_length );
3277 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003278 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003279 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003280 else
Ronald Cron2fb90522021-07-05 12:31:44 +02003281 {
3282 *iv_length = 0;
Moran Peker395db872018-05-31 14:07:14 +03003283 psa_cipher_abort( operation );
Ronald Cron2fb90522021-07-05 12:31:44 +02003284 }
Ronald Cron6d051732020-10-01 14:10:20 +02003285
itayzafrir534bd7c2018-08-02 13:56:32 +03003286 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003287}
3288
Gilles Peskinefe119512018-07-08 21:39:34 +02003289psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003290 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003291 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003292{
Ronald Cron6d051732020-10-01 14:10:20 +02003293 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003294
Ronald Cron49fafa92021-03-10 08:34:23 +01003295 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003296 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003297 status = PSA_ERROR_BAD_STATE;
3298 goto exit;
3299 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003300
Steven Cooreman7df02922020-09-09 15:28:49 +02003301 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003302 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003303 status = PSA_ERROR_BAD_STATE;
3304 goto exit;
3305 }
Ronald Crona0d68172021-03-26 10:15:08 +01003306
3307 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003308 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003309 status = PSA_ERROR_INVALID_ARGUMENT;
3310 goto exit;
3311 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003312
Ronald Crondd24c9b2020-12-15 14:10:01 +01003313 status = psa_driver_wrapper_cipher_set_iv( operation,
3314 iv,
3315 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003316
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003317exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003318 if( status == PSA_SUCCESS )
3319 operation->iv_set = 1;
3320 else
mohammad1603503973b2018-03-12 15:59:30 +02003321 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003322 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003323}
3324
Gilles Peskinee553c652018-06-04 16:22:46 +02003325psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3326 const uint8_t *input,
3327 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003328 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003329 size_t output_size,
3330 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003331{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003333
Ronald Cron49fafa92021-03-10 08:34:23 +01003334 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003335 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003336 status = PSA_ERROR_BAD_STATE;
3337 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003338 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003339
Steven Cooreman7df02922020-09-09 15:28:49 +02003340 if( operation->iv_required && ! operation->iv_set )
3341 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003342 status = PSA_ERROR_BAD_STATE;
3343 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003344 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003345
Ronald Crondd24c9b2020-12-15 14:10:01 +01003346 status = psa_driver_wrapper_cipher_update( operation,
3347 input,
3348 input_length,
3349 output,
3350 output_size,
3351 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003352
3353exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003354 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003355 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003356
itayzafrir534bd7c2018-08-02 13:56:32 +03003357 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003358}
3359
Gilles Peskinee553c652018-06-04 16:22:46 +02003360psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3361 uint8_t *output,
3362 size_t output_size,
3363 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003364{
David Saadab4ecc272019-02-14 13:48:10 +02003365 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003366
Ronald Cron49fafa92021-03-10 08:34:23 +01003367 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003368 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003369 status = PSA_ERROR_BAD_STATE;
3370 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003371 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003372
Steven Cooreman7df02922020-09-09 15:28:49 +02003373 if( operation->iv_required && ! operation->iv_set )
3374 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003375 status = PSA_ERROR_BAD_STATE;
3376 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003377 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003378
Ronald Crondd24c9b2020-12-15 14:10:01 +01003379 status = psa_driver_wrapper_cipher_finish( operation,
3380 output,
3381 output_size,
3382 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003383
3384exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003385 if( status == PSA_SUCCESS )
3386 return( psa_cipher_abort( operation ) );
3387 else
3388 {
3389 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003390 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003391
Steven Cooremanef8575e2020-09-11 11:44:50 +02003392 return( status );
3393 }
mohammad1603503973b2018-03-12 15:59:30 +02003394}
3395
Gilles Peskinee553c652018-06-04 16:22:46 +02003396psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3397{
Ronald Cron49fafa92021-03-10 08:34:23 +01003398 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003399 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003400 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003401 * in use. It's ok to call abort on such an object, and there's
3402 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003403 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003404 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003405
Ronald Crondd24c9b2020-12-15 14:10:01 +01003406 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003407
Ronald Cron49fafa92021-03-10 08:34:23 +01003408 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003409 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003410 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003411
Moran Peker395db872018-05-31 14:07:14 +03003412 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003413}
3414
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003415psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3416 psa_algorithm_t alg,
3417 const uint8_t *input,
3418 size_t input_length,
3419 uint8_t *output,
3420 size_t output_size,
3421 size_t *output_length )
3422{
3423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003424 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003425 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02003426 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3427 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003428
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003429 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003430 {
3431 status = PSA_ERROR_INVALID_ARGUMENT;
3432 goto exit;
3433 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003434
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003435 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3436 PSA_KEY_USAGE_ENCRYPT,
3437 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003438 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003439 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003440
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003441 psa_key_attributes_t attributes = {
3442 .core = slot->attr
3443 };
3444
Ronald Cronc6e6f502021-07-09 18:44:58 +02003445 default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
3446 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003447 {
Ronald Cronc6e6f502021-07-09 18:44:58 +02003448 status = PSA_ERROR_GENERIC_ERROR;
3449 goto exit;
3450 }
3451
3452 if( default_iv_length > 0 )
3453 {
3454 if( output_size < default_iv_length )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003455 {
3456 status = PSA_ERROR_BUFFER_TOO_SMALL;
3457 goto exit;
3458 }
3459
Ronald Cronc6e6f502021-07-09 18:44:58 +02003460 status = psa_generate_random( local_iv, default_iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003461 if( status != PSA_SUCCESS )
3462 goto exit;
3463 }
3464
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003465 status = psa_driver_wrapper_cipher_encrypt(
3466 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02003467 alg, local_iv, default_iv_length, input, input_length,
3468 output + default_iv_length, output_size - default_iv_length,
3469 output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003470
3471exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003472 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003473 if( status == PSA_SUCCESS )
3474 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003475
Ronald Cron9b674282021-07-09 09:19:35 +02003476 if( status == PSA_SUCCESS )
Ronald Cronc6e6f502021-07-09 18:44:58 +02003477 {
3478 if( default_iv_length > 0 )
3479 memcpy( output, local_iv, default_iv_length );
3480 *output_length += default_iv_length;
3481 }
Ronald Cron9b674282021-07-09 09:19:35 +02003482 else
Ronald Cron23919522021-07-08 19:00:07 +02003483 *output_length = 0;
3484
3485 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003486}
3487
3488psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3489 psa_algorithm_t alg,
3490 const uint8_t *input,
3491 size_t input_length,
3492 uint8_t *output,
3493 size_t output_size,
3494 size_t *output_length )
3495{
3496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003497 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003498 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003499
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003500 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003501 {
3502 status = PSA_ERROR_INVALID_ARGUMENT;
3503 goto exit;
3504 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003505
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003506 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3507 PSA_KEY_USAGE_DECRYPT,
3508 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003509 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003510 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003511
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003512 psa_key_attributes_t attributes = {
3513 .core = slot->attr
3514 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003515
Mateusz Starzyk594215b2021-10-14 12:23:06 +02003516 if( alg == PSA_ALG_CCM_STAR_NO_TAG && input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) )
3517 {
3518 status = PSA_ERROR_INVALID_ARGUMENT;
3519 goto exit;
3520 }
3521 else if ( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003522 {
3523 status = PSA_ERROR_INVALID_ARGUMENT;
3524 goto exit;
3525 }
3526
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003527 status = psa_driver_wrapper_cipher_decrypt(
3528 &attributes, slot->key.data, slot->key.bytes,
3529 alg, input, input_length,
3530 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003531
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003532exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003533 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003534 if( status == PSA_SUCCESS )
3535 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003536
Ronald Cron23919522021-07-08 19:00:07 +02003537 if( status != PSA_SUCCESS )
3538 *output_length = 0;
3539
3540 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003541}
3542
3543
mohammad16035955c982018-04-26 00:53:03 +03003544/****************************************************************/
3545/* AEAD */
3546/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003547
Paul Elliottbaff51c2021-09-28 17:44:45 +01003548/* Helper function to get the base algorithm from its variants. */
3549static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3550{
3551 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3552}
3553
3554/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003555static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3556 size_t nonce_length )
3557{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003558 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3559
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003560 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003561 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003562#if defined(PSA_WANT_ALG_GCM)
3563 case PSA_ALG_GCM:
3564 /* Not checking max nonce size here as GCM spec allows almost
3565 * arbitrarily large nonces. Please note that we do not generally
3566 * recommend the usage of nonces of greater length than
3567 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3568 * size, which can then lead to collisions if you encrypt a very
3569 * large number of messages.*/
3570 if( nonce_length != 0 )
3571 return( PSA_SUCCESS );
3572 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003573#endif /* PSA_WANT_ALG_GCM */
3574#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003575 case PSA_ALG_CCM:
3576 if( nonce_length >= 7 && nonce_length <= 13 )
3577 return( PSA_SUCCESS );
3578 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003579#endif /* PSA_WANT_ALG_CCM */
3580#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003581 case PSA_ALG_CHACHA20_POLY1305:
3582 if( nonce_length == 12 )
3583 return( PSA_SUCCESS );
Bence Szépkúti6d48e202021-11-15 20:04:15 +01003584 else if( nonce_length == 8 )
3585 return( PSA_ERROR_NOT_SUPPORTED );
3586 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003587#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003588 default:
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003589 return( PSA_ERROR_NOT_SUPPORTED );
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003590 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003591
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003592 return( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003593}
3594
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01003595static psa_status_t psa_aead_check_algorithm( psa_algorithm_t alg )
3596{
Bence Szépkúti08f34652021-12-08 21:07:13 +01003597 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3598 return( PSA_ERROR_INVALID_ARGUMENT );
3599
3600 return( PSA_SUCCESS );
3601}
3602
Ronald Croncf56a0a2020-08-04 09:51:30 +02003603psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003604 psa_algorithm_t alg,
3605 const uint8_t *nonce,
3606 size_t nonce_length,
3607 const uint8_t *additional_data,
3608 size_t additional_data_length,
3609 const uint8_t *plaintext,
3610 size_t plaintext_length,
3611 uint8_t *ciphertext,
3612 size_t ciphertext_size,
3613 size_t *ciphertext_length )
3614{
Ronald Cron215633c2021-03-16 17:15:37 +01003615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3616 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003617
mohammad1603f08a5502018-06-03 15:05:47 +03003618 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003619
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003620 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003621 if( status != PSA_SUCCESS )
3622 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003623
Ronald Cron9a986162021-03-26 12:40:07 +01003624 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003625 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003626 if( status != PSA_SUCCESS )
3627 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003628
Ronald Cron215633c2021-03-16 17:15:37 +01003629 psa_key_attributes_t attributes = {
3630 .core = slot->attr
3631 };
mohammad16035955c982018-04-26 00:53:03 +03003632
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003633 status = psa_aead_check_nonce_length( alg, nonce_length );
3634 if( status != PSA_SUCCESS )
3635 goto exit;
3636
Ronald Cronde822812021-03-17 16:08:20 +01003637 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003638 &attributes, slot->key.data, slot->key.bytes,
3639 alg,
3640 nonce, nonce_length,
3641 additional_data, additional_data_length,
3642 plaintext, plaintext_length,
3643 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003644
Gilles Peskineedf9a652018-08-17 18:11:56 +02003645 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3646 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003647
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003648exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003649 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003650
mohammad16035955c982018-04-26 00:53:03 +03003651 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003652}
3653
Ronald Croncf56a0a2020-08-04 09:51:30 +02003654psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003655 psa_algorithm_t alg,
3656 const uint8_t *nonce,
3657 size_t nonce_length,
3658 const uint8_t *additional_data,
3659 size_t additional_data_length,
3660 const uint8_t *ciphertext,
3661 size_t ciphertext_length,
3662 uint8_t *plaintext,
3663 size_t plaintext_size,
3664 size_t *plaintext_length )
3665{
Ronald Cron215633c2021-03-16 17:15:37 +01003666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3667 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003668
Gilles Peskineee652a32018-06-01 19:23:52 +02003669 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003670
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003671 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003672 if( status != PSA_SUCCESS )
3673 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003674
Ronald Cron9a986162021-03-26 12:40:07 +01003675 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003676 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003677 if( status != PSA_SUCCESS )
3678 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003679
Ronald Cron215633c2021-03-16 17:15:37 +01003680 psa_key_attributes_t attributes = {
3681 .core = slot->attr
3682 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003683
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003684 status = psa_aead_check_nonce_length( alg, nonce_length );
3685 if( status != PSA_SUCCESS )
3686 goto exit;
3687
Ronald Cronde822812021-03-17 16:08:20 +01003688 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003689 &attributes, slot->key.data, slot->key.bytes,
3690 alg,
3691 nonce, nonce_length,
3692 additional_data, additional_data_length,
3693 ciphertext, ciphertext_length,
3694 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003695
Gilles Peskineedf9a652018-08-17 18:11:56 +02003696 if( status != PSA_SUCCESS && plaintext_size != 0 )
3697 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003698
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003699exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003700 psa_unlock_key_slot( slot );
3701
Gilles Peskineedf9a652018-08-17 18:11:56 +02003702 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003703}
3704
Andrzej Kurekf8816012021-12-19 17:00:12 +01003705static psa_status_t psa_validate_tag_length( psa_aead_operation_t *operation,
3706 psa_algorithm_t alg ) {
3707 uint8_t tag_len = 0;
3708 if( psa_driver_get_tag_len( operation, &tag_len ) != PSA_SUCCESS )
3709 {
3710 return( PSA_ERROR_INVALID_ARGUMENT );
3711 }
3712
3713 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
3714 {
3715#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
3716 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
3717 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
3718 if( tag_len < 4 || tag_len > 16 || tag_len % 2 )
3719 return( PSA_ERROR_INVALID_ARGUMENT );
3720 break;
3721#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3722
3723#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
3724 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
3725 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
3726 if( tag_len != 4 && tag_len != 8 && ( tag_len < 12 || tag_len > 16 ) )
3727 return( PSA_ERROR_INVALID_ARGUMENT );
3728 break;
3729#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3730
3731#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
3732 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
3733 /* We only support the default tag length. */
3734 if( tag_len != 16 )
3735 return( PSA_ERROR_INVALID_ARGUMENT );
3736 break;
3737#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
3738
3739 default:
3740 (void) tag_len;
3741 return( PSA_ERROR_NOT_SUPPORTED );
3742 }
3743 return( PSA_SUCCESS );
3744}
3745
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003746/* Set the key for a multipart authenticated operation. */
3747static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003748 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003749 mbedtls_svc_key_id_t key,
3750 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003751{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3753 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3754 psa_key_slot_t *slot = NULL;
3755 psa_key_usage_t key_usage = 0;
3756
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003757 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003758 if( status != PSA_SUCCESS )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003759 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003760
3761 if( operation->id != 0 )
3762 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003763 status = PSA_ERROR_BAD_STATE;
3764 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003765 }
3766
3767 if( operation->nonce_set || operation->lengths_set ||
3768 operation->ad_started || operation->body_started )
3769 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003770 status = PSA_ERROR_BAD_STATE;
3771 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003772 }
3773
Paul Elliottd9343f22021-08-23 18:59:49 +01003774 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003775 key_usage = PSA_KEY_USAGE_ENCRYPT;
3776 else
3777 key_usage = PSA_KEY_USAGE_DECRYPT;
3778
3779 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3780 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003781 if( status != PSA_SUCCESS )
3782 goto exit;
3783
3784 psa_key_attributes_t attributes = {
3785 .core = slot->attr
3786 };
3787
Paul Elliottd9343f22021-08-23 18:59:49 +01003788 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003789 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3790 &attributes,
3791 slot->key.data,
3792 slot->key.bytes,
3793 alg );
3794 else
3795 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3796 &attributes,
3797 slot->key.data,
3798 slot->key.bytes,
3799 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003800 if( status != PSA_SUCCESS )
3801 goto exit;
3802
Andrzej Kurekf8816012021-12-19 17:00:12 +01003803 if( ( status = psa_validate_tag_length( operation, alg ) ) != PSA_SUCCESS )
3804 goto exit;
3805
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003806 operation->key_type = psa_get_key_type( &attributes );
3807
3808exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003809 unlock_status = psa_unlock_key_slot( slot );
3810
3811 if( status == PSA_SUCCESS )
3812 {
3813 status = unlock_status;
3814 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003815 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003816 }
3817 else
3818 psa_aead_abort( operation );
3819
3820 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003821}
3822
Paul Elliott302ff6b2021-04-20 18:10:30 +01003823/* Set the key for a multipart authenticated encryption operation. */
3824psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3825 mbedtls_svc_key_id_t key,
3826 psa_algorithm_t alg )
3827{
Paul Elliottd9343f22021-08-23 18:59:49 +01003828 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003829}
3830
3831/* Set the key for a multipart authenticated decryption operation. */
3832psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3833 mbedtls_svc_key_id_t key,
3834 psa_algorithm_t alg )
3835{
Paul Elliottd9343f22021-08-23 18:59:49 +01003836 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003837}
3838
3839/* Generate a random nonce / IV for multipart AEAD operation */
3840psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3841 uint8_t *nonce,
3842 size_t nonce_size,
3843 size_t *nonce_length )
3844{
3845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01003846 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01003847 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003848
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003849 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003850
Paul Elliottcee785c2021-05-20 14:29:20 +01003851 if( operation->id == 0 )
3852 {
3853 status = PSA_ERROR_BAD_STATE;
3854 goto exit;
3855 }
3856
Paul Elliottdaf5c892021-08-25 16:24:58 +01003857 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003858 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003859 status = PSA_ERROR_BAD_STATE;
3860 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003861 }
3862
Paul Elliotte193ea82021-10-01 13:00:16 +01003863 /* For CCM, this size may not be correct according to the PSA
3864 * specification. The PSA Crypto 1.0.1 specification states:
3865 *
3866 * CCM encodes the plaintext length pLen in L octets, with L the smallest
3867 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
3868 *
3869 * However this restriction that L has to be the smallest integer is not
3870 * applied in practice, and it is not implementable here since the
3871 * plaintext length may or may not be known at this time. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01003872 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003873 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003874 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003875 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003876 status = PSA_ERROR_BUFFER_TOO_SMALL;
3877 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003878 }
3879
Ronald Croncae59092021-11-26 18:53:58 +01003880 status = psa_generate_random( local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003881 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003882 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003883
Ronald Croncae59092021-11-26 18:53:58 +01003884 status = psa_aead_set_nonce( operation, local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003885
Paul Elliott39dc6b82021-05-11 19:16:09 +01003886exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003887 if( status == PSA_SUCCESS )
Ronald Croncae59092021-11-26 18:53:58 +01003888 {
3889 memcpy( nonce, local_nonce, required_nonce_size );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003890 *nonce_length = required_nonce_size;
Ronald Croncae59092021-11-26 18:53:58 +01003891 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003892 else
3893 psa_aead_abort( operation );
3894
3895 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003896}
3897
3898/* Set the nonce for a multipart authenticated encryption or decryption
3899 operation.*/
3900psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3901 const uint8_t *nonce,
3902 size_t nonce_length )
3903{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3905
Paul Elliottcee785c2021-05-20 14:29:20 +01003906 if( operation->id == 0 )
3907 {
3908 status = PSA_ERROR_BAD_STATE;
3909 goto exit;
3910 }
3911
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003912 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003913 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003914 status = PSA_ERROR_BAD_STATE;
3915 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003916 }
3917
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003918 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003919 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003920 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003921 status = PSA_ERROR_INVALID_ARGUMENT;
3922 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003923 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01003924
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003925 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3926 nonce_length );
3927
Paul Elliott39dc6b82021-05-11 19:16:09 +01003928exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003929 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003930 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003931 else
3932 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003933
3934 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003935}
3936
3937/* Declare the lengths of the message and additional data for multipart AEAD. */
3938psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3939 size_t ad_length,
3940 size_t plaintext_length )
3941{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003942 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3943
Paul Elliottcee785c2021-05-20 14:29:20 +01003944 if( operation->id == 0 )
3945 {
3946 status = PSA_ERROR_BAD_STATE;
3947 goto exit;
3948 }
3949
Paul Elliott6eb95982021-05-21 17:41:41 +01003950 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003951 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003952 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003953 status = PSA_ERROR_BAD_STATE;
3954 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003955 }
3956
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003957 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01003958 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003959#if defined(PSA_WANT_ALG_GCM)
3960 case PSA_ALG_GCM:
3961 /* Lengths can only be too large for GCM if size_t is bigger than 32
3962 * bits. Without the guard this code will generate warnings on 32bit
3963 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01003964#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003965 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3966 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3967 {
3968 status = PSA_ERROR_INVALID_ARGUMENT;
3969 goto exit;
3970 }
Paul Elliott325d3742021-09-27 17:56:28 +01003971#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003972 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003973#endif /* PSA_WANT_ALG_GCM */
3974#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003975 case PSA_ALG_CCM:
3976 if( ad_length > 0xFF00 )
3977 {
3978 status = PSA_ERROR_INVALID_ARGUMENT;
3979 goto exit;
3980 }
3981 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003982#endif /* PSA_WANT_ALG_CCM */
3983#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003984 case PSA_ALG_CHACHA20_POLY1305:
3985 /* No length restrictions for ChaChaPoly. */
3986 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003987#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003988 default:
3989 break;
3990 }
Paul Elliott325d3742021-09-27 17:56:28 +01003991
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003992 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3993 plaintext_length );
3994
Paul Elliott39dc6b82021-05-11 19:16:09 +01003995exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003996 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003997 {
3998 operation->ad_remaining = ad_length;
3999 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004000 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01004001 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004002 else
4003 psa_aead_abort( operation );
4004
4005 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004006}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004007
4008/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01004009psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
4010 const uint8_t *input,
4011 size_t input_length )
4012{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004013 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4014
Paul Elliottcee785c2021-05-20 14:29:20 +01004015 if( operation->id == 0 )
4016 {
4017 status = PSA_ERROR_BAD_STATE;
4018 goto exit;
4019 }
4020
Paul Elliott6eb95982021-05-21 17:41:41 +01004021 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004022 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004023 status = PSA_ERROR_BAD_STATE;
4024 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004025 }
4026
Paul Elliottee4ffe02021-05-20 17:25:06 +01004027 if( operation->lengths_set )
4028 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004029 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004030 {
4031 status = PSA_ERROR_INVALID_ARGUMENT;
4032 goto exit;
4033 }
4034
4035 operation->ad_remaining -= input_length;
4036 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004037#if defined(PSA_WANT_ALG_CCM)
4038 else if( operation->alg == PSA_ALG_CCM )
4039 {
4040 status = PSA_ERROR_BAD_STATE;
4041 goto exit;
4042 }
4043#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004044
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004045 status = psa_driver_wrapper_aead_update_ad( operation, input,
4046 input_length );
4047
Paul Elliott39dc6b82021-05-11 19:16:09 +01004048exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004049 if( status == PSA_SUCCESS )
4050 operation->ad_started = 1;
4051 else
4052 psa_aead_abort( operation );
4053
4054 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004055}
4056
4057/* Encrypt or decrypt a message fragment in an active multipart AEAD
4058 operation.*/
4059psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4060 const uint8_t *input,
4061 size_t input_length,
4062 uint8_t *output,
4063 size_t output_size,
4064 size_t *output_length )
4065{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004066 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004067
4068 *output_length = 0;
4069
Paul Elliottcee785c2021-05-20 14:29:20 +01004070 if( operation->id == 0 )
4071 {
4072 status = PSA_ERROR_BAD_STATE;
4073 goto exit;
4074 }
4075
Paul Elliott6eb95982021-05-21 17:41:41 +01004076 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004077 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004078 status = PSA_ERROR_BAD_STATE;
4079 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004080 }
4081
Paul Elliottee4ffe02021-05-20 17:25:06 +01004082 if( operation->lengths_set )
4083 {
4084 /* Additional data length was supplied, but not all the additional
4085 data was supplied.*/
4086 if( operation->ad_remaining != 0 )
4087 {
4088 status = PSA_ERROR_INVALID_ARGUMENT;
4089 goto exit;
4090 }
4091
4092 /* Too much data provided. */
4093 if( operation->body_remaining < input_length )
4094 {
4095 status = PSA_ERROR_INVALID_ARGUMENT;
4096 goto exit;
4097 }
4098
4099 operation->body_remaining -= input_length;
4100 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004101#if defined(PSA_WANT_ALG_CCM)
4102 else if( operation->alg == PSA_ALG_CCM )
4103 {
4104 status = PSA_ERROR_BAD_STATE;
4105 goto exit;
4106 }
4107#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004108
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004109 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4110 output, output_size,
4111 output_length );
4112
Paul Elliott39dc6b82021-05-11 19:16:09 +01004113exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004114 if( status == PSA_SUCCESS )
4115 operation->body_started = 1;
4116 else
4117 psa_aead_abort( operation );
4118
4119 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004120}
4121
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004122static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004123{
Paul Elliott7f429b72021-06-24 18:08:54 +01004124 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004125 return( PSA_ERROR_BAD_STATE );
4126
Paul Elliotta5614442021-07-14 14:54:11 +01004127 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004128 operation->body_remaining != 0 ) )
4129 return( PSA_ERROR_INVALID_ARGUMENT );
4130
4131 return( PSA_SUCCESS );
4132}
4133
Paul Elliott302ff6b2021-04-20 18:10:30 +01004134/* Finish encrypting a message in a multipart AEAD operation. */
4135psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4136 uint8_t *ciphertext,
4137 size_t ciphertext_size,
4138 size_t *ciphertext_length,
4139 uint8_t *tag,
4140 size_t tag_size,
4141 size_t *tag_length )
4142{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004143 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4144
Paul Elliott302ff6b2021-04-20 18:10:30 +01004145 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004146 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004147
Paul Elliott814fffb2021-08-16 18:20:36 +01004148 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004149 if( status != PSA_SUCCESS )
4150 goto exit;
4151
Paul Elliott7f429b72021-06-24 18:08:54 +01004152 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004153 {
4154 status = PSA_ERROR_BAD_STATE;
4155 goto exit;
4156 }
4157
Paul Elliott39dc6b82021-05-11 19:16:09 +01004158 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4159 ciphertext_size,
4160 ciphertext_length,
4161 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004162
Paul Elliott39dc6b82021-05-11 19:16:09 +01004163exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004164 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004165 * the zero tag size, make sure the tag is set to something implausible.
4166 * Even if the operation succeeds, make sure we clear the rest of the
4167 * buffer to prevent potential leakage of anything previously placed in
4168 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004169 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004170 {
4171 if( status != PSA_SUCCESS )
4172 memset( tag, '!', tag_size );
4173 else if( *tag_length < tag_size )
4174 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4175 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004176
Paul Elliott39dc6b82021-05-11 19:16:09 +01004177 psa_aead_abort( operation );
4178
4179 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004180}
4181
4182/* Finish authenticating and decrypting a message in a multipart AEAD
4183 operation.*/
4184psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4185 uint8_t *plaintext,
4186 size_t plaintext_size,
4187 size_t *plaintext_length,
4188 const uint8_t *tag,
4189 size_t tag_length )
4190{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004191 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4192
Paul Elliott302ff6b2021-04-20 18:10:30 +01004193 *plaintext_length = 0;
4194
Paul Elliott814fffb2021-08-16 18:20:36 +01004195 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004196 if( status != PSA_SUCCESS )
4197 goto exit;
4198
Paul Elliott7f429b72021-06-24 18:08:54 +01004199 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004200 {
4201 status = PSA_ERROR_BAD_STATE;
4202 goto exit;
4203 }
4204
Paul Elliott39dc6b82021-05-11 19:16:09 +01004205 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4206 plaintext_size,
4207 plaintext_length,
4208 tag, tag_length );
4209
4210exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004211 psa_aead_abort( operation );
4212
4213 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004214}
4215
4216/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004217psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004218{
4219 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4220
4221 if( operation->id == 0 )
4222 {
4223 /* The object has (apparently) been initialized but it is not (yet)
4224 * in use. It's ok to call abort on such an object, and there's
4225 * nothing to do. */
4226 return( PSA_SUCCESS );
4227 }
4228
4229 status = psa_driver_wrapper_aead_abort( operation );
4230
Paul Elliott70618b22021-09-22 17:12:16 +01004231 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004232
4233 return( status );
4234}
4235
Gilles Peskinee59236f2018-01-27 23:32:46 +01004236/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004237/* Generators */
4238/****************************************************************/
4239
Przemek Stekiel69c46792022-06-10 12:59:51 +02004240#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004241 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4242 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4243#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004244#endif /* At least one builtin KDF */
4245
Przemek Stekiel69c46792022-06-10 12:59:51 +02004246#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004247 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4248 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4249static psa_status_t psa_key_derivation_start_hmac(
4250 psa_mac_operation_t *operation,
4251 psa_algorithm_t hash_alg,
4252 const uint8_t *hmac_key,
4253 size_t hmac_key_length )
4254{
4255 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4256 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4257 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4258 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4259 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4260
Steven Cooreman72f736a2021-05-07 14:14:37 +02004261 operation->is_sign = 1;
4262 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4263
Steven Cooreman094a77e2021-05-06 17:58:36 +02004264 status = psa_driver_wrapper_mac_sign_setup( operation,
4265 &attributes,
4266 hmac_key, hmac_key_length,
4267 PSA_ALG_HMAC( hash_alg ) );
4268
4269 psa_reset_key_attributes( &attributes );
4270 return( status );
4271}
4272#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004273
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004274#define HKDF_STATE_INIT 0 /* no input yet */
4275#define HKDF_STATE_STARTED 1 /* got salt */
4276#define HKDF_STATE_KEYED 2 /* got key */
4277#define HKDF_STATE_OUTPUT 3 /* output started */
4278
Gilles Peskinecbe66502019-05-16 16:59:18 +02004279static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004280 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004281{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004282 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4283 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004284 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004285 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004286}
4287
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004288psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004289{
4290 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004291 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004292 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004293 {
4294 /* The object has (apparently) been initialized but it is not
4295 * in use. It's ok to call abort on such an object, and there's
4296 * nothing to do. */
4297 }
4298 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004299#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiela29b4882022-06-02 11:37:03 +02004300 if( PSA_ALG_IS_ANY_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004301 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004302 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004303 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004304 }
John Durkop07cc04a2020-11-16 22:08:34 -08004305 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004306#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08004307#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4308 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4309 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004310 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004311 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004312 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004313 if( operation->ctx.tls12_prf.secret != NULL )
4314 {
4315 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4316 operation->ctx.tls12_prf.secret_length );
4317 mbedtls_free( operation->ctx.tls12_prf.secret );
4318 }
4319
Janos Follath6a1d2622019-06-11 10:37:28 +01004320 if( operation->ctx.tls12_prf.seed != NULL )
4321 {
4322 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4323 operation->ctx.tls12_prf.seed_length );
4324 mbedtls_free( operation->ctx.tls12_prf.seed );
4325 }
4326
4327 if( operation->ctx.tls12_prf.label != NULL )
4328 {
4329 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4330 operation->ctx.tls12_prf.label_length );
4331 mbedtls_free( operation->ctx.tls12_prf.label );
4332 }
4333
Przemek Stekiele3ee2212022-04-07 14:29:56 +02004334 if( operation->ctx.tls12_prf.other_secret != NULL )
4335 {
4336 mbedtls_platform_zeroize( operation->ctx.tls12_prf.other_secret,
4337 operation->ctx.tls12_prf.other_secret_length );
4338 mbedtls_free( operation->ctx.tls12_prf.other_secret );
4339 }
4340
Steven Cooremana6df6042021-04-29 19:32:25 +02004341 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004342
4343 /* We leave the fields Ai and output_block to be erased safely by the
4344 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004345 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004346 else
John Durkop07cc04a2020-11-16 22:08:34 -08004347#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4348 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004349 {
4350 status = PSA_ERROR_BAD_STATE;
4351 }
Janos Follath083036a2019-06-11 10:22:26 +01004352 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004353 return( status );
4354}
4355
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004356psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004357 size_t *capacity)
4358{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004359 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004360 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004361 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004362 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004363 }
4364
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004365 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004366 return( PSA_SUCCESS );
4367}
4368
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004369psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004370 size_t capacity )
4371{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004372 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004373 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004374 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004375 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004376 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004377 return( PSA_SUCCESS );
4378}
4379
Przemek Stekiel69c46792022-06-10 12:59:51 +02004380#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004381/* Read some bytes from an HKDF-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004382static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004383 psa_algorithm_t kdf_alg,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004384 uint8_t *output,
4385 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004386{
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004387 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004388 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004389 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004390 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02004391#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004392 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02004393#else
4394 const uint8_t last_block = 0xff;
4395#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004396
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004397 if( hkdf->state < HKDF_STATE_KEYED ||
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02004398 ( !hkdf->info_set
4399#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
4400 && !PSA_ALG_IS_HKDF_EXTRACT( kdf_alg )
4401#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
4402 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004403 return( PSA_ERROR_BAD_STATE );
4404 hkdf->state = HKDF_STATE_OUTPUT;
4405
Gilles Peskinebef7f142018-07-12 17:22:21 +02004406 while( output_length != 0 )
4407 {
4408 /* Copy what remains of the current block */
4409 uint8_t n = hash_length - hkdf->offset_in_block;
4410 if( n > output_length )
4411 n = (uint8_t) output_length;
4412 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4413 output += n;
4414 output_length -= n;
4415 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004416 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004417 break;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004418 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004419 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004420 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004421 * object was corrupted or if this function is called directly
4422 * inside the library. */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004423 if( hkdf->block_number == last_block )
Gilles Peskined54931c2018-07-17 21:06:59 +02004424 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004425
4426 /* We need a new block */
4427 ++hkdf->block_number;
4428 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004429
Steven Cooreman094a77e2021-05-06 17:58:36 +02004430 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4431 hash_alg,
4432 hkdf->prk,
4433 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004434 if( status != PSA_SUCCESS )
4435 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004436
Gilles Peskinebef7f142018-07-12 17:22:21 +02004437 if( hkdf->block_number != 1 )
4438 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004439 status = psa_mac_update( &hkdf->hmac,
4440 hkdf->output_block,
4441 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004442 if( status != PSA_SUCCESS )
4443 return( status );
4444 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004445 status = psa_mac_update( &hkdf->hmac,
4446 hkdf->info,
4447 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004448 if( status != PSA_SUCCESS )
4449 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004450 status = psa_mac_update( &hkdf->hmac,
4451 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004452 if( status != PSA_SUCCESS )
4453 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004454 status = psa_mac_sign_finish( &hkdf->hmac,
4455 hkdf->output_block,
4456 sizeof( hkdf->output_block ),
4457 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004458 if( status != PSA_SUCCESS )
4459 return( status );
4460 }
4461
4462 return( PSA_SUCCESS );
4463}
Przemek Stekiel69c46792022-06-10 12:59:51 +02004464#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004465
John Durkop07cc04a2020-11-16 22:08:34 -08004466#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4467 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004468static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4469 psa_tls12_prf_key_derivation_t *tls12_prf,
4470 psa_algorithm_t alg )
4471{
4472 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004473 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004474 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4475 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004476 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004477
Janos Follath7742fee2019-06-17 12:58:10 +01004478 /* We can't be wanting more output after block 0xff, otherwise
4479 * the capacity check in psa_key_derivation_output_bytes() would have
4480 * prevented this call. It could happen only if the operation
4481 * object was corrupted or if this function is called directly
4482 * inside the library. */
4483 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004484 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004485
4486 /* We need a new block */
4487 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004488 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004489
4490 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4491 *
4492 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4493 *
4494 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4495 * HMAC_hash(secret, A(2) + seed) +
4496 * HMAC_hash(secret, A(3) + seed) + ...
4497 *
4498 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004499 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004500 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004501 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004502 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004503 * is currently extracted as `output_block` and where i is
4504 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004505 */
4506
Steven Cooreman094a77e2021-05-06 17:58:36 +02004507 status = psa_key_derivation_start_hmac( &hmac,
4508 hash_alg,
4509 tls12_prf->secret,
4510 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004511 if( status != PSA_SUCCESS )
4512 goto cleanup;
4513
4514 /* Calculate A(i) where i = tls12_prf->block_number. */
4515 if( tls12_prf->block_number == 1 )
4516 {
4517 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4518 * the variable seed and in this instance means it in the context of the
4519 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004520 status = psa_mac_update( &hmac,
4521 tls12_prf->label,
4522 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004523 if( status != PSA_SUCCESS )
4524 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004525 status = psa_mac_update( &hmac,
4526 tls12_prf->seed,
4527 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004528 if( status != PSA_SUCCESS )
4529 goto cleanup;
4530 }
4531 else
4532 {
4533 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004534 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004535 if( status != PSA_SUCCESS )
4536 goto cleanup;
4537 }
4538
Steven Cooremana6df6042021-04-29 19:32:25 +02004539 status = psa_mac_sign_finish( &hmac,
4540 tls12_prf->Ai, hash_length,
4541 &hmac_output_length );
4542 if( hmac_output_length != hash_length )
4543 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004544 if( status != PSA_SUCCESS )
4545 goto cleanup;
4546
4547 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004548 status = psa_key_derivation_start_hmac( &hmac,
4549 hash_alg,
4550 tls12_prf->secret,
4551 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004552 if( status != PSA_SUCCESS )
4553 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004554 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004555 if( status != PSA_SUCCESS )
4556 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004557 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004558 if( status != PSA_SUCCESS )
4559 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004560 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004561 if( status != PSA_SUCCESS )
4562 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004563 status = psa_mac_sign_finish( &hmac,
4564 tls12_prf->output_block, hash_length,
4565 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004566 if( status != PSA_SUCCESS )
4567 goto cleanup;
4568
Janos Follath7742fee2019-06-17 12:58:10 +01004569
4570cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004571 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004572 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4573 status = cleanup_status;
4574
4575 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004576}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004577
Janos Follath844eb0e2019-06-19 12:10:49 +01004578static psa_status_t psa_key_derivation_tls12_prf_read(
4579 psa_tls12_prf_key_derivation_t *tls12_prf,
4580 psa_algorithm_t alg,
4581 uint8_t *output,
4582 size_t output_length )
4583{
4584 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004585 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004586 psa_status_t status;
4587 uint8_t offset, length;
4588
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004589 switch( tls12_prf->state )
4590 {
4591 case PSA_TLS12_PRF_STATE_LABEL_SET:
4592 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4593 break;
4594 case PSA_TLS12_PRF_STATE_OUTPUT:
4595 break;
4596 default:
4597 return( PSA_ERROR_BAD_STATE );
4598 }
4599
Janos Follath844eb0e2019-06-19 12:10:49 +01004600 while( output_length != 0 )
4601 {
4602 /* Check if we have fully processed the current block. */
4603 if( tls12_prf->left_in_block == 0 )
4604 {
4605 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4606 alg );
4607 if( status != PSA_SUCCESS )
4608 return( status );
4609
4610 continue;
4611 }
4612
4613 if( tls12_prf->left_in_block > output_length )
4614 length = (uint8_t) output_length;
4615 else
4616 length = tls12_prf->left_in_block;
4617
4618 offset = hash_length - tls12_prf->left_in_block;
4619 memcpy( output, tls12_prf->output_block + offset, length );
4620 output += length;
4621 output_length -= length;
4622 tls12_prf->left_in_block -= length;
4623 }
4624
4625 return( PSA_SUCCESS );
4626}
John Durkop07cc04a2020-11-16 22:08:34 -08004627#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4628 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004629
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004630psa_status_t psa_key_derivation_output_bytes(
4631 psa_key_derivation_operation_t *operation,
4632 uint8_t *output,
4633 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004634{
4635 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004636 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004637
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004638 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004639 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004640 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004641 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004642 }
4643
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004644 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004645 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004646 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004647 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004648 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004649 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004650 goto exit;
4651 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004652 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004653 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004654 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004655 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004656 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4657 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004658 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004659 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004660 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004661 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004662 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004663
Przemek Stekiel69c46792022-06-10 12:59:51 +02004664#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiela29b4882022-06-02 11:37:03 +02004665 if( PSA_ALG_IS_ANY_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004666 {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004667 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, kdf_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004668 output, output_length );
4669 }
Janos Follathadbec812019-06-14 11:05:39 +01004670 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004671#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08004672#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4673 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004674 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004675 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004676 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004677 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004678 kdf_alg, output,
4679 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004680 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004681 else
John Durkop07cc04a2020-11-16 22:08:34 -08004682#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4683 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004684 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004685 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004686 return( PSA_ERROR_BAD_STATE );
4687 }
4688
4689exit:
4690 if( status != PSA_SUCCESS )
4691 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004692 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004693 * This allows us to differentiate between exhausted operations and
4694 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4695 * operations. */
4696 psa_algorithm_t alg = operation->alg;
4697 psa_key_derivation_abort( operation );
4698 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004699 memset( output, '!', output_length );
4700 }
4701 return( status );
4702}
4703
David Brown7807bf72021-02-09 16:28:23 -07004704#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004705static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4706{
4707 if( data_size >= 8 )
4708 mbedtls_des_key_set_parity( data );
4709 if( data_size >= 16 )
4710 mbedtls_des_key_set_parity( data + 8 );
4711 if( data_size >= 24 )
4712 mbedtls_des_key_set_parity( data + 16 );
4713}
David Brown7807bf72021-02-09 16:28:23 -07004714#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004715
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004716/*
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +01004717* ECC keys on a Weierstrass elliptic curve require the generation
4718* of a private key which is an integer
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004719* in the range [1, N - 1], where N is the boundary of the private key domain:
4720* N is the prime p for Diffie-Hellman, or the order of the
4721* curve’s base point for ECC.
4722*
4723* Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
4724* This function generates the private key using the following process:
4725*
4726* 1. Draw a byte string of length ceiling(m/8) bytes.
4727* 2. If m is not a multiple of 8, set the most significant
4728* (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
4729* 3. Convert the string to integer k by decoding it as a big-endian byte string.
4730* 4. If k > N - 2, discard the result and return to step 1.
4731* 5. Output k + 1 as the private key.
4732*
4733* This method allows compliance to NIST standards, specifically the methods titled
4734* Key-Pair Generation by Testing Candidates in the following publications:
4735* - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
4736* Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
4737* Diffie-Hellman keys.
4738*
4739* - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
4740* Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004741*
4742* Note: Function allocates memory for *data buffer, so given *data should be
4743* always NULL.
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004744*/
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004745#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4746 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4747 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4748 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4749 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004750static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004751 psa_key_slot_t *slot,
4752 size_t bits,
4753 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004754 uint8_t **data
4755 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004756{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004757 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004758 mbedtls_mpi k;
4759 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004760 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004761 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004762
4763 mbedtls_mpi_init( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004764 mbedtls_mpi_init( &diff_N_2 );
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004765
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004766 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
4767 slot->attr.type );
4768 mbedtls_ecp_group_id grp_id =
4769 mbedtls_ecc_group_of_psa( curve, bits, 0 );
4770
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004771 if( grp_id == MBEDTLS_ECP_DP_NONE )
4772 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004773 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004774 goto cleanup;
4775 }
4776
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004777 mbedtls_ecp_group ecp_group;
Przemyslaw Stekiel65348162021-11-18 11:57:07 +01004778 mbedtls_ecp_group_init( &ecp_group );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004779
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004780 MBEDTLS_MPI_CHK( mbedtls_ecp_group_load( &ecp_group, grp_id ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004781
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004782 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004783 /* Let m be the bit size of N. */
4784 size_t m = ecp_group.nbits;
4785
4786 size_t m_bytes = PSA_BITS_TO_BYTES( m );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004787
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004788 /* Calculate N - 2 - it will be needed later. */
4789 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &diff_N_2, &ecp_group.N, 2 ) );
4790
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004791 /* Note: This function is always called with *data == NULL and it
4792 * allocates memory for the data buffer. */
4793 *data = mbedtls_calloc( 1, m_bytes );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004794 if( *data == NULL )
4795 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004796 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004797 goto cleanup;
4798 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004799
Przemek Stekielc85f0912022-03-08 11:37:54 +01004800 while( key_out_of_range )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004801 {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004802 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004803 if( ( status = psa_key_derivation_output_bytes( operation, *data, m_bytes ) ) != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004804 goto cleanup;
4805
4806 /* 2. If m is not a multiple of 8 */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004807 if( m % 8 != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004808 {
4809 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004810 * (8 * ceiling(m/8) - m) bits of the first byte in
4811 * the string to zero.
4812 */
4813 uint8_t clear_bit_mask = ( 1 << ( m % 8 ) ) - 1;
4814 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004815 }
4816
4817 /* 3. Convert the string to integer k by decoding it as a
4818 * big-endian byte string.
4819 */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004820 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &k, *data, m_bytes ) );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004821
4822 /* 4. If k > N - 2, discard the result and return to step 1.
4823 * Result of comparison is returned. When it indicates error
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004824 * then this function is called again.
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004825 */
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004826 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( &diff_N_2, &k, &key_out_of_range ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004827 }
4828
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004829 /* 5. Output k + 1 as the private key. */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004830 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &k, &k, 1 ) );
4831 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &k, *data, m_bytes ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004832cleanup:
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004833 if( ret != 0 )
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004834 status = mbedtls_to_psa_error( ret );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004835 if( status != PSA_SUCCESS ) {
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004836 mbedtls_free( *data );
4837 *data = NULL;
4838 }
4839 mbedtls_mpi_free( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004840 mbedtls_mpi_free( &diff_N_2 );
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004841 return( status );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004842}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004843
4844/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
4845 * is determined by the curve, and sets the mandatory bits accordingly. That is:
4846 *
4847 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
4848 * draw a 32-byte string and process it as specified in
4849 * Elliptic Curves for Security [RFC7748] §5.
4850 *
4851 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
4852 * draw a 56-byte string and process it as specified in [RFC7748] §5.
4853 *
4854 * Note: Function allocates memory for *data buffer, so given *data should be
4855 * always NULL.
4856 */
4857
4858static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
4859 size_t bits,
4860 psa_key_derivation_operation_t *operation,
4861 uint8_t **data
4862 )
4863{
4864 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004865 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004866
4867 switch( bits )
4868 {
4869 case 255:
4870 output_length = 32;
4871 break;
4872 case 448:
4873 output_length = 56;
4874 break;
4875 default:
4876 return( PSA_ERROR_INVALID_ARGUMENT );
4877 break;
4878 }
4879
4880 *data = mbedtls_calloc( 1, output_length );
4881
4882 if( *data == NULL )
4883 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4884
4885 status = psa_key_derivation_output_bytes( operation, *data, output_length );
4886
4887 if( status != PSA_SUCCESS )
4888 return status;
4889
4890 switch( bits )
4891 {
4892 case 255:
4893 (*data)[0] &= 248;
4894 (*data)[31] &= 127;
4895 (*data)[31] |= 64;
4896 break;
4897 case 448:
4898 (*data)[0] &= 252;
4899 (*data)[55] |= 128;
4900 break;
4901 default:
Przemek Stekiela81aed22022-03-01 15:13:30 +01004902 return( PSA_ERROR_CORRUPTION_DETECTED );
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004903 break;
4904 }
4905
4906 return status;
4907}
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004908#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4909 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4910 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4911 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4912 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004913
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004914static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004915 psa_key_slot_t *slot,
4916 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004917 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004918{
4919 uint8_t *data = NULL;
4920 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304921 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004922 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004923
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004924 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004925 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004926
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004927#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4928 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4929 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4930 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4931 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemek Stekielc85f0912022-03-08 11:37:54 +01004932 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004933 {
Przemyslaw Stekiel92481592022-01-04 10:09:46 +01004934 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004935 if( PSA_ECC_FAMILY_IS_WEIERSTRASS( curve ) )
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004936 {
4937 /* Weierstrass elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004938 status = psa_generate_derived_ecc_key_weierstrass_helper( slot, bits, operation, &data );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004939 if( status != PSA_SUCCESS )
4940 goto exit;
Przemyslaw Stekiel50fcc532021-11-26 10:54:52 +01004941 }
4942 else
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004943 {
4944 /* Montgomery elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004945 status = psa_generate_derived_ecc_key_montgomery_helper( bits, operation, &data );
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004946 if( status != PSA_SUCCESS )
4947 goto exit;
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004948 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004949 } else
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004950#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4951 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4952 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4953 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4954 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004955 if( key_type_is_raw_bytes( slot->attr.type ) )
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004956 {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004957 if( bits % 8 != 0 )
4958 return( PSA_ERROR_INVALID_ARGUMENT );
4959 data = mbedtls_calloc( 1, bytes );
4960 if( data == NULL )
4961 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4962
4963 status = psa_key_derivation_output_bytes( operation, data, bytes );
4964 if( status != PSA_SUCCESS )
4965 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004966#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004967 if( slot->attr.type == PSA_KEY_TYPE_DES )
4968 psa_des_set_key_parity( data, bytes );
Przemek Stekielf110dc02022-03-01 14:48:05 +01004969#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004970 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004971 else
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004972 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Crondd04d422020-11-28 15:14:42 +01004973
Ronald Cronbf33c932020-11-28 18:06:53 +01004974 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004975 psa_key_attributes_t attributes = {
4976 .core = slot->attr
4977 };
4978
Archanad8a83dc2021-06-14 10:04:16 +05304979 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4980 {
Archana449608b2021-09-08 15:36:05 +05304981 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4982 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304983 if( status != PSA_SUCCESS )
4984 goto exit;
4985 }
4986 status = psa_allocate_buffer_to_slot( slot, storage_size );
4987 if( status != PSA_SUCCESS )
4988 goto exit;
4989
Ronald Cronbf33c932020-11-28 18:06:53 +01004990 status = psa_driver_wrapper_import_key( &attributes,
4991 data, bytes,
4992 slot->key.data,
4993 slot->key.bytes,
4994 &slot->key.bytes, &bits );
4995 if( bits != slot->attr.bits )
4996 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004997
4998exit:
4999 mbedtls_free( data );
5000 return( status );
5001}
5002
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005003psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005004 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005005 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005006{
5007 psa_status_t status;
5008 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005009 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005010
Ronald Cron81709fc2020-11-14 12:10:32 +01005011 *key = MBEDTLS_SVC_KEY_ID_INIT;
5012
Gilles Peskine0f84d622019-09-12 19:03:13 +02005013 /* Reject any attempt to create a zero-length key so that we don't
5014 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5015 if( psa_get_key_bits( attributes ) == 0 )
5016 return( PSA_ERROR_INVALID_ARGUMENT );
5017
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005018 if( operation->alg == PSA_ALG_NONE )
5019 return( PSA_ERROR_BAD_STATE );
5020
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005021 if( ! operation->can_output_key )
5022 return( PSA_ERROR_NOT_PERMITTED );
5023
Ronald Cron81709fc2020-11-14 12:10:32 +01005024 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5025 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5027 if( driver != NULL )
5028 {
5029 /* Deriving a key in a secure element is not implemented yet. */
5030 status = PSA_ERROR_NOT_SUPPORTED;
5031 }
5032#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005033 if( status == PSA_SUCCESS )
5034 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005035 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005036 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005037 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005038 }
5039 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005040 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005041 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005042 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005043
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005044 return( status );
5045}
5046
Gilles Peskineeab56e42018-07-12 17:12:33 +02005047
5048
5049/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005050/* Key derivation */
5051/****************************************************************/
5052
Steven Cooreman932ffb72021-02-15 12:14:32 +01005053#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005054static int is_kdf_alg_supported( psa_algorithm_t kdf_alg )
5055{
5056#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
5057 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5058 return( 1 );
5059#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02005060#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
5061 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5062 return( 1 );
5063#endif
5064#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
5065 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) )
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005066 return( 1 );
5067#endif
5068#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5069 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5070 return( 1 );
5071#endif
5072#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5073 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5074 return( 1 );
5075#endif
5076 return( 0 );
5077}
5078
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005079static psa_status_t psa_hash_try_support( psa_algorithm_t alg )
5080{
5081 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
5082 psa_status_t status = psa_hash_setup( &operation, alg );
5083 psa_hash_abort( &operation );
5084 return( status );
5085}
5086
Gilles Peskine969c5d62019-01-16 15:53:06 +01005087static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005088 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005089 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005090{
Janos Follath5fe19732019-06-20 15:09:30 +01005091 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5092 * initialisers for this union leave some bytes unspecified.) */
5093 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5094
Gilles Peskine969c5d62019-01-16 15:53:06 +01005095 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005096 if( ! is_kdf_alg_supported( kdf_alg ) )
5097 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop07cc04a2020-11-16 22:08:34 -08005098
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005099 /* All currently supported key derivation algorithms are based on a
5100 * hash algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005101 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
5102 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
5103 if( hash_size == 0 )
5104 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005105
5106 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
5107 * we might fail later, which is somewhat unfriendly and potentially
5108 * risk-prone. */
5109 psa_status_t status = psa_hash_try_support( hash_alg );
5110 if( status != PSA_SUCCESS )
5111 return( status );
5112
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005113 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5114 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
5115 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005116 {
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005117 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005118 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005119#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005120 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5121 operation->capacity = hash_size;
5122 else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005123#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005124 operation->capacity = 255 * hash_size;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005125 return( PSA_SUCCESS );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005126}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005127
5128static psa_status_t psa_key_agreement_try_support( psa_algorithm_t alg )
5129{
5130#if defined(PSA_WANT_ALG_ECDH)
5131 if( alg == PSA_ALG_ECDH )
5132 return( PSA_SUCCESS );
5133#endif
5134 (void) alg;
5135 return( PSA_ERROR_NOT_SUPPORTED );
5136}
John Durkop07cc04a2020-11-16 22:08:34 -08005137#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005138
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005139psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005140 psa_algorithm_t alg )
5141{
5142 psa_status_t status;
5143
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005144 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005145 return( PSA_ERROR_BAD_STATE );
5146
Gilles Peskine6843c292019-01-18 16:44:49 +01005147 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5148 return( PSA_ERROR_INVALID_ARGUMENT );
5149 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005150 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005151#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005152 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005153 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( alg );
5154 status = psa_key_agreement_try_support( ka_alg );
5155 if( status != PSA_SUCCESS )
5156 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005157 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005158#else
5159 return( PSA_ERROR_NOT_SUPPORTED );
5160#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005161 }
5162 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5163 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005164#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005165 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005166#else
5167 return( PSA_ERROR_NOT_SUPPORTED );
5168#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005169 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005170 else
5171 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005172
5173 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005174 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005175 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005176}
5177
Przemek Stekiel69c46792022-06-10 12:59:51 +02005178#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005179static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005180 psa_algorithm_t kdf_alg,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005181 psa_key_derivation_step_t step,
5182 const uint8_t *data,
5183 size_t data_length )
5184{
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005185 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005186 psa_status_t status;
5187 switch( step )
5188 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005189 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005190#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005191 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) )
5192 return( PSA_ERROR_INVALID_ARGUMENT );
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005193#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine2b522db2019-04-12 15:11:49 +02005194 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005195 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005196 else
5197 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005198 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5199 hash_alg,
5200 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005201 if( status != PSA_SUCCESS )
5202 return( status );
5203 hkdf->state = HKDF_STATE_STARTED;
5204 return( PSA_SUCCESS );
5205 }
Gilles Peskine03410b52019-05-16 16:05:19 +02005206 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005207#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005208 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005209 {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02005210 /* We shouldn't be in different state as HKDF_EXPAND only allows
5211 * two inputs: SECRET (this case) and INFO which does not modify
5212 * the state. It could happen only if the hkdf
5213 * object was corrupted. */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005214 if( hkdf->state != HKDF_STATE_INIT )
5215 return( PSA_ERROR_BAD_STATE );
5216
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02005217 /* Allow only input that fits expected prk size */
5218 if( data_length != PSA_HASH_LENGTH( hash_alg ) )
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005219 return( PSA_ERROR_INVALID_ARGUMENT );
5220
5221 memcpy( hkdf->prk, data, data_length );
5222 }
5223 else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005224#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005225 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02005226 /* HKDF: If no salt was provided, use an empty salt.
5227 * HKDF-EXTRACT: salt is mandatory. */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005228 if( hkdf->state == HKDF_STATE_INIT )
5229 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02005230#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
5231 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5232 return( PSA_ERROR_BAD_STATE );
5233#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005234 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5235 hash_alg,
5236 NULL, 0 );
5237 if( status != PSA_SUCCESS )
5238 return( status );
5239 hkdf->state = HKDF_STATE_STARTED;
5240 }
5241 if( hkdf->state != HKDF_STATE_STARTED )
5242 return( PSA_ERROR_BAD_STATE );
5243 status = psa_mac_update( &hkdf->hmac,
5244 data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005245 if( status != PSA_SUCCESS )
5246 return( status );
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005247 status = psa_mac_sign_finish( &hkdf->hmac,
5248 hkdf->prk,
5249 sizeof( hkdf->prk ),
5250 &data_length );
5251 if( status != PSA_SUCCESS )
5252 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005253 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005254
Gilles Peskine2b522db2019-04-12 15:11:49 +02005255 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005256 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005257#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005258 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5259 {
5260 /* The only block of output is the PRK. */
5261 memcpy( hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH( hash_alg ) );
5262 hkdf->offset_in_block = 0;
5263 }
5264 else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005265#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005266 {
5267 /* Block 0 is empty, and the next block will be
5268 * generated by psa_key_derivation_hkdf_read(). */
5269 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
5270 }
5271
Gilles Peskine2b522db2019-04-12 15:11:49 +02005272 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005273 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005274#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005275 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5276 return( PSA_ERROR_INVALID_ARGUMENT );
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005277#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02005278#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
5279 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) &&
5280 hkdf->state == HKDF_STATE_INIT )
5281 return( PSA_ERROR_BAD_STATE );
5282#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005283 if( hkdf->state == HKDF_STATE_OUTPUT )
5284 return( PSA_ERROR_BAD_STATE );
5285 if( hkdf->info_set )
5286 return( PSA_ERROR_BAD_STATE );
5287 hkdf->info_length = data_length;
5288 if( data_length != 0 )
5289 {
5290 hkdf->info = mbedtls_calloc( 1, data_length );
5291 if( hkdf->info == NULL )
5292 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5293 memcpy( hkdf->info, data, data_length );
5294 }
5295 hkdf->info_set = 1;
5296 return( PSA_SUCCESS );
5297 default:
5298 return( PSA_ERROR_INVALID_ARGUMENT );
5299 }
5300}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005301#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005302
John Durkop07cc04a2020-11-16 22:08:34 -08005303#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5304 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005305static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5306 const uint8_t *data,
5307 size_t data_length )
5308{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005309 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005310 return( PSA_ERROR_BAD_STATE );
5311
Janos Follathd6dce9f2019-07-04 09:11:38 +01005312 if( data_length != 0 )
5313 {
5314 prf->seed = mbedtls_calloc( 1, data_length );
5315 if( prf->seed == NULL )
5316 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005317
Janos Follathd6dce9f2019-07-04 09:11:38 +01005318 memcpy( prf->seed, data, data_length );
5319 prf->seed_length = data_length;
5320 }
Janos Follathf08e2652019-06-13 09:05:41 +01005321
Gilles Peskine43f958b2020-12-13 14:55:14 +01005322 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005323
5324 return( PSA_SUCCESS );
5325}
5326
Janos Follath81550542019-06-13 14:26:34 +01005327static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01005328 const uint8_t *data,
5329 size_t data_length )
5330{
Przemek Stekield7a28642022-04-07 14:58:33 +02005331 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
5332 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET )
Janos Follath81550542019-06-13 14:26:34 +01005333 return( PSA_ERROR_BAD_STATE );
5334
Steven Cooremana6df6042021-04-29 19:32:25 +02005335 if( data_length != 0 )
5336 {
5337 prf->secret = mbedtls_calloc( 1, data_length );
5338 if( prf->secret == NULL )
5339 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5340
5341 memcpy( prf->secret, data, data_length );
5342 prf->secret_length = data_length;
5343 }
Janos Follath81550542019-06-13 14:26:34 +01005344
Gilles Peskine43f958b2020-12-13 14:55:14 +01005345 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005346
5347 return( PSA_SUCCESS );
5348}
5349
Janos Follath63028dd2019-06-13 09:15:47 +01005350static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5351 const uint8_t *data,
5352 size_t data_length )
5353{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005354 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005355 return( PSA_ERROR_BAD_STATE );
5356
Janos Follathd6dce9f2019-07-04 09:11:38 +01005357 if( data_length != 0 )
5358 {
5359 prf->label = mbedtls_calloc( 1, data_length );
5360 if( prf->label == NULL )
5361 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005362
Janos Follathd6dce9f2019-07-04 09:11:38 +01005363 memcpy( prf->label, data, data_length );
5364 prf->label_length = data_length;
5365 }
Janos Follath63028dd2019-06-13 09:15:47 +01005366
Gilles Peskine43f958b2020-12-13 14:55:14 +01005367 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005368
5369 return( PSA_SUCCESS );
5370}
5371
Janos Follathb03233e2019-06-11 15:30:30 +01005372static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005373 psa_key_derivation_step_t step,
5374 const uint8_t *data,
5375 size_t data_length )
5376{
Janos Follathb03233e2019-06-11 15:30:30 +01005377 switch( step )
5378 {
Janos Follathf08e2652019-06-13 09:05:41 +01005379 case PSA_KEY_DERIVATION_INPUT_SEED:
5380 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005381 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005382 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005383 case PSA_KEY_DERIVATION_INPUT_LABEL:
5384 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005385 default:
5386 return( PSA_ERROR_INVALID_ARGUMENT );
5387 }
5388}
John Durkop07cc04a2020-11-16 22:08:34 -08005389#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5390 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5391
5392#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5393static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5394 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005395 const uint8_t *data,
5396 size_t data_length )
5397{
5398 psa_status_t status;
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005399 const size_t pms_len = ( prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
5400 4 + data_length + prf->other_secret_length :
5401 4 + 2 * data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005402
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005403 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005404 return( PSA_ERROR_INVALID_ARGUMENT );
5405
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005406 uint8_t *pms = mbedtls_calloc( 1, pms_len );
Przemek Stekiel937b90f2022-04-20 08:33:13 +02005407 if( pms == NULL )
5408 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005409 uint8_t *cur = pms;
5410
5411 /* pure-PSK:
5412 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08005413 *
5414 * The premaster secret is formed as follows: if the PSK is N octets
5415 * long, concatenate a uint16 with the value N, N zero octets, a second
5416 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005417 *
5418 * mixed-PSK:
5419 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
5420 * follows: concatenate a uint16 with the length of the other secret,
5421 * the other secret itself, uint16 with the length of PSK, and the
5422 * PSK itself.
5423 * For details please check:
5424 * - RFC 4279, Section 4 for the definition of RSA-PSK,
5425 * - RFC 4279, Section 3 for the definition of DHE-PSK,
5426 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08005427 */
5428
Przemek Stekiel4e47a912022-04-21 11:40:18 +02005429 if( prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET )
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005430 {
5431 *cur++ = MBEDTLS_BYTE_1( prf->other_secret_length );
5432 *cur++ = MBEDTLS_BYTE_0( prf->other_secret_length );
Przemek Stekiel4e47a912022-04-21 11:40:18 +02005433 if( prf->other_secret_length != 0 )
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02005434 {
5435 memcpy( cur, prf->other_secret, prf->other_secret_length );
Przemek Stekiel03faf5d22022-04-20 08:37:43 +02005436 mbedtls_platform_zeroize( prf->other_secret, prf->other_secret_length );
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02005437 cur += prf->other_secret_length;
5438 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005439 }
5440 else
5441 {
5442 *cur++ = MBEDTLS_BYTE_1( data_length );
5443 *cur++ = MBEDTLS_BYTE_0( data_length );
5444 memset( cur, 0, data_length );
5445 cur += data_length;
5446 }
5447
Joe Subbiani5ecac212021-06-24 13:00:03 +01005448 *cur++ = MBEDTLS_BYTE_1( data_length );
5449 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005450 memcpy( cur, data, data_length );
5451 cur += data_length;
5452
Steven Cooremana6df6042021-04-29 19:32:25 +02005453 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005454
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005455 mbedtls_platform_zeroize( pms, pms_len );
5456 mbedtls_free( pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005457 return( status );
5458}
Janos Follath6660f0e2019-06-17 08:44:03 +01005459
Przemek Stekiele47201b2022-04-19 13:53:28 +02005460static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
5461 psa_tls12_prf_key_derivation_t *prf,
5462 const uint8_t *data,
5463 size_t data_length )
5464{
5465 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
5466 return( PSA_ERROR_BAD_STATE );
5467
5468 if( data_length != 0 )
5469 {
5470 prf->other_secret = mbedtls_calloc( 1, data_length );
5471 if( prf->other_secret == NULL )
5472 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5473
5474 memcpy( prf->other_secret, data, data_length );
5475 prf->other_secret_length = data_length;
5476 }
5477 else
5478 {
5479 prf->other_secret_length = 0;
5480 }
5481
5482 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
5483
5484 return( PSA_SUCCESS );
5485}
5486
Janos Follath6660f0e2019-06-17 08:44:03 +01005487static psa_status_t psa_tls12_prf_psk_to_ms_input(
5488 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005489 psa_key_derivation_step_t step,
5490 const uint8_t *data,
5491 size_t data_length )
5492{
Przemek Stekiele47201b2022-04-19 13:53:28 +02005493 switch( step )
Janos Follath0c1ed842019-06-28 13:35:36 +01005494 {
Przemek Stekiele47201b2022-04-19 13:53:28 +02005495 case PSA_KEY_DERIVATION_INPUT_SECRET:
5496 return( psa_tls12_prf_psk_to_ms_set_key( prf,
5497 data, data_length ) );
5498 break;
5499 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
5500 return( psa_tls12_prf_psk_to_ms_set_other_key( prf,
5501 data,
5502 data_length ) );
5503 break;
5504 default:
5505 return( psa_tls12_prf_input( prf, step, data, data_length ) );
5506 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01005507
Przemek Stekiele47201b2022-04-19 13:53:28 +02005508 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005509}
John Durkop07cc04a2020-11-16 22:08:34 -08005510#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005511
Gilles Peskineb8965192019-09-24 16:21:10 +02005512/** Check whether the given key type is acceptable for the given
5513 * input step of a key derivation.
5514 *
5515 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5516 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5517 * Both secret and non-secret inputs can alternatively have the type
5518 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5519 * that the input was passed as a buffer rather than via a key object.
5520 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005521static int psa_key_derivation_check_input_type(
5522 psa_key_derivation_step_t step,
5523 psa_key_type_t key_type )
5524{
5525 switch( step )
5526 {
5527 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005528 if( key_type == PSA_KEY_TYPE_DERIVE )
5529 return( PSA_SUCCESS );
5530 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005531 return( PSA_SUCCESS );
5532 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02005533 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
5534 if( key_type == PSA_KEY_TYPE_DERIVE )
5535 return( PSA_SUCCESS );
5536 if( key_type == PSA_KEY_TYPE_NONE )
5537 return( PSA_SUCCESS );
5538 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02005539 case PSA_KEY_DERIVATION_INPUT_LABEL:
5540 case PSA_KEY_DERIVATION_INPUT_SALT:
5541 case PSA_KEY_DERIVATION_INPUT_INFO:
5542 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005543 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5544 return( PSA_SUCCESS );
5545 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005546 return( PSA_SUCCESS );
5547 break;
5548 }
5549 return( PSA_ERROR_INVALID_ARGUMENT );
5550}
5551
Janos Follathb80a94e2019-06-12 15:54:46 +01005552static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005553 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005554 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005555 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005556 const uint8_t *data,
5557 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005558{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005559 psa_status_t status;
5560 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5561
5562 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005563 if( status != PSA_SUCCESS )
5564 goto exit;
5565
Przemek Stekiel69c46792022-06-10 12:59:51 +02005566#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiela29b4882022-06-02 11:37:03 +02005567 if( PSA_ALG_IS_ANY_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005568 {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005569 status = psa_hkdf_input( &operation->ctx.hkdf, kdf_alg,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570 step, data, data_length );
5571 }
John Durkop07cc04a2020-11-16 22:08:34 -08005572 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005573#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005574#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5575 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005576 {
Janos Follathb03233e2019-06-11 15:30:30 +01005577 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005578 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005579 }
John Durkop07cc04a2020-11-16 22:08:34 -08005580 else
5581#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5582#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5583 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005584 {
5585 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005586 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005587 }
5588 else
John Durkop07cc04a2020-11-16 22:08:34 -08005589#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005590 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005592 (void) data;
5593 (void) data_length;
5594 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005595 return( PSA_ERROR_BAD_STATE );
5596 }
5597
Gilles Peskine224b0d62019-09-23 18:13:17 +02005598exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005599 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005600 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005601 return( status );
5602}
5603
Janos Follath51f4a0f2019-06-14 11:35:55 +01005604psa_status_t psa_key_derivation_input_bytes(
5605 psa_key_derivation_operation_t *operation,
5606 psa_key_derivation_step_t step,
5607 const uint8_t *data,
5608 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005609{
Gilles Peskineb8965192019-09-24 16:21:10 +02005610 return( psa_key_derivation_input_internal( operation, step,
5611 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005612 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005613}
5614
Janos Follath51f4a0f2019-06-14 11:35:55 +01005615psa_status_t psa_key_derivation_input_key(
5616 psa_key_derivation_operation_t *operation,
5617 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005618 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005619{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005620 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005621 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005622 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005623
Ronald Cron5c522922020-11-14 16:35:34 +01005624 status = psa_get_and_lock_transparent_key_slot_with_policy(
5625 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005626 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005627 {
5628 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005629 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005630 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005631
5632 /* Passing a key object as a SECRET input unlocks the permission
5633 * to output to a key object. */
5634 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5635 operation->can_output_key = 1;
5636
Ronald Cronf95a2b12020-10-22 15:24:49 +02005637 status = psa_key_derivation_input_internal( operation,
5638 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005639 slot->key.data,
5640 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005641
Ronald Cron5c522922020-11-14 16:35:34 +01005642 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005643
Ronald Cron5c522922020-11-14 16:35:34 +01005644 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005645}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005646
5647
5648
5649/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005650/* Key agreement */
5651/****************************************************************/
5652
John Durkop6ba40d12020-11-10 08:50:04 -08005653#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005654static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5655 size_t peer_key_length,
5656 const mbedtls_ecp_keypair *our_key,
5657 uint8_t *shared_secret,
5658 size_t shared_secret_size,
5659 size_t *shared_secret_length )
5660{
Steven Cooremand4867872020-08-05 16:31:39 +02005661 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005662 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005663 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005664 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005665 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005666 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005667
Ronald Cron90857082020-11-25 14:58:33 +01005668 status = mbedtls_psa_ecp_load_representation(
5669 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005670 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005671 peer_key,
5672 peer_key_length,
5673 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005674 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005675 goto exit;
5676
Jaeden Amero97271b32019-01-10 19:38:51 +00005677 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005678 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005679 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005680 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005681 status = mbedtls_to_psa_error(
5682 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5683 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005684 goto exit;
5685
Jaeden Amero97271b32019-01-10 19:38:51 +00005686 status = mbedtls_to_psa_error(
5687 mbedtls_ecdh_calc_secret( &ecdh,
5688 shared_secret_length,
5689 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005690 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005691 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005692 if( status != PSA_SUCCESS )
5693 goto exit;
5694 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5695 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005696
5697exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005698 if( status != PSA_SUCCESS )
5699 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005700 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005701 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005702 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005703
Jaeden Amero97271b32019-01-10 19:38:51 +00005704 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005705}
John Durkop6ba40d12020-11-10 08:50:04 -08005706#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005707
Gilles Peskine01d718c2018-09-18 12:01:02 +02005708#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5709
Gilles Peskine0216fe12019-04-11 21:23:21 +02005710static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5711 psa_key_slot_t *private_key,
5712 const uint8_t *peer_key,
5713 size_t peer_key_length,
5714 uint8_t *shared_secret,
5715 size_t shared_secret_size,
5716 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005717{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005718 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005719 {
John Durkop6ba40d12020-11-10 08:50:04 -08005720#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005721 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005722 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005723 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005724 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005725 psa_status_t status = mbedtls_psa_ecp_load_representation(
5726 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005727 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005728 private_key->key.data,
5729 private_key->key.bytes,
5730 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005731 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005732 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005733 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005734 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005735 shared_secret, shared_secret_size,
5736 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005737 mbedtls_ecp_keypair_free( ecp );
5738 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005739 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005740#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005741 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005742 (void) private_key;
5743 (void) peer_key;
5744 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005745 (void) shared_secret;
5746 (void) shared_secret_size;
5747 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005748 return( PSA_ERROR_NOT_SUPPORTED );
5749 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005750}
5751
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005752/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005753 * to potentially free embedded data structures and wipe confidential data.
5754 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005755static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005756 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005757 psa_key_slot_t *private_key,
5758 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005759 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005760{
5761 psa_status_t status;
5762 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5763 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005764 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005765
5766 /* Step 1: run the secret agreement algorithm to generate the shared
5767 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005768 status = psa_key_agreement_raw_internal( ka_alg,
5769 private_key,
5770 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005771 shared_secret,
5772 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005773 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005774 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005775 goto exit;
5776
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005777 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005778 * the shared secret. A shared secret is permitted wherever a key
5779 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005780 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005781 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005782 shared_secret,
5783 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005784exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005785 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005786 return( status );
5787}
5788
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005789psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005790 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005791 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005792 const uint8_t *peer_key,
5793 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005794{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005796 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005797 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005798
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005799 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005800 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005801 status = psa_get_and_lock_transparent_key_slot_with_policy(
5802 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005803 if( status != PSA_SUCCESS )
5804 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005805 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005806 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005807 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005808 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005809 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005810 else
5811 {
5812 /* If a private key has been added as SECRET, we allow the derived
5813 * key material to be used as a key in PSA Crypto. */
5814 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5815 operation->can_output_key = 1;
5816 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005817
Ronald Cron5c522922020-11-14 16:35:34 +01005818 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005819
Ronald Cron5c522922020-11-14 16:35:34 +01005820 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005821}
5822
Gilles Peskinebe697d82019-05-16 18:00:41 +02005823psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005824 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005825 const uint8_t *peer_key,
5826 size_t peer_key_length,
5827 uint8_t *output,
5828 size_t output_size,
5829 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005830{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005831 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005832 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005833 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005834
5835 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5836 {
5837 status = PSA_ERROR_INVALID_ARGUMENT;
5838 goto exit;
5839 }
Ronald Cron5c522922020-11-14 16:35:34 +01005840 status = psa_get_and_lock_transparent_key_slot_with_policy(
5841 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005842 if( status != PSA_SUCCESS )
5843 goto exit;
5844
Gilles Peskine3e561302022-04-14 00:17:15 +02005845 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
5846 * for the output size. The PSA specification only guarantees that this
5847 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
5848 * but it might be nice to allow smaller buffers if the output fits.
5849 * At the time of writing this comment, with only ECDH implemented,
5850 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
5851 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
5852 * be exact for it as well. */
5853 size_t expected_length =
5854 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE( slot->attr.type, slot->attr.bits );
5855 if( output_size < expected_length )
5856 {
5857 status = PSA_ERROR_BUFFER_TOO_SMALL;
5858 goto exit;
5859 }
5860
Gilles Peskine0216fe12019-04-11 21:23:21 +02005861 status = psa_key_agreement_raw_internal( alg, slot,
5862 peer_key, peer_key_length,
5863 output, output_size,
5864 output_length );
5865
5866exit:
5867 if( status != PSA_SUCCESS )
5868 {
5869 /* If an error happens and is not handled properly, the output
5870 * may be used as a key to protect sensitive data. Arrange for such
5871 * a key to be random, which is likely to result in decryption or
5872 * verification errors. This is better than filling the buffer with
5873 * some constant data such as zeros, which would result in the data
5874 * being protected with a reproducible, easily knowable key.
5875 */
5876 psa_generate_random( output, output_size );
5877 *output_length = output_size;
5878 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005879
Ronald Cron5c522922020-11-14 16:35:34 +01005880 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005881
Ronald Cron5c522922020-11-14 16:35:34 +01005882 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005883}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005884
5885
Gilles Peskine30524eb2020-11-13 17:02:26 +01005886
Gilles Peskine86a440b2018-11-12 18:39:40 +01005887/****************************************************************/
5888/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005889/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005890
Gilles Peskine30524eb2020-11-13 17:02:26 +01005891/** Initialize the PSA random generator.
5892 */
5893static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5894{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005895#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5896 memset( rng, 0, sizeof( *rng ) );
5897#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5898
Gilles Peskine30524eb2020-11-13 17:02:26 +01005899 /* Set default configuration if
5900 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5901 if( rng->entropy_init == NULL )
5902 rng->entropy_init = mbedtls_entropy_init;
5903 if( rng->entropy_free == NULL )
5904 rng->entropy_free = mbedtls_entropy_free;
5905
5906 rng->entropy_init( &rng->entropy );
5907#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5908 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5909 /* The PSA entropy injection feature depends on using NV seed as an entropy
5910 * source. Add NV seed as an entropy source for PSA entropy injection. */
5911 mbedtls_entropy_add_source( &rng->entropy,
5912 mbedtls_nv_seed_poll, NULL,
5913 MBEDTLS_ENTROPY_BLOCK_SIZE,
5914 MBEDTLS_ENTROPY_SOURCE_STRONG );
5915#endif
5916
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005917 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005918#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005919}
5920
5921/** Deinitialize the PSA random generator.
5922 */
5923static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5924{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005925#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5926 memset( rng, 0, sizeof( *rng ) );
5927#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005928 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005929 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005930#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005931}
5932
5933/** Seed the PSA random generator.
5934 */
5935static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5936{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005937#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5938 /* Do nothing: the external RNG seeds itself. */
5939 (void) rng;
5940 return( PSA_SUCCESS );
5941#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005942 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005943 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5944 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005945 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005946#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005947}
5948
Gilles Peskinee59236f2018-01-27 23:32:46 +01005949psa_status_t psa_generate_random( uint8_t *output,
5950 size_t output_size )
5951{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005952 GUARD_MODULE_INITIALIZED;
5953
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005954#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5955
5956 size_t output_length = 0;
5957 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5958 output, output_size,
5959 &output_length );
5960 if( status != PSA_SUCCESS )
5961 return( status );
5962 /* Breaking up a request into smaller chunks is currently not supported
5963 * for the extrernal RNG interface. */
5964 if( output_length != output_size )
5965 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5966 return( PSA_SUCCESS );
5967
5968#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5969
Gilles Peskine71ddab92021-01-04 21:01:07 +01005970 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005971 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005972 size_t request_size =
5973 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5974 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5975 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005976 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5977 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005978 if( ret != 0 )
5979 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005980 output_size -= request_size;
5981 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005982 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005983 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005984#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005985}
5986
Gilles Peskine8814fc42020-12-14 15:33:44 +01005987/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005988 *
5989 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5990 * `psa_generate_random(...)`. The state parameter is ignored since the
5991 * PSA API doesn't support passing an explicit state.
5992 *
5993 * In the non-external case, psa_generate_random() calls an
5994 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5995 * and semantics as mbedtls_psa_get_random(). As an optimization,
5996 * instead of doing this back-and-forth between the PSA API and the
5997 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5998 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005999 */
6000#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6001int mbedtls_psa_get_random( void *p_rng,
6002 unsigned char *output,
6003 size_t output_size )
6004{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006005 /* This function takes a pointer to the RNG state because that's what
6006 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6007 * its own state internally and doesn't let the caller access that state.
6008 * So we just ignore the state parameter, and in practice we'll pass
6009 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006010 (void) p_rng;
6011 psa_status_t status = psa_generate_random( output, output_size );
6012 if( status == PSA_SUCCESS )
6013 return( 0 );
6014 else
6015 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6016}
6017#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6018
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006019#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00006020#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006021
Gilles Peskine7228da22019-07-15 11:06:15 +02006022psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006023 size_t seed_size )
6024{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006025 if( global_data.initialized )
6026 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006027
6028 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6029 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6030 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6031 return( PSA_ERROR_INVALID_ARGUMENT );
6032
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006033 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006034}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006035#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006036
Ronald Cron3772afe2021-02-08 16:10:05 +01006037/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02006038 *
Ronald Cron3772afe2021-02-08 16:10:05 +01006039 * \param type The key type
6040 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02006041 *
6042 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01006043 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02006044 * \retval #PSA_ERROR_INVALID_ARGUMENT
6045 * The size in bits of the key is not valid.
6046 * \retval #PSA_ERROR_NOT_SUPPORTED
6047 * The type and/or the size in bits of the key or the combination of
6048 * the two is not supported.
6049 */
Ronald Cron3772afe2021-02-08 16:10:05 +01006050static psa_status_t psa_validate_key_type_and_size_for_key_generation(
6051 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006052{
Ronald Cronf3bb7612020-10-02 20:11:59 +02006053 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006054
Gilles Peskinee59236f2018-01-27 23:32:46 +01006055 if( key_type_is_raw_bytes( type ) )
6056 {
Archana4d7ae1d2021-07-07 02:50:22 +05306057 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006058 if( status != PSA_SUCCESS )
6059 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006060 }
6061 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006062#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006063 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6064 {
6065 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6066 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006067
Ronald Cron01b2aba2020-10-05 09:42:02 +02006068 /* Accept only byte-aligned keys, for the same reasons as
6069 * in psa_import_rsa_key(). */
6070 if( bits % 8 != 0 )
6071 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006072 }
6073 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006074#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006075
Ronald Cron5c4d3862020-12-07 11:07:24 +01006076#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006077 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6078 {
Ronald Crond81ab562021-02-16 09:01:16 +01006079 /* To avoid empty block, return successfully here. */
6080 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006081 }
6082 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006083#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006084 {
6085 return( PSA_ERROR_NOT_SUPPORTED );
6086 }
6087
6088 return( PSA_SUCCESS );
6089}
6090
Ronald Cron55ed0592020-10-05 10:30:40 +02006091psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006092 const psa_key_attributes_t *attributes,
6093 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006094{
6095 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006096 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006097
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006098 if( ( attributes->domain_parameters == NULL ) &&
6099 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006100 return( PSA_ERROR_INVALID_ARGUMENT );
6101
Ronald Cron01b2aba2020-10-05 09:42:02 +02006102 if( key_type_is_raw_bytes( type ) )
6103 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006104 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006105 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006106 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006107
David Brown12ca5032021-02-11 11:02:00 -07006108#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006109 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006110 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07006111#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006112 }
6113 else
6114
Jaeden Amero424fa932021-05-14 08:34:32 +01006115#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
6116 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006117 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006118 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01006119 return( mbedtls_psa_rsa_generate_key( attributes,
6120 key_buffer,
6121 key_buffer_size,
6122 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006123 }
6124 else
Jaeden Amero424fa932021-05-14 08:34:32 +01006125#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
6126 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006127
John Durkop9814fa22020-11-04 12:28:15 -08006128#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006129 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006130 {
Ronald Cron7023db52020-11-20 18:17:42 +01006131 return( mbedtls_psa_ecp_generate_key( attributes,
6132 key_buffer,
6133 key_buffer_size,
6134 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006135 }
6136 else
John Durkop9814fa22020-11-04 12:28:15 -08006137#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006138 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006139 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006140 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006141 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006142
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006143 return( PSA_SUCCESS );
6144}
Darryl Green0c6575a2018-11-07 16:05:30 +00006145
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006146psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006147 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006148{
6149 psa_status_t status;
6150 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006151 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02006152 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02006153
Ronald Cron81709fc2020-11-14 12:10:32 +01006154 *key = MBEDTLS_SVC_KEY_ID_INIT;
6155
Gilles Peskine0f84d622019-09-12 19:03:13 +02006156 /* Reject any attempt to create a zero-length key so that we don't
6157 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6158 if( psa_get_key_bits( attributes ) == 0 )
6159 return( PSA_ERROR_INVALID_ARGUMENT );
6160
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02006161 /* Reject any attempt to create a public key. */
6162 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
6163 return( PSA_ERROR_INVALID_ARGUMENT );
6164
Ronald Cron81709fc2020-11-14 12:10:32 +01006165 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6166 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006167 if( status != PSA_SUCCESS )
6168 goto exit;
6169
Ronald Cron977c2472020-10-13 08:32:21 +02006170 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05306171 * storage ( thus not in the case of generating a key in a secure element
6172 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
6173 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02006174 if( slot->key.data == NULL )
6175 {
6176 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
6177 PSA_KEY_LOCATION_LOCAL_STORAGE )
6178 {
Ronald Cron3772afe2021-02-08 16:10:05 +01006179 status = psa_validate_key_type_and_size_for_key_generation(
6180 attributes->core.type, attributes->core.bits );
6181 if( status != PSA_SUCCESS )
6182 goto exit;
6183
6184 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
6185 attributes->core.type,
6186 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02006187 }
6188 else
6189 {
6190 status = psa_driver_wrapper_get_key_buffer_size(
6191 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01006192 if( status != PSA_SUCCESS )
6193 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02006194 }
Ronald Cron977c2472020-10-13 08:32:21 +02006195
6196 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
6197 if( status != PSA_SUCCESS )
6198 goto exit;
6199 }
6200
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006201 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02006202 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02006203
Ronald Cron2b56bc82020-10-05 10:02:26 +02006204 if( status != PSA_SUCCESS )
6205 psa_remove_key_data_from_memory( slot );
6206
Gilles Peskine11792082019-08-06 18:36:36 +02006207exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006208 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006209 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006210 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006211 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006212
Darryl Green0c6575a2018-11-07 16:05:30 +00006213 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006214}
6215
Gilles Peskinee59236f2018-01-27 23:32:46 +01006216/****************************************************************/
6217/* Module setup */
6218/****************************************************************/
6219
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006220#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006221psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6222 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6223 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6224{
6225 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6226 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006227 global_data.rng.entropy_init = entropy_init;
6228 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006229 return( PSA_SUCCESS );
6230}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006231#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006232
Gilles Peskinee59236f2018-01-27 23:32:46 +01006233void mbedtls_psa_crypto_free( void )
6234{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006235 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006236 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6237 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006238 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006239 }
6240 /* Wipe all remaining data, including configuration.
6241 * In particular, this sets all state indicator to the value
6242 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006243 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Ronald Cron9ba76912021-04-10 16:57:30 +02006244
6245 /* Terminate drivers */
6246 psa_driver_wrapper_free( );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006247}
6248
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006249#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6250/** Recover a transaction that was interrupted by a power failure.
6251 *
6252 * This function is called during initialization, before psa_crypto_init()
6253 * returns. If this function returns a failure status, the initialization
6254 * fails.
6255 */
6256static psa_status_t psa_crypto_recover_transaction(
6257 const psa_crypto_transaction_t *transaction )
6258{
6259 switch( transaction->unknown.type )
6260 {
6261 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6262 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006263 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006264 * is implemented.
6265 * https://github.com/ARMmbed/mbed-crypto/issues/218
6266 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006267 default:
6268 /* We found an unsupported transaction in the storage.
6269 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006270 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006271 }
6272}
6273#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6274
Gilles Peskinee59236f2018-01-27 23:32:46 +01006275psa_status_t psa_crypto_init( void )
6276{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006277 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006278
Gilles Peskinec6b69072018-11-20 21:42:52 +01006279 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006280 if( global_data.initialized != 0 )
6281 return( PSA_SUCCESS );
6282
Gilles Peskine30524eb2020-11-13 17:02:26 +01006283 /* Initialize and seed the random generator. */
6284 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006285 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006286 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006287 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006288 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006289 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006290
Gilles Peskine66fb1262018-12-10 16:29:04 +01006291 status = psa_initialize_key_slots( );
6292 if( status != PSA_SUCCESS )
6293 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006294
Ronald Cron9ba76912021-04-10 16:57:30 +02006295 /* Init drivers */
6296 status = psa_driver_wrapper_init( );
Gilles Peskined9348f22019-10-01 15:22:29 +02006297 if( status != PSA_SUCCESS )
6298 goto exit;
Gilles Peskined9348f22019-10-01 15:22:29 +02006299
Gilles Peskine4b734222019-07-24 15:56:31 +02006300#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006301 status = psa_crypto_load_transaction( );
6302 if( status == PSA_SUCCESS )
6303 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006304 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6305 if( status != PSA_SUCCESS )
6306 goto exit;
6307 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006308 }
6309 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6310 {
6311 /* There's no transaction to complete. It's all good. */
6312 status = PSA_SUCCESS;
6313 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006314#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006315
Gilles Peskinec6b69072018-11-20 21:42:52 +01006316 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006317 global_data.initialized = 1;
6318
6319exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006320 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006321 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006322 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006323}
6324
6325#endif /* MBEDTLS_PSA_CRYPTO_C */