blob: 3574b9842acde92a094b79d286f1c3212bef5613 [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"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200205 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100211 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218#endif
219
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
223 return( PSA_ERROR_INVALID_ARGUMENT );
224 case MBEDTLS_ERR_MD_ALLOC_FAILED:
225 return( PSA_ERROR_INSUFFICIENT_MEMORY );
226 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
227 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100228
Gilles Peskinef76aa772018-10-29 19:24:33 +0100229 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
231 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
232 return( PSA_ERROR_INVALID_ARGUMENT );
233 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
236 return( PSA_ERROR_BUFFER_TOO_SMALL );
237 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
238 return( PSA_ERROR_INVALID_ARGUMENT );
239 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
244 return( PSA_ERROR_INSUFFICIENT_MEMORY );
245
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100246 case MBEDTLS_ERR_PK_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
249 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100253 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
254 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
255 return( PSA_ERROR_INVALID_ARGUMENT );
256 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
257 return( PSA_ERROR_NOT_SUPPORTED );
258 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
259 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
260 return( PSA_ERROR_NOT_PERMITTED );
261 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_INVALID_ALG:
264 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
265 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
268 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200269 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
270 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100271
Gilles Peskineff2d2002019-05-06 15:26:23 +0200272 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
273 return( PSA_ERROR_HARDWARE_FAILURE );
274 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
275 return( PSA_ERROR_NOT_SUPPORTED );
276
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_RSA_INVALID_PADDING:
280 return( PSA_ERROR_INVALID_PADDING );
281 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
286 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200287 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
289 return( PSA_ERROR_INVALID_SIGNATURE );
290 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100293 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200294
itayzafrir5c753392018-05-08 11:18:38 +0300295 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300296 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300297 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
299 return( PSA_ERROR_BUFFER_TOO_SMALL );
300 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
303 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
304 return( PSA_ERROR_INVALID_SIGNATURE );
305 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
306 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100307 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309
Janos Follatha13b9052019-11-22 12:48:59 +0000310 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
311 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300312
Gilles Peskinee59236f2018-01-27 23:32:46 +0100313 default:
David Saadab4ecc272019-02-14 13:48:10 +0200314 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 }
316}
317
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200319
320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321/****************************************************************/
322/* Key management */
323/****************************************************************/
324
Gilles Peskine73167e12019-07-12 23:44:37 +0200325#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
326static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
327{
Gilles Peskine8e338702019-07-30 20:06:31 +0200328 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200329}
330#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
331
John Durkop07cc04a2020-11-16 22:08:34 -0800332/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
333 * current test driver in key_management.c is using this function
334 * when accelerators are used for ECC key pair and public key.
335 * Once that dependency is resolved these guards can be removed.
336 */
John Durkop9814fa22020-11-04 12:28:15 -0800337#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800338 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
339 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
340 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100341mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100342 size_t bits,
343 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200344{
345 switch( curve )
346 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100347 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100351 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100352 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100353#endif
354#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100356 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100357#endif
358#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100359 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100360 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100361#endif
362#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100363 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100364 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100365#endif
366#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100367 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100368 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100369 case 528:
370 if( bits_is_sloppy )
371 return( MBEDTLS_ECP_DP_SECP521R1 );
372 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100374 }
375 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100376
Paul Elliott8ff510a2020-06-02 17:19:28 +0100377 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100381 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100382 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100383#endif
384#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100385 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100386 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100387#endif
388#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 }
393 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100394
Paul Elliott8ff510a2020-06-02 17:19:28 +0100395 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100396 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100397 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100399 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100400 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100401 case 256:
402 if( bits_is_sloppy )
403 return( MBEDTLS_ECP_DP_CURVE25519 );
404 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100405#endif
406#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 }
411 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100412
Paul Elliott8ff510a2020-06-02 17:19:28 +0100413 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100417 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100418 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100419#endif
420#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100421 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100422 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100423#endif
424#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100427#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 }
429 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200430 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100432 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100433 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200434}
John Durkop9814fa22020-11-04 12:28:15 -0800435#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800436 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
437 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
438 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200439
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200440static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
441 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200442{
443 /* Check that the bit size is acceptable for the key type */
444 switch( type )
445 {
446 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200447 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200448 case PSA_KEY_TYPE_DERIVE:
449 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100450#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200451 case PSA_KEY_TYPE_AES:
452 if( bits != 128 && bits != 192 && bits != 256 )
453 return( PSA_ERROR_INVALID_ARGUMENT );
454 break;
455#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100456#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200457 case PSA_KEY_TYPE_CAMELLIA:
458 if( bits != 128 && bits != 192 && bits != 256 )
459 return( PSA_ERROR_INVALID_ARGUMENT );
460 break;
461#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100462#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200463 case PSA_KEY_TYPE_DES:
464 if( bits != 64 && bits != 128 && bits != 192 )
465 return( PSA_ERROR_INVALID_ARGUMENT );
466 break;
467#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100468#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200469 case PSA_KEY_TYPE_CHACHA20:
470 if( bits != 256 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200474 default:
475 return( PSA_ERROR_NOT_SUPPORTED );
476 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200477 if( bits % 8 != 0 )
478 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200479
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200480 return( PSA_SUCCESS );
481}
482
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100483/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 *
Steven Cooremancd640932021-03-08 12:00:27 +0100485 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
486 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100487 *
488 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 * \param[in] key_type The key type of the key to be used with the
490 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100491 *
492 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100493 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100494 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100495 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100496 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100497MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100498 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100499 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500{
Steven Cooremancd640932021-03-08 12:00:27 +0100501 if( PSA_ALG_IS_HMAC( algorithm ) )
502 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100503 if( key_type == PSA_KEY_TYPE_HMAC )
504 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506
507 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100508 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100509 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
510 * key. */
511 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
512 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
513 {
514 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
515 * the block length (larger than 1) for block ciphers. */
516 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
517 return( PSA_SUCCESS );
518 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100519 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100520
521 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100522}
523
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200524psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
525 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200526{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100527 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200528 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200529
Ronald Cronea0f8a62020-11-25 17:52:23 +0100530 slot->key.data = mbedtls_calloc( 1, buffer_length );
531 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200532 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200533
Ronald Cronea0f8a62020-11-25 17:52:23 +0100534 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200535 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200536}
537
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200538psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
539 const uint8_t* data,
540 size_t data_length )
541{
542 psa_status_t status = psa_allocate_buffer_to_slot( slot,
543 data_length );
544 if( status != PSA_SUCCESS )
545 return( status );
546
Ronald Cronea0f8a62020-11-25 17:52:23 +0100547 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200548 return( PSA_SUCCESS );
549}
550
Ronald Crona0fe59f2020-11-29 11:14:53 +0100551psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100552 const psa_key_attributes_t *attributes,
553 const uint8_t *data, size_t data_length,
554 uint8_t *key_buffer, size_t key_buffer_size,
555 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100556{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100557 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
558 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100559
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200560 /* zero-length keys are never supported. */
561 if( data_length == 0 )
562 return( PSA_ERROR_NOT_SUPPORTED );
563
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100564 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100565 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100566 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200567
Steven Cooreman75b74362020-07-28 14:30:13 +0200568 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
569 if( data_length > SIZE_MAX / 8 )
570 return( PSA_ERROR_NOT_SUPPORTED );
571
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200572 /* Enforce a size limit, and in particular ensure that the bit
573 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100574 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200575 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200576
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100577 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200578 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200579 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200580
Ronald Crondd04d422020-11-28 15:14:42 +0100581 /* Copy the key material. */
582 memcpy( key_buffer, data, data_length );
583 *key_buffer_length = data_length;
584 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200585
Steven Cooreman40120f62020-10-29 11:42:22 +0100586 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100587 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100588 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200589 {
John Durkop9814fa22020-11-04 12:28:15 -0800590#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
591 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100592 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200593 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100594 return( mbedtls_psa_ecp_import_key( attributes,
595 data, data_length,
596 key_buffer, key_buffer_size,
597 key_buffer_length,
598 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100599 }
John Durkop9814fa22020-11-04 12:28:15 -0800600#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
601 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700602#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
603 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100604 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200605 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100606 return( mbedtls_psa_rsa_import_key( attributes,
607 data, data_length,
608 key_buffer, key_buffer_size,
609 key_buffer_length,
610 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200611 }
John Durkop9814fa22020-11-04 12:28:15 -0800612#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
613 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100614 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100615
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100616 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100617}
618
Gilles Peskinef603c712019-01-19 13:40:11 +0100619/** Calculate the intersection of two algorithm usage policies.
620 *
621 * Return 0 (which allows no operation) on incompatibility.
622 */
623static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100624 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100625 psa_algorithm_t alg1,
626 psa_algorithm_t alg2 )
627{
Gilles Peskine549ea862019-05-22 11:45:59 +0200628 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100629 if( alg1 == alg2 )
630 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100631 /* If the policies are from the same hash-and-sign family, check
632 * if one is a wildcard. If so the other has the specific algorithm. */
633 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
634 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
635 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100636 {
Steven Cooreman03488022021-02-18 12:07:20 +0100637 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
638 return( alg2 );
639 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
640 return( alg1 );
641 }
642 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100643 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100644 * restrictive tag length. */
645 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
646 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
647 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
648 {
649 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
650 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100651 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100652
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100653 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100654 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
655 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100656 {
Steven Cooremancd640932021-03-08 12:00:27 +0100657 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
658 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100659 }
660 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100661 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100662 ( alg1_len <= alg2_len ) )
663 {
664 return( alg2 );
665 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100666 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100667 ( alg2_len <= alg1_len ) )
668 {
669 return( alg1 );
670 }
671 }
672 /* If the policies are from the same MAC family, check whether one
673 * of them is a minimum-MAC-length policy. Calculate the most
674 * restrictive tag length. */
675 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
676 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
677 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
678 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100679 /* Validate the combination of key type and algorithm. Since the base
680 * algorithm of alg1 and alg2 are the same, we only need this once. */
681 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100682 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100683
Steven Cooreman31a876d2021-03-03 20:47:40 +0100684 /* Get the (exact or at-least) output lengths for both sides of the
685 * requested intersection. None of the currently supported algorithms
686 * have an output length dependent on the actual key size, so setting it
687 * to a bogus value of 0 is currently OK.
688 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100689 * Note that for at-least-this-length wildcard algorithms, the output
690 * length is set to the shortest allowed length, which allows us to
691 * calculate the most restrictive tag length for the intersection. */
692 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
693 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100694 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100695
Steven Cooremana1d83222021-02-25 10:20:29 +0100696 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100697 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
698 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100699 {
Steven Cooremancd640932021-03-08 12:00:27 +0100700 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100701 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100702
703 /* If only one is an at-least-this-length policy, the intersection would
704 * be the other (fixed-length) policy as long as said fixed length is
705 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100706 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100707 {
Steven Cooremancd640932021-03-08 12:00:27 +0100708 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100709 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100710 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100711 {
Steven Cooremancd640932021-03-08 12:00:27 +0100712 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100713 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100714
Steven Cooremancd640932021-03-08 12:00:27 +0100715 /* If none of them are wildcards, check whether they define the same tag
716 * length. This is still possible here when one is default-length and
717 * the other specific-length. Ensure to always return the
718 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100719 if( alg1_len == alg2_len )
720 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100721 }
722 /* If the policies are incompatible, allow nothing. */
723 return( 0 );
724}
725
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100726static int psa_key_algorithm_permits( psa_key_type_t key_type,
727 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200728 psa_algorithm_t requested_alg )
729{
Gilles Peskine549ea862019-05-22 11:45:59 +0200730 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200731 if( requested_alg == policy_alg )
732 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100733 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
734 * and requested_alg is the same hash-and-sign family with any hash,
735 * then requested_alg is compliant with policy_alg. */
736 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
737 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200738 {
Steven Cooreman03488022021-02-18 12:07:20 +0100739 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
740 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
741 }
742 /* If policy_alg is a wildcard AEAD algorithm of the same base as
743 * the requested algorithm, check the requested tag length to be
744 * equal-length or longer than the wildcard-specified length. */
745 if( PSA_ALG_IS_AEAD( policy_alg ) &&
746 PSA_ALG_IS_AEAD( requested_alg ) &&
747 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
748 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100749 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100750 {
751 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
752 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
753 }
Steven Cooremancd640932021-03-08 12:00:27 +0100754 /* If policy_alg is a MAC algorithm of the same base as the requested
755 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100756 if( PSA_ALG_IS_MAC( policy_alg ) &&
757 PSA_ALG_IS_MAC( requested_alg ) &&
758 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100759 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100760 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100761 /* Validate the combination of key type and algorithm. Since the policy
762 * and requested algorithms are the same, we only need this once. */
763 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100764 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100765
Steven Cooreman31a876d2021-03-03 20:47:40 +0100766 /* Get both the requested output length for the algorithm which is to be
767 * verified, and the default output length for the base algorithm.
768 * Note that none of the currently supported algorithms have an output
769 * length dependent on actual key size, so setting it to a bogus value
770 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771 size_t requested_output_length = PSA_MAC_LENGTH(
772 key_type, 0, requested_alg );
773 size_t default_output_length = PSA_MAC_LENGTH(
774 key_type, 0,
775 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100776
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 /* If the policy is default-length, only allow an algorithm with
778 * a declared exact-length matching the default. */
779 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100780 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100781
782 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100783 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
785 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
786 {
787 return( 1 );
788 }
789
Steven Cooremancd640932021-03-08 12:00:27 +0100790 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
791 * check for the requested MAC length to be equal to or longer than the
792 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100793 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
794 {
795 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100796 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100797 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200798 }
Steven Cooremance48e852020-10-05 16:02:45 +0200799 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200800 * a key derivation with that key agreement should also be allowed. This
801 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200802 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
803 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
804 {
805 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
806 policy_alg );
807 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100808 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200809 return( 0 );
810}
811
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100812/** Test whether a policy permits an algorithm.
813 *
814 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100815 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100816 * \note This function requires providing the key type for which the policy is
817 * being validated, since some algorithm policy definitions (e.g. MAC)
818 * have different properties depending on what kind of cipher it is
819 * combined with.
820 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100821 * \retval PSA_SUCCESS When \p alg is a specific algorithm
822 * allowed by the \p policy.
823 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
824 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
825 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100826 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100827static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100828 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100829 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100830{
Steven Cooremand788fab2021-02-25 11:29:17 +0100831 /* '0' is not a valid algorithm */
832 if( alg == 0 )
833 return( PSA_ERROR_INVALID_ARGUMENT );
834
Steven Cooreman7e39f052021-02-23 14:18:32 +0100835 /* A requested algorithm cannot be a wildcard. */
836 if( PSA_ALG_IS_WILDCARD( alg ) )
837 return( PSA_ERROR_INVALID_ARGUMENT );
838
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100839 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
840 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100841 return( PSA_SUCCESS );
842 else
843 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100844}
845
Gilles Peskinef603c712019-01-19 13:40:11 +0100846/** Restrict a key policy based on a constraint.
847 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100848 * \note This function requires providing the key type for which the policy is
849 * being restricted, since some algorithm policy definitions (e.g. MAC)
850 * have different properties depending on what kind of cipher it is
851 * combined with.
852 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100853 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100854 * \param[in,out] policy The policy to restrict.
855 * \param[in] constraint The policy constraint to apply.
856 *
857 * \retval #PSA_SUCCESS
858 * \c *policy contains the intersection of the original value of
859 * \c *policy and \c *constraint.
860 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100861 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100862 * \c *policy is unchanged.
863 */
864static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100865 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 psa_key_policy_t *policy,
867 const psa_key_policy_t *constraint )
868{
869 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100870 psa_key_policy_algorithm_intersection( key_type, policy->alg,
871 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100873 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
874 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
876 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
878 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100879 policy->usage &= constraint->usage;
880 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200881 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100882 return( PSA_SUCCESS );
883}
884
Ronald Cron5c522922020-11-14 16:35:34 +0100885/** Get the description of a key given its identifier and policy constraints
886 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200887 *
Ronald Cron5c522922020-11-14 16:35:34 +0100888 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100889 * nonzero, the key must allow operations with this algorithm. If \p alg is
890 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100891 *
Ronald Cron5c522922020-11-14 16:35:34 +0100892 * In case of a persistent key, the function loads the description of the key
893 * into a key slot if not already done.
894 *
895 * On success, the returned key slot is locked. It is the responsibility of
896 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200897 */
Ronald Cron5c522922020-11-14 16:35:34 +0100898static psa_status_t psa_get_and_lock_key_slot_with_policy(
899 mbedtls_svc_key_id_t key,
900 psa_key_slot_t **p_slot,
901 psa_key_usage_t usage,
902 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100903{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
905 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100906
Ronald Cron5c522922020-11-14 16:35:34 +0100907 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 if( status != PSA_SUCCESS )
909 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200910 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100911
912 /* Enforce that usage policy for the key slot contains all the flags
913 * required by the usage parameter. There is one exception: public
914 * keys can always be exported, so we treat public key objects as
915 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200916 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100917 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200918
Gilles Peskine8e338702019-07-30 20:06:31 +0200919 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100920 {
921 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200922 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100923 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100924
925 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100926 if( alg != 0 )
927 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100928 status = psa_key_policy_permits( &slot->attr.policy,
929 slot->attr.type,
930 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100931 if( status != PSA_SUCCESS )
932 goto error;
933 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100934
Darryl Green06fd18d2018-07-16 11:21:11 +0100935 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200936
937error:
938 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100939 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200940
941 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100942}
Darryl Green940d72c2018-07-13 13:18:51 +0100943
Ronald Cron5c522922020-11-14 16:35:34 +0100944/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200945 *
946 * A transparent key is a key for which the key material is directly
947 * available, as opposed to a key in a secure element.
948 *
Ronald Cron5c522922020-11-14 16:35:34 +0100949 * This is a temporary function to use instead of
950 * psa_get_and_lock_key_slot_with_policy() until secure element support is
951 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952 *
Ronald Cron5c522922020-11-14 16:35:34 +0100953 * On success, the returned key slot is locked. It is the responsibility of the
954 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 */
956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100957static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
958 mbedtls_svc_key_id_t key,
959 psa_key_slot_t **p_slot,
960 psa_key_usage_t usage,
961 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962{
Ronald Cron5c522922020-11-14 16:35:34 +0100963 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
964 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200965 if( status != PSA_SUCCESS )
966 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967
Gilles Peskineadad8132019-07-25 11:31:23 +0200968 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200969 {
Ronald Cron5c522922020-11-14 16:35:34 +0100970 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200971 *p_slot = NULL;
972 return( PSA_ERROR_NOT_SUPPORTED );
973 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200974
Gilles Peskine28f8f302019-07-24 13:30:31 +0200975 return( PSA_SUCCESS );
976}
977#else /* MBEDTLS_PSA_CRYPTO_SE_C */
978/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100979#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
980 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
982
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200983psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000984{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100985 /* Data pointer will always be either a valid pointer or NULL in an
986 * initialized slot, so we can just free it. */
987 if( slot->key.data != NULL )
988 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
989
990 mbedtls_free( slot->key.data );
991 slot->key.data = NULL;
992 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000993
994 return( PSA_SUCCESS );
995}
996
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100997/** Completely wipe a slot in memory, including its policy.
998 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100999psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001000{
1001 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001002
TRodziewicz18cddc02021-07-13 12:19:15 +02001003 /*
1004 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +02001005 * do our best to report an unexpected lock counter. Assert with
1006 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1007 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1008 * function is called as part of the execution of a test suite, the
1009 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +02001010 */
Ronald Cron5c522922020-11-14 16:35:34 +01001011 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001012 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001013 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001014 status = PSA_ERROR_CORRUPTION_DETECTED;
1015 }
1016
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001017 /* Multipart operations may still be using the key. This is safe
1018 * because all multipart operation objects are independent from
1019 * the key slot: if they need to access the key after the setup
1020 * phase, they have a copy of the key. Note that this means that
1021 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001022 /* At this point, key material and other type-specific content has
1023 * been wiped. Clear remaining metadata. We can call memset and not
1024 * zeroize because the metadata is not particularly sensitive. */
1025 memset( slot, 0, sizeof( *slot ) );
1026 return( status );
1027}
1028
Ronald Croncf56a0a2020-08-04 09:51:30 +02001029psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001030{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001031 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001032 psa_status_t status; /* status of the last operation */
1033 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001034#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1035 psa_se_drv_table_entry_t *driver;
1036#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001037
Ronald Croncf56a0a2020-08-04 09:51:30 +02001038 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001039 return( PSA_SUCCESS );
1040
Ronald Cronf2911112020-10-29 17:51:10 +01001041 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001042 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001043 * key, this will load the key description from persistent memory if not
1044 * done yet. We cannot avoid this loading as without it we don't know if
1045 * the key is operated by an SE or not and this information is needed by
1046 * the current implementation.
1047 */
Ronald Cron5c522922020-11-14 16:35:34 +01001048 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001049 if( status != PSA_SUCCESS )
1050 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001051
Ronald Cronf2911112020-10-29 17:51:10 +01001052 /*
1053 * If the key slot containing the key description is under access by the
1054 * library (apart from the present access), the key cannot be destroyed
1055 * yet. For the time being, just return in error. Eventually (to be
1056 * implemented), the key should be destroyed when all accesses have
1057 * stopped.
1058 */
Ronald Cron5c522922020-11-14 16:35:34 +01001059 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001060 {
Ronald Cron5c522922020-11-14 16:35:34 +01001061 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001062 return( PSA_ERROR_GENERIC_ERROR );
1063 }
1064
Gilles Peskine6687cd02021-04-21 22:32:05 +02001065 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1066 {
1067 /* Refuse the destruction of a read-only key (which may or may not work
1068 * if we attempt it, depending on whether the key is merely read-only
1069 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001070 * Just do the best we can, which is to wipe the copy in memory
1071 * (done in this function's cleanup code). */
1072 overall_status = PSA_ERROR_NOT_PERMITTED;
1073 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001074 }
1075
Gilles Peskine354f7672019-07-12 23:46:38 +02001076#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001077 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001078 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001079 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001080 /* For a key in a secure element, we need to do three things:
1081 * remove the key file in internal storage, destroy the
1082 * key inside the secure element, and update the driver's
1083 * persistent data. Start a transaction that will encompass these
1084 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001085 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001086 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001087 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001088 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001089 status = psa_crypto_save_transaction( );
1090 if( status != PSA_SUCCESS )
1091 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001092 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001093 /* We should still try to destroy the key in the secure
1094 * element and the key metadata in storage. This is especially
1095 * important if the error is that the storage is full.
1096 * But how to do it exactly without risking an inconsistent
1097 * state after a reset?
1098 * https://github.com/ARMmbed/mbed-crypto/issues/215
1099 */
1100 overall_status = status;
1101 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001102 }
1103
Ronald Cronea0f8a62020-11-25 17:52:23 +01001104 status = psa_destroy_se_key( driver,
1105 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001106 if( overall_status == PSA_SUCCESS )
1107 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001108 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001109#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1110
Darryl Greend49a4992018-06-18 17:27:26 +01001111#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001112 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001113 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001114 status = psa_destroy_persistent_key( slot->attr.id );
1115 if( overall_status == PSA_SUCCESS )
1116 overall_status = status;
1117
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001118 /* TODO: other slots may have a copy of the same key. We should
1119 * invalidate them.
1120 * https://github.com/ARMmbed/mbed-crypto/issues/214
1121 */
Darryl Greend49a4992018-06-18 17:27:26 +01001122 }
1123#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001124
Gilles Peskinefc762652019-07-22 19:30:34 +02001125#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1126 if( driver != NULL )
1127 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001128 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 if( overall_status == PSA_SUCCESS )
1130 overall_status = status;
1131 status = psa_crypto_stop_transaction( );
1132 if( overall_status == PSA_SUCCESS )
1133 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001134 }
1135#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1136
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001137exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001138 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001139 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001140 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001141 overall_status = status;
1142 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001143}
1144
John Durkop07cc04a2020-11-16 22:08:34 -08001145#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001146 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001147static psa_status_t psa_get_rsa_public_exponent(
1148 const mbedtls_rsa_context *rsa,
1149 psa_key_attributes_t *attributes )
1150{
1151 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001152 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001153 uint8_t *buffer = NULL;
1154 size_t buflen;
1155 mbedtls_mpi_init( &mpi );
1156
1157 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1158 if( ret != 0 )
1159 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001160 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1161 {
1162 /* It's the default value, which is reported as an empty string,
1163 * so there's nothing to do. */
1164 goto exit;
1165 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001166
1167 buflen = mbedtls_mpi_size( &mpi );
1168 buffer = mbedtls_calloc( 1, buflen );
1169 if( buffer == NULL )
1170 {
1171 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1172 goto exit;
1173 }
1174 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1175 if( ret != 0 )
1176 goto exit;
1177 attributes->domain_parameters = buffer;
1178 attributes->domain_parameters_size = buflen;
1179
1180exit:
1181 mbedtls_mpi_free( &mpi );
1182 if( ret != 0 )
1183 mbedtls_free( buffer );
1184 return( mbedtls_to_psa_error( ret ) );
1185}
John Durkop07cc04a2020-11-16 22:08:34 -08001186#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001187 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001188
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001189/** Retrieve all the publicly-accessible attributes of a key.
1190 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001191psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001192 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001193{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001194 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001195 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001196 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001197
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001198 psa_reset_key_attributes( attributes );
1199
Ronald Cron5c522922020-11-14 16:35:34 +01001200 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001201 if( status != PSA_SUCCESS )
1202 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001203
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001204 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001205 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1206 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1207
1208#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1209 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001210 psa_set_key_slot_number( attributes,
1211 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001212#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001213
Gilles Peskine8e338702019-07-30 20:06:31 +02001214 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001215 {
John Durkop07cc04a2020-11-16 22:08:34 -08001216#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001217 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001218 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001219 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001220#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001221 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001222 * is not yet implemented.
1223 * https://github.com/ARMmbed/mbed-crypto/issues/216
1224 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001225 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001226 break;
1227#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001228 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001229 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001230
Ronald Cron90857082020-11-25 14:58:33 +01001231 status = mbedtls_psa_rsa_load_representation(
1232 slot->attr.type,
1233 slot->key.data,
1234 slot->key.bytes,
1235 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001236 if( status != PSA_SUCCESS )
1237 break;
1238
Steven Cooremana2371e52020-07-28 14:30:39 +02001239 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001240 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001241 mbedtls_rsa_free( rsa );
1242 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001243 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001244 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001245#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001246 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001247 default:
1248 /* Nothing else to do. */
1249 break;
1250 }
1251
1252 if( status != PSA_SUCCESS )
1253 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001254
Ronald Cron5c522922020-11-14 16:35:34 +01001255 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001256
Ronald Cron5c522922020-11-14 16:35:34 +01001257 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001258}
1259
Gilles Peskinec8000c02019-08-02 20:15:51 +02001260#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1261psa_status_t psa_get_key_slot_number(
1262 const psa_key_attributes_t *attributes,
1263 psa_key_slot_number_t *slot_number )
1264{
1265 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1266 {
1267 *slot_number = attributes->slot_number;
1268 return( PSA_SUCCESS );
1269 }
1270 else
1271 return( PSA_ERROR_INVALID_ARGUMENT );
1272}
1273#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1274
Ronald Crond18b5f82020-11-25 16:46:05 +01001275static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1276 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001277 uint8_t *data,
1278 size_t data_size,
1279 size_t *data_length )
1280{
Ronald Crond18b5f82020-11-25 16:46:05 +01001281 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001282 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 memcpy( data, key_buffer, key_buffer_size );
1284 memset( data + key_buffer_size, 0,
1285 data_size - key_buffer_size );
1286 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001287 return( PSA_SUCCESS );
1288}
1289
Ronald Cron7285cda2020-11-26 14:46:37 +01001290psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001291 const psa_key_attributes_t *attributes,
1292 const uint8_t *key_buffer, size_t key_buffer_size,
1293 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001294{
Ronald Crond18b5f82020-11-25 16:46:05 +01001295 psa_key_type_t type = attributes->core.type;
1296
Ronald Crond18b5f82020-11-25 16:46:05 +01001297 if( key_type_is_raw_bytes( type ) ||
1298 PSA_KEY_TYPE_IS_RSA( type ) ||
1299 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001300 {
1301 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001302 key_buffer, key_buffer_size,
1303 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001304 }
1305 else
1306 {
1307 /* This shouldn't happen in the reference implementation, but
1308 it is valid for a special-purpose implementation to omit
1309 support for exporting certain key types. */
1310 return( PSA_ERROR_NOT_SUPPORTED );
1311 }
1312}
1313
1314psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1315 uint8_t *data,
1316 size_t data_size,
1317 size_t *data_length )
1318{
1319 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1320 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1321 psa_key_slot_t *slot;
1322
Ronald Crone907e552021-01-18 13:22:38 +01001323 /* Reject a zero-length output buffer now, since this can never be a
1324 * valid key representation. This way we know that data must be a valid
1325 * pointer and we can do things like memset(data, ..., data_size). */
1326 if( data_size == 0 )
1327 return( PSA_ERROR_BUFFER_TOO_SMALL );
1328
Ronald Cron9486f9d2020-11-26 13:36:23 +01001329 /* Set the key to empty now, so that even when there are errors, we always
1330 * set data_length to a value between 0 and data_size. On error, setting
1331 * the key to empty is a good choice because an empty key representation is
1332 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001333 *data_length = 0;
1334
Ronald Cron9486f9d2020-11-26 13:36:23 +01001335 /* Export requires the EXPORT flag. There is an exception for public keys,
1336 * which don't require any flag, but
1337 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1338 */
1339 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1340 PSA_KEY_USAGE_EXPORT, 0 );
1341 if( status != PSA_SUCCESS )
1342 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001343
Ronald Crond18b5f82020-11-25 16:46:05 +01001344 psa_key_attributes_t attributes = {
1345 .core = slot->attr
1346 };
Ronald Cron67227982020-11-26 15:16:05 +01001347 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001348 slot->key.data, slot->key.bytes,
1349 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001350
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351 unlock_status = psa_unlock_key_slot( slot );
1352
1353 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1354}
1355
Ronald Cron7285cda2020-11-26 14:46:37 +01001356psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 const psa_key_attributes_t *attributes,
1358 const uint8_t *key_buffer,
1359 size_t key_buffer_size,
1360 uint8_t *data,
1361 size_t data_size,
1362 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001363{
Ronald Crond18b5f82020-11-25 16:46:05 +01001364 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001365
Ronald Crond18b5f82020-11-25 16:46:05 +01001366 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001367 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001369 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001370 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001371 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001372 key_buffer, key_buffer_size,
1373 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001374 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001375
Ronald Crond18b5f82020-11-25 16:46:05 +01001376 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001377 {
John Durkop0e005192020-10-31 22:06:54 -07001378#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1379 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001380 return( mbedtls_psa_rsa_export_public_key( attributes,
1381 key_buffer,
1382 key_buffer_size,
1383 data,
1384 data_size,
1385 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001386#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001387 /* We don't know how to convert a private RSA key to public. */
1388 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001389#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1390 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001391 }
1392 else
Moran Pekera998bc62018-04-16 18:16:20 +03001393 {
John Durkop6ba40d12020-11-10 08:50:04 -08001394#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1395 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001396 return( mbedtls_psa_ecp_export_public_key( attributes,
1397 key_buffer,
1398 key_buffer_size,
1399 data,
1400 data_size,
1401 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001402#else
1403 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001404 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001405#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1406 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001407 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001408 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001409 else
1410 {
1411 /* This shouldn't happen in the reference implementation, but
1412 it is valid for a special-purpose implementation to omit
1413 support for exporting certain key types. */
1414 return( PSA_ERROR_NOT_SUPPORTED );
1415 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001416}
Ronald Crond18b5f82020-11-25 16:46:05 +01001417
Ronald Croncf56a0a2020-08-04 09:51:30 +02001418psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001419 uint8_t *data,
1420 size_t data_size,
1421 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001422{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001424 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001425 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001426
Ronald Crone907e552021-01-18 13:22:38 +01001427 /* Reject a zero-length output buffer now, since this can never be a
1428 * valid key representation. This way we know that data must be a valid
1429 * pointer and we can do things like memset(data, ..., data_size). */
1430 if( data_size == 0 )
1431 return( PSA_ERROR_BUFFER_TOO_SMALL );
1432
Darryl Greendd8fb772018-11-07 16:00:44 +00001433 /* Set the key to empty now, so that even when there are errors, we always
1434 * set data_length to a value between 0 and data_size. On error, setting
1435 * the key to empty is a good choice because an empty key representation is
1436 * unlikely to be accepted anywhere. */
1437 *data_length = 0;
1438
1439 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001440 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001441 if( status != PSA_SUCCESS )
1442 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001443
Ronald Cron9486f9d2020-11-26 13:36:23 +01001444 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1445 {
1446 status = PSA_ERROR_INVALID_ARGUMENT;
1447 goto exit;
1448 }
1449
Ronald Crond18b5f82020-11-25 16:46:05 +01001450 psa_key_attributes_t attributes = {
1451 .core = slot->attr
1452 };
Ronald Cron67227982020-11-26 15:16:05 +01001453 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001454 &attributes, slot->key.data, slot->key.bytes,
1455 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001456
1457exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001458 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001459
Ronald Cron5c522922020-11-14 16:35:34 +01001460 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001461}
1462
Gilles Peskine91e8c332019-08-02 19:19:39 +02001463#if defined(static_assert)
1464static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1465 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001466static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001467 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001468static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001469 "One or more key attribute flag is listed as both internal-only and external-only" );
1470#endif
1471
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001472/** Validate that a key policy is internally well-formed.
1473 *
1474 * This function only rejects invalid policies. It does not validate the
1475 * consistency of the policy with respect to other attributes of the key
1476 * such as the key type.
1477 */
1478static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001479{
1480 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001481 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001482 PSA_KEY_USAGE_ENCRYPT |
1483 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001484 PSA_KEY_USAGE_SIGN_MESSAGE |
1485 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001486 PSA_KEY_USAGE_SIGN_HASH |
1487 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001488 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001489 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1490 return( PSA_ERROR_INVALID_ARGUMENT );
1491
Gilles Peskine4747d192019-04-17 15:05:45 +02001492 return( PSA_SUCCESS );
1493}
1494
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001495/** Validate the internal consistency of key attributes.
1496 *
1497 * This function only rejects invalid attribute values. If does not
1498 * validate the consistency of the attributes with any key data that may
1499 * be involved in the creation of the key.
1500 *
1501 * Call this function early in the key creation process.
1502 *
1503 * \param[in] attributes Key attributes for the new key.
1504 * \param[out] p_drv On any return, the driver for the key, if any.
1505 * NULL for a transparent key.
1506 *
1507 */
1508static psa_status_t psa_validate_key_attributes(
1509 const psa_key_attributes_t *attributes,
1510 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001511{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001512 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001513 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001514 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001515
Ronald Cron54b90082020-10-29 15:26:43 +01001516 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001517 if( status != PSA_SUCCESS )
1518 return( status );
1519
Ronald Crond2ed4812020-07-17 16:11:30 +02001520 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001521 if( status != PSA_SUCCESS )
1522 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001523
Ronald Cron65f38a32020-10-23 17:11:13 +02001524 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1525 {
1526 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1527 return( PSA_ERROR_INVALID_ARGUMENT );
1528 }
1529 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001530 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001531 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1532 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001533 }
1534
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001535 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001536 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001537 return( status );
1538
1539 /* Refuse to create overly large keys.
1540 * Note that this doesn't trigger on import if the attributes don't
1541 * explicitly specify a size (so psa_get_key_bits returns 0), so
1542 * psa_import_key() needs its own checks. */
1543 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1544 return( PSA_ERROR_NOT_SUPPORTED );
1545
Gilles Peskine91e8c332019-08-02 19:19:39 +02001546 /* Reject invalid flags. These should not be reachable through the API. */
1547 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1548 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1549 return( PSA_ERROR_INVALID_ARGUMENT );
1550
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001551 return( PSA_SUCCESS );
1552}
1553
Gilles Peskine4747d192019-04-17 15:05:45 +02001554/** Prepare a key slot to receive key material.
1555 *
1556 * This function allocates a key slot and sets its metadata.
1557 *
1558 * If this function fails, call psa_fail_key_creation().
1559 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001560 * This function is intended to be used as follows:
1561 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001562 * it with the specified attributes, and in case of a volatile key assign it
1563 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001564 * -# Populate the slot with the key material.
1565 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1566 * In case of failure at any step, stop the sequence and call
1567 * psa_fail_key_creation().
1568 *
Ronald Cron5c522922020-11-14 16:35:34 +01001569 * On success, the key slot is locked. It is the responsibility of the caller
1570 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001571 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001572 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001573 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001574 * \param[out] p_slot On success, a pointer to the prepared slot.
1575 * \param[out] p_drv On any return, the driver for the key, if any.
1576 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001577 *
1578 * \retval #PSA_SUCCESS
1579 * The key slot is ready to receive key material.
1580 * \return If this function fails, the key slot is an invalid state.
1581 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001582 */
1583static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001584 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001585 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001586 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001587 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001588{
1589 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001590 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001591 psa_key_slot_t *slot;
1592
Gilles Peskinedf179142019-07-15 22:02:14 +02001593 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001594 *p_drv = NULL;
1595
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001596 status = psa_validate_key_attributes( attributes, p_drv );
1597 if( status != PSA_SUCCESS )
1598 return( status );
1599
Ronald Cronc4d1b512020-07-31 11:26:37 +02001600 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001601 if( status != PSA_SUCCESS )
1602 return( status );
1603 slot = *p_slot;
1604
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001605 /* We're storing the declared bit-size of the key. It's up to each
1606 * creation mechanism to verify that this information is correct.
1607 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001608 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001609 * is optional (import, copy). In case of a volatile key, assign it the
1610 * volatile key identifier associated to the slot returned to contain its
1611 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001612
1613 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001614 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1615 {
1616#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1617 slot->attr.id = volatile_key_id;
1618#else
1619 slot->attr.id.key_id = volatile_key_id;
1620#endif
1621 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001622
Gilles Peskine91e8c332019-08-02 19:19:39 +02001623 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001624 * external-only flags, query `attributes`. Thanks to the check
1625 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001626 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001627 * may have set. */
1628 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001629
Gilles Peskinecbaff462019-07-12 23:46:04 +02001630#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001631 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001632 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001633 * create the key file in internal storage, create the
1634 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001635 * persistent data. This is done by starting a transaction that will
1636 * encompass these three actions.
1637 * For registering a volatile key, we just need to find an appropriate
1638 * slot number inside the SE. Since the key is designated volatile, creating
1639 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001640 /* The first thing to do is to find a slot number for the new key.
1641 * We save the slot number in persistent storage as part of the
1642 * transaction data. It will be needed to recover if the power
1643 * fails during the key creation process, to clean up on the secure
1644 * element side after restarting. Obtaining a slot number from the
1645 * secure element driver updates its persistent state, but we do not yet
1646 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001647 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001648 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001649 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001650 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001651 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001653 if( status != PSA_SUCCESS )
1654 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001655
1656 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001657 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001658 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1659 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001660 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001661 psa_crypto_transaction.key.id = slot->attr.id;
1662 status = psa_crypto_save_transaction( );
1663 if( status != PSA_SUCCESS )
1664 {
1665 (void) psa_crypto_stop_transaction( );
1666 return( status );
1667 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001668 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001669
1670 status = psa_copy_key_material_into_slot(
1671 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001672 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001673
1674 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1675 {
1676 /* Key registration only makes sense with a secure element. */
1677 return( PSA_ERROR_INVALID_ARGUMENT );
1678 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001679#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1680
Ronald Cronc4d1b512020-07-31 11:26:37 +02001681 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001682}
Gilles Peskine4747d192019-04-17 15:05:45 +02001683
1684/** Finalize the creation of a key once its key material has been set.
1685 *
1686 * This entails writing the key to persistent storage.
1687 *
1688 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001689 * See the documentation of psa_start_key_creation() for the intended use
1690 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001691 *
Ronald Cron5c522922020-11-14 16:35:34 +01001692 * If the finalization succeeds, the function unlocks the key slot (it was
1693 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1694 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001695 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001696 * \param[in,out] slot Pointer to the slot with key material.
1697 * \param[in] driver The secure element driver for the key,
1698 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001699 * \param[out] key On success, identifier of the key. Note that the
1700 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001701 *
1702 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001703 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001704 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1705 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1706 * \retval #PSA_ERROR_ALREADY_EXISTS
1707 * \retval #PSA_ERROR_DATA_INVALID
1708 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001709 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001710 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001711 * \return If this function fails, the key slot is an invalid state.
1712 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001713 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001714static psa_status_t psa_finish_key_creation(
1715 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001716 psa_se_drv_table_entry_t *driver,
1717 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001718{
1719 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001720 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001721 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001722
1723#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001724 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001725 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001726#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1727 if( driver != NULL )
1728 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001729 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001730 psa_key_slot_number_t slot_number =
1731 psa_key_slot_get_slot_number( slot ) ;
1732
Gilles Peskineb46bef22019-07-30 21:32:04 +02001733#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001734 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001735 sizeof( data.slot_number ),
1736 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001737#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001739 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001740 (uint8_t*) &data,
1741 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001742 }
1743 else
1744#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1745 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001746 /* Key material is saved in export representation in the slot, so
1747 * just pass the slot buffer for storage. */
1748 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749 slot->key.data,
1750 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001751 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001752 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001753#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1754
Gilles Peskinecbaff462019-07-12 23:46:04 +02001755#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001756 /* Finish the transaction for a key creation. This does not
1757 * happen when registering an existing key. Detect this case
1758 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001759 * creation of a persistent key in a secure element requires a transaction,
1760 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001761 if( driver != NULL &&
1762 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001763 {
1764 status = psa_save_se_persistent_data( driver );
1765 if( status != PSA_SUCCESS )
1766 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001767 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001768 return( status );
1769 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001770 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001771 }
1772#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1773
Ronald Cron50972942020-11-14 11:28:25 +01001774 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001775 {
1776 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001777 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001778 if( status != PSA_SUCCESS )
1779 *key = MBEDTLS_SVC_KEY_ID_INIT;
1780 }
Ronald Cron50972942020-11-14 11:28:25 +01001781
Gilles Peskine4747d192019-04-17 15:05:45 +02001782 return( status );
1783}
1784
1785/** Abort the creation of a key.
1786 *
1787 * You may call this function after calling psa_start_key_creation(),
1788 * or after psa_finish_key_creation() fails. In other circumstances, this
1789 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001790 * See the documentation of psa_start_key_creation() for the intended use
1791 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001793 * \param[in,out] slot Pointer to the slot with key material.
1794 * \param[in] driver The secure element driver for the key,
1795 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001796 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001797static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001798 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001799{
Gilles Peskine011e4282019-06-26 18:34:38 +02001800 (void) driver;
1801
Gilles Peskine4747d192019-04-17 15:05:45 +02001802 if( slot == NULL )
1803 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001804
1805#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001806 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001807 * element, and the failure happened later (when saving metadata
1808 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001809 * element.
1810 * https://github.com/ARMmbed/mbed-crypto/issues/217
1811 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001812
Gilles Peskined7729582019-08-05 15:55:54 +02001813 /* Abort the ongoing transaction if any (there may not be one if
1814 * the creation process failed before starting one, or if the
1815 * key creation is a registration of a key in a secure element).
1816 * Earlier functions must already have done what it takes to undo any
1817 * partial creation. All that's left is to update the transaction data
1818 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001819 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001820#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1821
Gilles Peskine4747d192019-04-17 15:05:45 +02001822 psa_wipe_key_slot( slot );
1823}
1824
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001825/** Validate optional attributes during key creation.
1826 *
1827 * Some key attributes are optional during key creation. If they are
1828 * specified in the attributes structure, check that they are consistent
1829 * with the data in the slot.
1830 *
1831 * This function should be called near the end of key creation, after
1832 * the slot in memory is fully populated but before saving persistent data.
1833 */
1834static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001835 const psa_key_slot_t *slot,
1836 const psa_key_attributes_t *attributes )
1837{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001838 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001839 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001840 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 return( PSA_ERROR_INVALID_ARGUMENT );
1842 }
1843
1844 if( attributes->domain_parameters_size != 0 )
1845 {
John Durkop0e005192020-10-31 22:06:54 -07001846#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1847 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001848 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001849 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001850 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001851 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001852 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001853
Ronald Cron90857082020-11-25 14:58:33 +01001854 psa_status_t status = mbedtls_psa_rsa_load_representation(
1855 slot->attr.type,
1856 slot->key.data,
1857 slot->key.bytes,
1858 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001859 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001860 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001861
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001862 mbedtls_mpi_init( &actual );
1863 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001864 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001865 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001866 mbedtls_rsa_free( rsa );
1867 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001868 if( ret != 0 )
1869 goto rsa_exit;
1870 ret = mbedtls_mpi_read_binary( &required,
1871 attributes->domain_parameters,
1872 attributes->domain_parameters_size );
1873 if( ret != 0 )
1874 goto rsa_exit;
1875 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1876 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1877 rsa_exit:
1878 mbedtls_mpi_free( &actual );
1879 mbedtls_mpi_free( &required );
1880 if( ret != 0)
1881 return( mbedtls_to_psa_error( ret ) );
1882 }
1883 else
John Durkop9814fa22020-11-04 12:28:15 -08001884#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1885 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886 {
1887 return( PSA_ERROR_INVALID_ARGUMENT );
1888 }
1889 }
1890
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001891 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001892 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001893 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001894 return( PSA_ERROR_INVALID_ARGUMENT );
1895 }
1896
1897 return( PSA_SUCCESS );
1898}
1899
Gilles Peskine4747d192019-04-17 15:05:45 +02001900psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001901 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001902 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001903 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001904{
1905 psa_status_t status;
1906 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001907 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001908 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909
Ronald Cron81709fc2020-11-14 12:10:32 +01001910 *key = MBEDTLS_SVC_KEY_ID_INIT;
1911
Gilles Peskine0f84d622019-09-12 19:03:13 +02001912 /* Reject zero-length symmetric keys (including raw data key objects).
1913 * This also rejects any key which might be encoded as an empty string,
1914 * which is never valid. */
1915 if( data_length == 0 )
1916 return( PSA_ERROR_INVALID_ARGUMENT );
1917
Gilles Peskinedf179142019-07-15 22:02:14 +02001918 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001919 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001920 if( status != PSA_SUCCESS )
1921 goto exit;
1922
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001923 /* In the case of a transparent key or an opaque key stored in local
1924 * storage (thus not in the case of generating a key in a secure element
1925 * or cryptoprocessor with storage), we have to allocate a buffer to
1926 * hold the generated key material. */
1927 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001928 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001929 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001930 if( status != PSA_SUCCESS )
1931 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001932 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001933
1934 bits = slot->attr.bits;
1935 status = psa_driver_wrapper_import_key( attributes,
1936 data, data_length,
1937 slot->key.data,
1938 slot->key.bytes,
1939 &slot->key.bytes, &bits );
1940 if( status != PSA_SUCCESS )
1941 goto exit;
1942
1943 if( slot->attr.bits == 0 )
1944 slot->attr.bits = (psa_key_bits_t) bits;
1945 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001946 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001947 status = PSA_ERROR_INVALID_ARGUMENT;
1948 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001949 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001950
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001951 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001952 if( status != PSA_SUCCESS )
1953 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954
Ronald Cron81709fc2020-11-14 12:10:32 +01001955 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001956exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001957 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001958 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001959
Gilles Peskine4747d192019-04-17 15:05:45 +02001960 return( status );
1961}
1962
Gilles Peskined7729582019-08-05 15:55:54 +02001963#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1964psa_status_t mbedtls_psa_register_se_key(
1965 const psa_key_attributes_t *attributes )
1966{
1967 psa_status_t status;
1968 psa_key_slot_t *slot = NULL;
1969 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001970 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001971
1972 /* Leaving attributes unspecified is not currently supported.
1973 * It could make sense to query the key type and size from the
1974 * secure element, but not all secure elements support this
1975 * and the driver HAL doesn't currently support it. */
1976 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1977 return( PSA_ERROR_NOT_SUPPORTED );
1978 if( psa_get_key_bits( attributes ) == 0 )
1979 return( PSA_ERROR_NOT_SUPPORTED );
1980
1981 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001982 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001983 if( status != PSA_SUCCESS )
1984 goto exit;
1985
Ronald Cron81709fc2020-11-14 12:10:32 +01001986 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001987
1988exit:
1989 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001990 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001991
Gilles Peskined7729582019-08-05 15:55:54 +02001992 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001993 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001994 return( status );
1995}
1996#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1997
Gilles Peskinef603c712019-01-19 13:40:11 +01001998static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001999 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002000{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002001 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002002 source->key.data,
2003 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002004 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002005 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002006
Steven Cooreman398aee52020-10-13 14:35:45 +02002007 target->attr.type = source->attr.type;
2008 target->attr.bits = source->attr.bits;
2009
2010 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002011}
2012
Ronald Croncf56a0a2020-08-04 09:51:30 +02002013psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002014 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002015 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002016{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002017 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002018 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002019 psa_key_slot_t *source_slot = NULL;
2020 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002022 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002023
Ronald Cron81709fc2020-11-14 12:10:32 +01002024 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2025
Ronald Cron5c522922020-11-14 16:35:34 +01002026 status = psa_get_and_lock_transparent_key_slot_with_policy(
2027 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002028 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002029 goto exit;
2030
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002031 status = psa_validate_optional_attributes( source_slot,
2032 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002033 if( status != PSA_SUCCESS )
2034 goto exit;
2035
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002036 status = psa_restrict_key_policy( source_slot->attr.type,
2037 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002038 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002039 if( status != PSA_SUCCESS )
2040 goto exit;
2041
Ronald Cron81709fc2020-11-14 12:10:32 +01002042 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2043 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002044 if( status != PSA_SUCCESS )
2045 goto exit;
2046
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002047#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2048 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002049 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002050 /* Copying to a secure element is not implemented yet. */
2051 status = PSA_ERROR_NOT_SUPPORTED;
2052 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002053 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002054#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002055
Ronald Cron6cc66312021-04-02 12:27:47 +02002056 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2057 {
2058 /*
2059 * Copying through an opaque driver is not implemented yet, consider
2060 * a lifetime with an external location as an invalid parameter for
2061 * now.
2062 */
2063 status = PSA_ERROR_INVALID_ARGUMENT;
2064 goto exit;
2065 }
2066
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002068 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002069 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002070
Ronald Cron81709fc2020-11-14 12:10:32 +01002071 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002072exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002073 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002074 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002075
Ronald Cron5c522922020-11-14 16:35:34 +01002076 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002077
Ronald Cron5c522922020-11-14 16:35:34 +01002078 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002079}
2080
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002081
2082
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002083/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002084/* Message digests */
2085/****************************************************************/
2086
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002087psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2088{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002089 /* Aborting a non-active operation is allowed */
2090 if( operation->id == 0 )
2091 return( PSA_SUCCESS );
2092
2093 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2094 operation->id = 0;
2095
2096 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002097}
2098
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002099psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002100 psa_algorithm_t alg )
2101{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002102 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002103
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002104 /* A context must be freshly initialized before it can be set up. */
2105 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002106 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002107 status = PSA_ERROR_BAD_STATE;
2108 goto exit;
2109 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002110
2111 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002112 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002113 status = PSA_ERROR_INVALID_ARGUMENT;
2114 goto exit;
2115 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002116
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002117 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2118 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002119 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2120
Dave Rodgman685b6a72021-06-24 11:49:14 +01002121 status = psa_driver_wrapper_hash_setup( operation, alg );
2122
2123exit:
2124 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002125 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126
2127 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002128}
2129
2130psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2131 const uint8_t *input,
2132 size_t input_length )
2133{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002134 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2135
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002136 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002137 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002138 status = PSA_ERROR_BAD_STATE;
2139 goto exit;
2140 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002141
Steven Cooremanc8288352021-03-04 14:02:19 +01002142 /* Don't require hash implementations to behave correctly on a
2143 * zero-length input, which may have an invalid pointer. */
2144 if( input_length == 0 )
2145 return( PSA_SUCCESS );
2146
Dave Rodgman685b6a72021-06-24 11:49:14 +01002147 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2148
2149exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002150 if( status != PSA_SUCCESS )
2151 psa_hash_abort( operation );
2152
2153 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002154}
2155
2156psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2157 uint8_t *hash,
2158 size_t hash_size,
2159 size_t *hash_length )
2160{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002161 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002162 if( operation->id == 0 )
2163 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002164
Steven Cooreman1e582352021-02-18 17:24:37 +01002165 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002166 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002167 psa_hash_abort( operation );
2168 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169}
2170
Gilles Peskine2d277862018-06-18 15:41:12 +02002171psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2172 const uint8_t *hash,
2173 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002174{
2175 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2176 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002177 psa_status_t status = psa_hash_finish(
2178 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002179 actual_hash, sizeof( actual_hash ),
2180 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002181
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002183 goto exit;
2184
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002185 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002186 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002187 status = PSA_ERROR_INVALID_SIGNATURE;
2188 goto exit;
2189 }
2190
Steven Cooreman36876a02021-04-29 16:37:59 +02002191 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002192 status = PSA_ERROR_INVALID_SIGNATURE;
2193
2194exit:
2195 if( status != PSA_SUCCESS )
2196 psa_hash_abort(operation);
2197
2198 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002199}
2200
Gilles Peskine0a749c82019-11-28 19:33:58 +01002201psa_status_t psa_hash_compute( psa_algorithm_t alg,
2202 const uint8_t *input, size_t input_length,
2203 uint8_t *hash, size_t hash_size,
2204 size_t *hash_length )
2205{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002206 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002207 if( !PSA_ALG_IS_HASH( alg ) )
2208 return( PSA_ERROR_INVALID_ARGUMENT );
2209
Steven Cooreman1e582352021-02-18 17:24:37 +01002210 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2211 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002212}
2213
2214psa_status_t psa_hash_compare( psa_algorithm_t alg,
2215 const uint8_t *input, size_t input_length,
2216 const uint8_t *hash, size_t hash_length )
2217{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002218 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2219 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002220
2221 if( !PSA_ALG_IS_HASH( alg ) )
2222 return( PSA_ERROR_INVALID_ARGUMENT );
2223
Steven Cooreman1e582352021-02-18 17:24:37 +01002224 psa_status_t status = psa_driver_wrapper_hash_compute(
2225 alg, input, input_length,
2226 actual_hash, sizeof(actual_hash),
2227 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002228 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002229 return( status );
2230 if( actual_hash_length != hash_length )
2231 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002232 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002233 return( PSA_ERROR_INVALID_SIGNATURE );
2234 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002235}
2236
Gilles Peskineeb35d782019-01-22 17:56:16 +01002237psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2238 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002239{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002240 if( source_operation->id == 0 ||
2241 target_operation->id != 0 )
2242 {
2243 return( PSA_ERROR_BAD_STATE );
2244 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002245
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002246 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2247 target_operation );
2248 if( status != PSA_SUCCESS )
2249 psa_hash_abort( target_operation );
2250
2251 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002252}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002253
2254
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002256/* MAC */
2257/****************************************************************/
2258
Steven Cooremane6804192021-03-19 18:28:56 +01002259psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002260{
Steven Cooremane6804192021-03-19 18:28:56 +01002261 /* Aborting a non-active operation is allowed */
2262 if( operation->id == 0 )
2263 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002264
Steven Cooremane6804192021-03-19 18:28:56 +01002265 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002266 operation->mac_size = 0;
2267 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002268 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002269
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002270 return( status );
2271}
2272
Ronald Cron2dff3b22021-06-17 16:33:22 +02002273static psa_status_t psa_mac_finalize_alg_and_key_validation(
2274 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002275 const psa_key_attributes_t *attributes,
2276 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002277{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002278 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002279 psa_key_type_t key_type = psa_get_key_type( attributes );
2280 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002281
Ronald Cron28ea0502021-06-17 16:10:24 +02002282 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002283 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002284
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002285 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002286 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002287 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002288 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002289
Steven Cooremand1a68f12021-05-10 11:13:41 +02002290 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002291 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002292
Ronald Cron79bdd822021-06-17 16:46:44 +02002293 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002294 {
2295 /* A very short MAC is too short for security since it can be
2296 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2297 * so we make this our minimum, even though 32 bits is still
2298 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002299 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002300 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002301
Ronald Cron79bdd822021-06-17 16:46:44 +02002302 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2303 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002304 {
2305 /* It's impossible to "truncate" to a larger length than the full length
2306 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002307 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002308 }
2309
Ronald Cron79bdd822021-06-17 16:46:44 +02002310 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002311}
2312
Gilles Peskinee59236f2018-01-27 23:32:46 +01002313static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2314 mbedtls_svc_key_id_t key,
2315 psa_algorithm_t alg,
2316 int is_sign )
2317{
2318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2319 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002320 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002321
2322 /* A context must be freshly initialized before it can be set up. */
2323 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002324 {
Dave Rodgman54648242021-06-24 11:49:45 +01002325 status = PSA_ERROR_BAD_STATE;
2326 goto exit;
2327 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328
Gilles Peskine8c9def32018-02-08 10:02:12 +01002329 status = psa_get_and_lock_key_slot_with_policy(
2330 key,
2331 &slot,
2332 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2333 alg );
2334 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002335 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002336
2337 psa_key_attributes_t attributes = {
2338 .core = slot->attr
2339 };
2340
Ronald Cron79bdd822021-06-17 16:46:44 +02002341 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2342 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002343 if( status != PSA_SUCCESS )
2344 goto exit;
2345
2346 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002347 /* Dispatch the MAC setup call with validated input */
2348 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002349 {
Steven Cooremane6804192021-03-19 18:28:56 +01002350 status = psa_driver_wrapper_mac_sign_setup( operation,
2351 &attributes,
2352 slot->key.data,
2353 slot->key.bytes,
2354 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002355 }
2356 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002357 {
Steven Cooremane6804192021-03-19 18:28:56 +01002358 status = psa_driver_wrapper_mac_verify_setup( operation,
2359 &attributes,
2360 slot->key.data,
2361 slot->key.bytes,
2362 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002363 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002364
Gilles Peskinefbfac682018-07-08 20:51:54 +02002365exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002366 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002367 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002368
Ronald Cron5c522922020-11-14 16:35:34 +01002369 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002370
Ronald Cron5c522922020-11-14 16:35:34 +01002371 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002372}
2373
Gilles Peskine89167cb2018-07-08 20:12:23 +02002374psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002375 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002376 psa_algorithm_t alg )
2377{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002378 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002379}
2380
2381psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002382 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002383 psa_algorithm_t alg )
2384{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002385 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002386}
2387
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002388psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002389 const uint8_t *input,
2390 size_t input_length )
2391{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002392 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002393 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002394
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002395 /* Don't require hash implementations to behave correctly on a
2396 * zero-length input, which may have an invalid pointer. */
2397 if( input_length == 0 )
2398 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002399
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002400 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2401 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002402 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002403 psa_mac_abort( operation );
2404
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002405 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002406}
2407
Steven Cooremana5b860a2021-03-19 19:04:39 +01002408psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002409 uint8_t *mac,
2410 size_t mac_size,
2411 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002412{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002413 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2414 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002415
Steven Cooremana5b860a2021-03-19 19:04:39 +01002416 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002417 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002418 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002419 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002420 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002421
Steven Cooreman72f736a2021-05-07 14:14:37 +02002422 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002423 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002424 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002425 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002426 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002427
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002428 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2429 * once all the error checks are done. */
2430 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002431 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002432 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002433 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002434 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002435
2436 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002437 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002438 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002439 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002440 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002441
Steven Cooremana5b860a2021-03-19 19:04:39 +01002442 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002443 mac, operation->mac_size,
2444 mac_length );
2445
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002446exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002447 /* In case of success, set the potential excess room in the output buffer
2448 * to an invalid value, to avoid potentially leaking a longer MAC.
2449 * In case of error, set the output length and content to a safe default,
2450 * such that in case the caller misses an error check, the output would be
2451 * an unachievable MAC.
2452 */
2453 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002454 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002455 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002456 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002457 }
mohammad16036df908f2018-04-02 08:34:15 -07002458
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002459 if( mac_size > operation->mac_size )
2460 memset( &mac[operation->mac_size], '!',
2461 mac_size - operation->mac_size );
2462
Steven Cooremana5b860a2021-03-19 19:04:39 +01002463 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002464
Steven Cooremana5b860a2021-03-19 19:04:39 +01002465 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002466}
2467
Steven Cooremana5b860a2021-03-19 19:04:39 +01002468psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002469 const uint8_t *mac,
2470 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002471{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2473 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002474
Steven Cooremana5b860a2021-03-19 19:04:39 +01002475 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002476 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002477 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002478 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002479 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002480
Steven Cooreman72f736a2021-05-07 14:14:37 +02002481 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002482 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002483 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002484 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002485 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002486
2487 if( operation->mac_size != mac_length )
2488 {
2489 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002490 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002491 }
2492
Steven Cooremana5b860a2021-03-19 19:04:39 +01002493 status = psa_driver_wrapper_mac_verify_finish( operation,
2494 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002495
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002496exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002497 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002498
Steven Cooremana5b860a2021-03-19 19:04:39 +01002499 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002500}
2501
Ronald Croncd989b52021-06-18 14:23:33 +02002502static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2503 psa_algorithm_t alg,
2504 const uint8_t *input,
2505 size_t input_length,
2506 uint8_t *mac,
2507 size_t mac_size,
2508 size_t *mac_length,
2509 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002510{
2511 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002512 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2513 psa_key_slot_t *slot;
2514 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515
Ronald Cron51131b52021-06-17 17:17:20 +02002516 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002517 key, &slot,
2518 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2519 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002520 if( status != PSA_SUCCESS )
2521 goto exit;
2522
Ronald Cron51131b52021-06-17 17:17:20 +02002523 psa_key_attributes_t attributes = {
2524 .core = slot->attr
2525 };
2526
2527 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2528 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002529 if( status != PSA_SUCCESS )
2530 goto exit;
2531
Ronald Cron51131b52021-06-17 17:17:20 +02002532 if( mac_size < operation_mac_size )
2533 {
2534 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002535 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002536 }
2537
2538 status = psa_driver_wrapper_mac_compute(
2539 &attributes,
2540 slot->key.data, slot->key.bytes,
2541 alg,
2542 input, input_length,
2543 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002544
2545exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002546 /* In case of success, set the potential excess room in the output buffer
2547 * to an invalid value, to avoid potentially leaking a longer MAC.
2548 * In case of error, set the output length and content to a safe default,
2549 * such that in case the caller misses an error check, the output would be
2550 * an unachievable MAC.
2551 */
2552 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002553 {
Ronald Cron51131b52021-06-17 17:17:20 +02002554 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002555 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002556 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002557 if( mac_size > operation_mac_size )
2558 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002559
Ronald Cron51131b52021-06-17 17:17:20 +02002560 unlock_status = psa_unlock_key_slot( slot );
2561
2562 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002563}
2564
Ronald Croncd989b52021-06-18 14:23:33 +02002565psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2566 psa_algorithm_t alg,
2567 const uint8_t *input,
2568 size_t input_length,
2569 uint8_t *mac,
2570 size_t mac_size,
2571 size_t *mac_length)
2572{
2573 return( psa_mac_compute_internal( key, alg,
2574 input, input_length,
2575 mac, mac_size, mac_length, 1 ) );
2576}
2577
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002578psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2579 psa_algorithm_t alg,
2580 const uint8_t *input,
2581 size_t input_length,
2582 const uint8_t *mac,
2583 size_t mac_length)
2584{
2585 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002586 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2587 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002588
Ronald Crona587cbc2021-06-18 14:51:29 +02002589 status = psa_mac_compute_internal( key, alg,
2590 input, input_length,
2591 actual_mac, sizeof( actual_mac ),
2592 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002593 if( status != PSA_SUCCESS )
2594 goto exit;
2595
Ronald Crona587cbc2021-06-18 14:51:29 +02002596 if( mac_length != actual_mac_length )
2597 {
2598 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002599 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002600 }
2601 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2602 {
2603 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002604 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002605 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002606
2607exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002608 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002609
2610 return ( status );
2611}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002612
Gilles Peskinee59236f2018-01-27 23:32:46 +01002613/****************************************************************/
2614/* Asymmetric cryptography */
2615/****************************************************************/
2616
gabor-mezei-armf0486182021-05-12 11:03:09 +02002617static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002618 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002619{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002620 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002621 {
2622 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2623 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002624
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002625 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2626 {
2627 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2628 return( PSA_ERROR_INVALID_ARGUMENT );
2629 }
2630 }
2631 else
2632 {
2633 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2634 return( PSA_ERROR_INVALID_ARGUMENT );
2635 }
2636
2637 return( PSA_SUCCESS );
2638}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002639
2640static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002641 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002642 psa_algorithm_t alg,
2643 const uint8_t * input,
2644 size_t input_length,
2645 uint8_t * signature,
2646 size_t signature_size,
2647 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002648{
2649 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2650 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2651 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002652
2653 *signature_length = 0;
2654
gabor-mezei-armf0486182021-05-12 11:03:09 +02002655 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002656 if( status != PSA_SUCCESS )
2657 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002658
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002659 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002660 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002661 * buffer can in principle be empty since it doesn't actually have
2662 * to be a hash.) */
2663 if( signature_size == 0 )
2664 return( PSA_ERROR_BUFFER_TOO_SMALL );
2665
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002666 status = psa_get_and_lock_key_slot_with_policy(
2667 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002668 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2669 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002670 alg );
2671
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002672 if( status != PSA_SUCCESS )
2673 goto exit;
2674
2675 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2676 {
2677 status = PSA_ERROR_INVALID_ARGUMENT;
2678 goto exit;
2679 }
2680
2681 psa_key_attributes_t attributes = {
2682 .core = slot->attr
2683 };
2684
gabor-mezei-armf0486182021-05-12 11:03:09 +02002685 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002686 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002687 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002688 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002689 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002690 signature, signature_size, signature_length );
2691 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002692 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002693 {
2694
2695 status = psa_driver_wrapper_sign_hash(
2696 &attributes, slot->key.data, slot->key.bytes,
2697 alg, input, input_length,
2698 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002699 }
2700
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002701
2702exit:
2703 /* Fill the unused part of the output buffer (the whole buffer on error,
2704 * the trailing part on success) with something that isn't a valid signature
2705 * (barring an attack on the signature and deliberately-crafted input),
2706 * in case the caller doesn't check the return status properly. */
2707 if( status == PSA_SUCCESS )
2708 memset( signature + *signature_length, '!',
2709 signature_size - *signature_length );
2710 else
2711 memset( signature, '!', signature_size );
2712 /* If signature_size is 0 then we have nothing to do. We must not call
2713 * memset because signature may be NULL in this case. */
2714
2715 unlock_status = psa_unlock_key_slot( slot );
2716
2717 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2718}
2719
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002720static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002721 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002722 psa_algorithm_t alg,
2723 const uint8_t * input,
2724 size_t input_length,
2725 const uint8_t * signature,
2726 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002727{
2728 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2729 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2730 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002731
gabor-mezei-armf0486182021-05-12 11:03:09 +02002732 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002733 if( status != PSA_SUCCESS )
2734 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002735
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002736 status = psa_get_and_lock_key_slot_with_policy(
2737 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002738 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2739 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002740 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002741
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002742 if( status != PSA_SUCCESS )
2743 return( status );
2744
2745 psa_key_attributes_t attributes = {
2746 .core = slot->attr
2747 };
2748
gabor-mezei-armf0486182021-05-12 11:03:09 +02002749 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002750 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002751 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002752 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002753 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002754 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002755 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002756 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002757 {
2758 status = psa_driver_wrapper_verify_hash(
2759 &attributes, slot->key.data, slot->key.bytes,
2760 alg, input, input_length,
2761 signature, signature_length );
2762 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002763
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002764 unlock_status = psa_unlock_key_slot( slot );
2765
2766 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002767
2768}
2769
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002770psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002771 const psa_key_attributes_t *attributes,
2772 const uint8_t *key_buffer,
2773 size_t key_buffer_size,
2774 psa_algorithm_t alg,
2775 const uint8_t *input,
2776 size_t input_length,
2777 uint8_t *signature,
2778 size_t signature_size,
2779 size_t *signature_length )
2780{
2781 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002782
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002783 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2784 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002785 size_t hash_length;
2786 uint8_t hash[PSA_HASH_MAX_SIZE];
2787
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002788 status = psa_driver_wrapper_hash_compute(
2789 PSA_ALG_SIGN_GET_HASH( alg ),
2790 input, input_length,
2791 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002792
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002793 if( status != PSA_SUCCESS )
2794 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002795
2796 return psa_driver_wrapper_sign_hash(
2797 attributes, key_buffer, key_buffer_size,
2798 alg, hash, hash_length,
2799 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002800 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002801
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002802 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002803}
2804
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002805psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2806 psa_algorithm_t alg,
2807 const uint8_t * input,
2808 size_t input_length,
2809 uint8_t * signature,
2810 size_t signature_size,
2811 size_t * signature_length )
2812{
2813 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002814 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002815 signature, signature_size, signature_length );
2816}
2817
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002818psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002819 const psa_key_attributes_t *attributes,
2820 const uint8_t *key_buffer,
2821 size_t key_buffer_size,
2822 psa_algorithm_t alg,
2823 const uint8_t *input,
2824 size_t input_length,
2825 const uint8_t *signature,
2826 size_t signature_length )
2827{
2828 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002829
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002830 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2831 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002832 size_t hash_length;
2833 uint8_t hash[PSA_HASH_MAX_SIZE];
2834
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002835 status = psa_driver_wrapper_hash_compute(
2836 PSA_ALG_SIGN_GET_HASH( alg ),
2837 input, input_length,
2838 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002839
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002840 if( status != PSA_SUCCESS )
2841 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002842
2843 return psa_driver_wrapper_verify_hash(
2844 attributes, key_buffer, key_buffer_size,
2845 alg, hash, hash_length,
2846 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002847 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002848
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002849 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002850}
2851
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002852psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2853 psa_algorithm_t alg,
2854 const uint8_t * input,
2855 size_t input_length,
2856 const uint8_t * signature,
2857 size_t signature_length )
2858{
2859 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002860 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002861 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002862}
2863
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002864psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002865 const psa_key_attributes_t *attributes,
2866 const uint8_t *key_buffer, size_t key_buffer_size,
2867 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2868 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002869{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002870 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002871 {
Ronald Cron4501c982021-03-19 20:09:32 +01002872 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2873 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002874 {
Ronald Cron4501c982021-03-19 20:09:32 +01002875#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2876 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2877 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002878 attributes,
2879 key_buffer, key_buffer_size,
2880 alg, hash, hash_length,
2881 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002882#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2883 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002884 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002885 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002886 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002887 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002888 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002889 }
2890 else
Ronald Cron4501c982021-03-19 20:09:32 +01002891 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2892 {
2893 if( PSA_ALG_IS_ECDSA( alg ) )
2894 {
2895#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2896 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2897 return( mbedtls_psa_ecdsa_sign_hash(
2898 attributes,
2899 key_buffer, key_buffer_size,
2900 alg, hash, hash_length,
2901 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002902#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2903 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002904 }
2905 else
2906 {
2907 return( PSA_ERROR_INVALID_ARGUMENT );
2908 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002909 }
Ronald Cron4501c982021-03-19 20:09:32 +01002910
2911 (void)key_buffer;
2912 (void)key_buffer_size;
2913 (void)hash;
2914 (void)hash_length;
2915 (void)signature;
2916 (void)signature_size;
2917 (void)signature_length;
2918
2919 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002920}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002921
2922psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2923 psa_algorithm_t alg,
2924 const uint8_t *hash,
2925 size_t hash_length,
2926 uint8_t *signature,
2927 size_t signature_size,
2928 size_t *signature_length )
2929{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002930 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002931 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002932 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002933}
2934
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002935psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002936 const psa_key_attributes_t *attributes,
2937 const uint8_t *key_buffer, size_t key_buffer_size,
2938 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2939 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002940{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002941 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002942 {
Ronald Cron4501c982021-03-19 20:09:32 +01002943 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2944 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002945 {
Ronald Cron4501c982021-03-19 20:09:32 +01002946#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2947 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2948 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002949 attributes,
2950 key_buffer, key_buffer_size,
2951 alg, hash, hash_length,
2952 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002953#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2954 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002955 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002956 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002957 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002958 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002959 }
itayzafrir5c753392018-05-08 11:18:38 +03002960 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002961 else
Ronald Cron4501c982021-03-19 20:09:32 +01002962 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002963 {
Ronald Cron4501c982021-03-19 20:09:32 +01002964 if( PSA_ALG_IS_ECDSA( alg ) )
2965 {
2966#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2967 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2968 return( mbedtls_psa_ecdsa_verify_hash(
2969 attributes,
2970 key_buffer, key_buffer_size,
2971 alg, hash, hash_length,
2972 signature, signature_length ) );
2973#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2974 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2975 }
2976 else
2977 {
2978 return( PSA_ERROR_INVALID_ARGUMENT );
2979 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002980 }
Ronald Cron4501c982021-03-19 20:09:32 +01002981
2982 (void)key_buffer;
2983 (void)key_buffer_size;
2984 (void)hash;
2985 (void)hash_length;
2986 (void)signature;
2987 (void)signature_length;
2988
2989 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002990}
2991
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002992psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2993 psa_algorithm_t alg,
2994 const uint8_t *hash,
2995 size_t hash_length,
2996 const uint8_t *signature,
2997 size_t signature_length )
2998{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002999 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003000 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003001 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003002}
3003
John Durkop0e005192020-10-31 22:06:54 -07003004#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003005static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3006 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003007{
3008 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3009 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3010 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003011
3012 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003013}
John Durkop0e005192020-10-31 22:06:54 -07003014#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003015
Ronald Croncf56a0a2020-08-04 09:51:30 +02003016psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003017 psa_algorithm_t alg,
3018 const uint8_t *input,
3019 size_t input_length,
3020 const uint8_t *salt,
3021 size_t salt_length,
3022 uint8_t *output,
3023 size_t output_size,
3024 size_t *output_length )
3025{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003027 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003028 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003029
Darryl Green5cc689a2018-07-24 15:34:10 +01003030 (void) input;
3031 (void) input_length;
3032 (void) salt;
3033 (void) output;
3034 (void) output_size;
3035
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003036 *output_length = 0;
3037
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003038 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3039 return( PSA_ERROR_INVALID_ARGUMENT );
3040
Ronald Cron5c522922020-11-14 16:35:34 +01003041 status = psa_get_and_lock_transparent_key_slot_with_policy(
3042 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003043 if( status != PSA_SUCCESS )
3044 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003045 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3046 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003047 {
3048 status = PSA_ERROR_INVALID_ARGUMENT;
3049 goto exit;
3050 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003051
John Durkop6ba40d12020-11-10 08:50:04 -08003052#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3053 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003054 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003055 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003056 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003057 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3058 slot->key.data,
3059 slot->key.bytes,
3060 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003061 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003062 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003063
3064 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003065 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003066 status = PSA_ERROR_BUFFER_TOO_SMALL;
3067 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003068 }
John Durkop0e005192020-10-31 22:06:54 -07003069#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003070 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3071 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003072 status = mbedtls_to_psa_error(
3073 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003074 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003075 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003076 input_length,
3077 input,
3078 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003079 }
3080 else
John Durkop0e005192020-10-31 22:06:54 -07003081#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3082#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003083 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3084 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003085 status = mbedtls_to_psa_error(
3086 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3087 if( status != PSA_SUCCESS )
3088 goto rsa_exit;
3089
Steven Cooreman4fed4552020-08-03 14:46:03 +02003090 status = mbedtls_to_psa_error(
3091 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003092 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003093 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003094 salt, salt_length,
3095 input_length,
3096 input,
3097 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003098 }
3099 else
John Durkop0e005192020-10-31 22:06:54 -07003100#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003102 status = PSA_ERROR_INVALID_ARGUMENT;
3103 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003105rsa_exit:
3106 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003107 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003108
Steven Cooremana2371e52020-07-28 14:30:39 +02003109 mbedtls_rsa_free( rsa );
3110 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003111 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003112 else
John Durkop9814fa22020-11-04 12:28:15 -08003113#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003114 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003116 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003117 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003118
3119exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003120 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003121
Ronald Cron5c522922020-11-14 16:35:34 +01003122 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003123}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124
Ronald Croncf56a0a2020-08-04 09:51:30 +02003125psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003126 psa_algorithm_t alg,
3127 const uint8_t *input,
3128 size_t input_length,
3129 const uint8_t *salt,
3130 size_t salt_length,
3131 uint8_t *output,
3132 size_t output_size,
3133 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003134{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003135 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003136 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003137 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003138
Darryl Green5cc689a2018-07-24 15:34:10 +01003139 (void) input;
3140 (void) input_length;
3141 (void) salt;
3142 (void) output;
3143 (void) output_size;
3144
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003145 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003146
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003147 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3148 return( PSA_ERROR_INVALID_ARGUMENT );
3149
Ronald Cron5c522922020-11-14 16:35:34 +01003150 status = psa_get_and_lock_transparent_key_slot_with_policy(
3151 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003152 if( status != PSA_SUCCESS )
3153 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003154 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003155 {
3156 status = PSA_ERROR_INVALID_ARGUMENT;
3157 goto exit;
3158 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003159
John Durkop6ba40d12020-11-10 08:50:04 -08003160#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3161 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003162 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003163 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003164 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003165 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3166 slot->key.data,
3167 slot->key.bytes,
3168 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003169 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003170 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003171
Steven Cooremana2371e52020-07-28 14:30:39 +02003172 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003173 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003174 status = PSA_ERROR_INVALID_ARGUMENT;
3175 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003176 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003177
John Durkop0e005192020-10-31 22:06:54 -07003178#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003179 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003180 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003181 status = mbedtls_to_psa_error(
3182 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003183 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003184 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003185 output_length,
3186 input,
3187 output,
3188 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003189 }
3190 else
John Durkop0e005192020-10-31 22:06:54 -07003191#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3192#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003193 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003194 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003195 status = mbedtls_to_psa_error(
3196 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3197 if( status != PSA_SUCCESS )
3198 goto rsa_exit;
3199
Steven Cooreman4fed4552020-08-03 14:46:03 +02003200 status = mbedtls_to_psa_error(
3201 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003202 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003203 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003204 salt, salt_length,
3205 output_length,
3206 input,
3207 output,
3208 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003209 }
3210 else
John Durkop0e005192020-10-31 22:06:54 -07003211#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003212 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003213 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003215
Steven Cooreman4fed4552020-08-03 14:46:03 +02003216rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003217 mbedtls_rsa_free( rsa );
3218 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003220 else
John Durkop6ba40d12020-11-10 08:50:04 -08003221#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3222 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003223 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003224 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003225 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003226
3227exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003228 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003229
Ronald Cron5c522922020-11-14 16:35:34 +01003230 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003231}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003232
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003233
3234
mohammad1603503973b2018-03-12 15:59:30 +02003235/****************************************************************/
3236/* Symmetric cryptography */
3237/****************************************************************/
3238
Ronald Cronab99ac22020-10-01 16:38:28 +02003239static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3240 mbedtls_svc_key_id_t key,
3241 psa_algorithm_t alg,
3242 mbedtls_operation_t cipher_operation )
3243{
3244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3245 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003246 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003247 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3248 PSA_KEY_USAGE_ENCRYPT :
3249 PSA_KEY_USAGE_DECRYPT );
3250
3251 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003252 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003253 {
Dave Rodgman54648242021-06-24 11:49:45 +01003254 status = PSA_ERROR_BAD_STATE;
3255 goto exit;
3256 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003257
Ronald Cronab99ac22020-10-01 16:38:28 +02003258 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003259 {
Dave Rodgman54648242021-06-24 11:49:45 +01003260 status = PSA_ERROR_INVALID_ARGUMENT;
3261 goto exit;
3262 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003263
Ronald Cronab99ac22020-10-01 16:38:28 +02003264 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3265 if( status != PSA_SUCCESS )
3266 goto exit;
3267
Ronald Cron49fafa92021-03-10 08:34:23 +01003268 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003269 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003270 * so we only set it (in the driver wrapper) after resources have been
3271 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003272 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003273 if( alg == PSA_ALG_ECB_NO_PADDING )
3274 operation->iv_required = 0;
3275 else
3276 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003277 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003278
Ronald Crona4af55f2020-12-14 14:36:06 +01003279 psa_key_attributes_t attributes = {
3280 .core = slot->attr
3281 };
3282
Ronald Cronab99ac22020-10-01 16:38:28 +02003283 /* Try doing the operation through a driver before using software fallback. */
3284 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003285 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3286 &attributes,
3287 slot->key.data,
3288 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003289 alg );
3290 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003291 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3292 &attributes,
3293 slot->key.data,
3294 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003295 alg );
3296
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003297exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003298 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003299 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003300
Ronald Cron5c522922020-11-14 16:35:34 +01003301 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003302
Ronald Cron5c522922020-11-14 16:35:34 +01003303 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003304}
3305
Gilles Peskinefe119512018-07-08 21:39:34 +02003306psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003307 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003308 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003309{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003310 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003311}
3312
Gilles Peskinefe119512018-07-08 21:39:34 +02003313psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003314 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003315 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003316{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003317 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003318}
3319
Gilles Peskinefe119512018-07-08 21:39:34 +02003320psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003321 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003322 size_t iv_size,
3323 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003324{
Ronald Cron6d051732020-10-01 14:10:20 +02003325 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003326
Ronald Cron5618a392021-03-26 09:52:26 +01003327 *iv_length = 0;
3328
Ronald Cron49fafa92021-03-10 08:34:23 +01003329 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003330 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003331 status = PSA_ERROR_BAD_STATE;
3332 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003333 }
3334
Steven Cooreman7df02922020-09-09 15:28:49 +02003335 if( operation->iv_set || ! operation->iv_required )
3336 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003337 status = PSA_ERROR_BAD_STATE;
3338 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003339 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003340
Ronald Cron5618a392021-03-26 09:52:26 +01003341 if( iv_size < operation->default_iv_length )
3342 {
3343 status = PSA_ERROR_BUFFER_TOO_SMALL;
3344 goto exit;
3345 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003346
Ronald Cron5618a392021-03-26 09:52:26 +01003347 status = psa_generate_random( iv, operation->default_iv_length );
3348 if( status != PSA_SUCCESS )
3349 goto exit;
3350
3351 status = psa_driver_wrapper_cipher_set_iv( operation,
3352 iv,
3353 operation->default_iv_length );
3354
3355exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003356 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003357 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003358 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003359 *iv_length = operation->default_iv_length;
3360 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003361 else
Moran Peker395db872018-05-31 14:07:14 +03003362 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003363
itayzafrir534bd7c2018-08-02 13:56:32 +03003364 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003365}
3366
Gilles Peskinefe119512018-07-08 21:39:34 +02003367psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003368 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003369 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003370{
Ronald Cron6d051732020-10-01 14:10:20 +02003371 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003372
Ronald Cron49fafa92021-03-10 08:34:23 +01003373 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003374 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003375 status = PSA_ERROR_BAD_STATE;
3376 goto exit;
3377 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003378
Steven Cooreman7df02922020-09-09 15:28:49 +02003379 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003380 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003381 status = PSA_ERROR_BAD_STATE;
3382 goto exit;
3383 }
Ronald Crona0d68172021-03-26 10:15:08 +01003384
3385 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003386 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003387 status = PSA_ERROR_INVALID_ARGUMENT;
3388 goto exit;
3389 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003390
Ronald Crondd24c9b2020-12-15 14:10:01 +01003391 status = psa_driver_wrapper_cipher_set_iv( operation,
3392 iv,
3393 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003394
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003395exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003396 if( status == PSA_SUCCESS )
3397 operation->iv_set = 1;
3398 else
mohammad1603503973b2018-03-12 15:59:30 +02003399 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003400 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003401}
3402
Gilles Peskinee553c652018-06-04 16:22:46 +02003403psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3404 const uint8_t *input,
3405 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003406 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003407 size_t output_size,
3408 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003409{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003410 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003411
Ronald Cron49fafa92021-03-10 08:34:23 +01003412 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003413 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003414 status = PSA_ERROR_BAD_STATE;
3415 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003416 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003417
Steven Cooreman7df02922020-09-09 15:28:49 +02003418 if( operation->iv_required && ! operation->iv_set )
3419 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003420 status = PSA_ERROR_BAD_STATE;
3421 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003422 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003423
Ronald Crondd24c9b2020-12-15 14:10:01 +01003424 status = psa_driver_wrapper_cipher_update( operation,
3425 input,
3426 input_length,
3427 output,
3428 output_size,
3429 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003430
3431exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003432 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003433 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003434
itayzafrir534bd7c2018-08-02 13:56:32 +03003435 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003436}
3437
Gilles Peskinee553c652018-06-04 16:22:46 +02003438psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3439 uint8_t *output,
3440 size_t output_size,
3441 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003442{
David Saadab4ecc272019-02-14 13:48:10 +02003443 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003444
Ronald Cron49fafa92021-03-10 08:34:23 +01003445 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003446 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003447 status = PSA_ERROR_BAD_STATE;
3448 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003449 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003450
Steven Cooreman7df02922020-09-09 15:28:49 +02003451 if( operation->iv_required && ! operation->iv_set )
3452 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003453 status = PSA_ERROR_BAD_STATE;
3454 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003455 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003456
Ronald Crondd24c9b2020-12-15 14:10:01 +01003457 status = psa_driver_wrapper_cipher_finish( operation,
3458 output,
3459 output_size,
3460 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003461
3462exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003463 if( status == PSA_SUCCESS )
3464 return( psa_cipher_abort( operation ) );
3465 else
3466 {
3467 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003468 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003469
Steven Cooremanef8575e2020-09-11 11:44:50 +02003470 return( status );
3471 }
mohammad1603503973b2018-03-12 15:59:30 +02003472}
3473
Gilles Peskinee553c652018-06-04 16:22:46 +02003474psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3475{
Ronald Cron49fafa92021-03-10 08:34:23 +01003476 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003477 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003478 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003479 * in use. It's ok to call abort on such an object, and there's
3480 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003481 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003482 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003483
Ronald Crondd24c9b2020-12-15 14:10:01 +01003484 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003485
Ronald Cron49fafa92021-03-10 08:34:23 +01003486 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003487 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003488 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003489
Moran Peker395db872018-05-31 14:07:14 +03003490 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003491}
3492
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003493psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3494 psa_algorithm_t alg,
3495 const uint8_t *input,
3496 size_t input_length,
3497 uint8_t *output,
3498 size_t output_size,
3499 size_t *output_length )
3500{
3501 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003502 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3503 psa_key_slot_t *slot;
3504 psa_key_type_t key_type;
3505 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003506
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003507 *output_length = 0;
3508
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003509 if( ! PSA_ALG_IS_CIPHER( alg ) )
3510 return( PSA_ERROR_INVALID_ARGUMENT );
3511
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003512 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3513 PSA_KEY_USAGE_ENCRYPT,
3514 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003515 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003516 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003517
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003518 psa_key_attributes_t attributes = {
3519 .core = slot->attr
3520 };
3521
3522 key_type = slot->attr.type;
3523 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3524
3525 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003526 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003527 if( output_size < iv_length )
3528 {
3529 status = PSA_ERROR_BUFFER_TOO_SMALL;
3530 goto exit;
3531 }
3532
3533 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003534 if( status != PSA_SUCCESS )
3535 goto exit;
3536 }
3537
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003538 status = psa_driver_wrapper_cipher_encrypt(
3539 &attributes, slot->key.data, slot->key.bytes,
3540 alg, input, input_length,
3541 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003542
3543exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003544 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003545
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003546 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003547}
3548
3549psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3550 psa_algorithm_t alg,
3551 const uint8_t *input,
3552 size_t input_length,
3553 uint8_t *output,
3554 size_t output_size,
3555 size_t *output_length )
3556{
3557 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003558 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3559 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003560
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003561 *output_length = 0;
3562
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003563 if( ! PSA_ALG_IS_CIPHER( alg ) )
3564 return( PSA_ERROR_INVALID_ARGUMENT );
3565
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003566 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3567 PSA_KEY_USAGE_DECRYPT,
3568 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003569 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003570 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003571
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003572 psa_key_attributes_t attributes = {
3573 .core = slot->attr
3574 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003575
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003576 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3577 {
3578 status = PSA_ERROR_INVALID_ARGUMENT;
3579 goto exit;
3580 }
3581
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003582 status = psa_driver_wrapper_cipher_decrypt(
3583 &attributes, slot->key.data, slot->key.bytes,
3584 alg, input, input_length,
3585 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003586
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003587exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003588 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003589
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003590 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003591}
3592
3593
mohammad16035955c982018-04-26 00:53:03 +03003594/****************************************************************/
3595/* AEAD */
3596/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003597
Ronald Croncf56a0a2020-08-04 09:51:30 +02003598psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003599 psa_algorithm_t alg,
3600 const uint8_t *nonce,
3601 size_t nonce_length,
3602 const uint8_t *additional_data,
3603 size_t additional_data_length,
3604 const uint8_t *plaintext,
3605 size_t plaintext_length,
3606 uint8_t *ciphertext,
3607 size_t ciphertext_size,
3608 size_t *ciphertext_length )
3609{
Ronald Cron215633c2021-03-16 17:15:37 +01003610 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3611 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003612
mohammad1603f08a5502018-06-03 15:05:47 +03003613 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003614
Steven Cooremanea7ab132021-03-17 16:28:00 +01003615 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3616 return( PSA_ERROR_NOT_SUPPORTED );
3617
Ronald Cron9a986162021-03-26 12:40:07 +01003618 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003619 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003620 if( status != PSA_SUCCESS )
3621 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003622
Ronald Cron215633c2021-03-16 17:15:37 +01003623 psa_key_attributes_t attributes = {
3624 .core = slot->attr
3625 };
mohammad16035955c982018-04-26 00:53:03 +03003626
Ronald Cronde822812021-03-17 16:08:20 +01003627 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003628 &attributes, slot->key.data, slot->key.bytes,
3629 alg,
3630 nonce, nonce_length,
3631 additional_data, additional_data_length,
3632 plaintext, plaintext_length,
3633 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003634
Gilles Peskineedf9a652018-08-17 18:11:56 +02003635 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3636 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003637
Ronald Cron9f310172021-03-16 16:36:37 +01003638 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003639
mohammad16035955c982018-04-26 00:53:03 +03003640 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003641}
3642
Ronald Croncf56a0a2020-08-04 09:51:30 +02003643psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003644 psa_algorithm_t alg,
3645 const uint8_t *nonce,
3646 size_t nonce_length,
3647 const uint8_t *additional_data,
3648 size_t additional_data_length,
3649 const uint8_t *ciphertext,
3650 size_t ciphertext_length,
3651 uint8_t *plaintext,
3652 size_t plaintext_size,
3653 size_t *plaintext_length )
3654{
Ronald Cron215633c2021-03-16 17:15:37 +01003655 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3656 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003657
Gilles Peskineee652a32018-06-01 19:23:52 +02003658 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003659
Steven Cooremanea7ab132021-03-17 16:28:00 +01003660 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3661 return( PSA_ERROR_NOT_SUPPORTED );
3662
Ronald Cron9a986162021-03-26 12:40:07 +01003663 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003664 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003665 if( status != PSA_SUCCESS )
3666 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003667
Ronald Cron215633c2021-03-16 17:15:37 +01003668 psa_key_attributes_t attributes = {
3669 .core = slot->attr
3670 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003671
Ronald Cronde822812021-03-17 16:08:20 +01003672 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003673 &attributes, slot->key.data, slot->key.bytes,
3674 alg,
3675 nonce, nonce_length,
3676 additional_data, additional_data_length,
3677 ciphertext, ciphertext_length,
3678 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003679
Gilles Peskineedf9a652018-08-17 18:11:56 +02003680 if( status != PSA_SUCCESS && plaintext_size != 0 )
3681 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003682
Ronald Cron215633c2021-03-16 17:15:37 +01003683 psa_unlock_key_slot( slot );
3684
Gilles Peskineedf9a652018-08-17 18:11:56 +02003685 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003686}
3687
Gilles Peskinee59236f2018-01-27 23:32:46 +01003688/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003689/* Generators */
3690/****************************************************************/
3691
John Durkop07cc04a2020-11-16 22:08:34 -08003692#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3693 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3694 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3695#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003696#endif /* At least one builtin KDF */
3697
3698#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3699 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3700 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3701static psa_status_t psa_key_derivation_start_hmac(
3702 psa_mac_operation_t *operation,
3703 psa_algorithm_t hash_alg,
3704 const uint8_t *hmac_key,
3705 size_t hmac_key_length )
3706{
3707 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3708 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3709 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3710 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3711 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3712
Steven Cooreman72f736a2021-05-07 14:14:37 +02003713 operation->is_sign = 1;
3714 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3715
Steven Cooreman094a77e2021-05-06 17:58:36 +02003716 status = psa_driver_wrapper_mac_sign_setup( operation,
3717 &attributes,
3718 hmac_key, hmac_key_length,
3719 PSA_ALG_HMAC( hash_alg ) );
3720
3721 psa_reset_key_attributes( &attributes );
3722 return( status );
3723}
3724#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003725
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003726#define HKDF_STATE_INIT 0 /* no input yet */
3727#define HKDF_STATE_STARTED 1 /* got salt */
3728#define HKDF_STATE_KEYED 2 /* got key */
3729#define HKDF_STATE_OUTPUT 3 /* output started */
3730
Gilles Peskinecbe66502019-05-16 16:59:18 +02003731static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003732 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003733{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003734 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3735 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003736 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003737 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003738}
3739
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003740psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003741{
3742 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003743 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003744 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003745 {
3746 /* The object has (apparently) been initialized but it is not
3747 * in use. It's ok to call abort on such an object, and there's
3748 * nothing to do. */
3749 }
3750 else
John Durkopd0321952020-10-29 21:37:36 -07003751#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003752 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003753 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003754 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003755 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003756 }
John Durkop07cc04a2020-11-16 22:08:34 -08003757 else
3758#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3759#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3760 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3761 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003762 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003763 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003764 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003765 if( operation->ctx.tls12_prf.secret != NULL )
3766 {
3767 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3768 operation->ctx.tls12_prf.secret_length );
3769 mbedtls_free( operation->ctx.tls12_prf.secret );
3770 }
3771
Janos Follath6a1d2622019-06-11 10:37:28 +01003772 if( operation->ctx.tls12_prf.seed != NULL )
3773 {
3774 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3775 operation->ctx.tls12_prf.seed_length );
3776 mbedtls_free( operation->ctx.tls12_prf.seed );
3777 }
3778
3779 if( operation->ctx.tls12_prf.label != NULL )
3780 {
3781 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3782 operation->ctx.tls12_prf.label_length );
3783 mbedtls_free( operation->ctx.tls12_prf.label );
3784 }
3785
Steven Cooremana6df6042021-04-29 19:32:25 +02003786 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003787
3788 /* We leave the fields Ai and output_block to be erased safely by the
3789 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003790 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003791 else
John Durkop07cc04a2020-11-16 22:08:34 -08003792#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3793 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003794 {
3795 status = PSA_ERROR_BAD_STATE;
3796 }
Janos Follath083036a2019-06-11 10:22:26 +01003797 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003798 return( status );
3799}
3800
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003801psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003802 size_t *capacity)
3803{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003804 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003805 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003806 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003807 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003808 }
3809
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003810 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003811 return( PSA_SUCCESS );
3812}
3813
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003814psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003815 size_t capacity )
3816{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003817 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003818 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003819 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003820 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003821 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003822 return( PSA_SUCCESS );
3823}
3824
John Durkopd0321952020-10-29 21:37:36 -07003825#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003826/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003827 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003828static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003829 psa_algorithm_t hash_alg,
3830 uint8_t *output,
3831 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003832{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003833 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003834 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003835 psa_status_t status;
3836
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003837 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3838 return( PSA_ERROR_BAD_STATE );
3839 hkdf->state = HKDF_STATE_OUTPUT;
3840
Gilles Peskinebef7f142018-07-12 17:22:21 +02003841 while( output_length != 0 )
3842 {
3843 /* Copy what remains of the current block */
3844 uint8_t n = hash_length - hkdf->offset_in_block;
3845 if( n > output_length )
3846 n = (uint8_t) output_length;
3847 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3848 output += n;
3849 output_length -= n;
3850 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003851 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003852 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003853 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003854 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003855 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003856 * object was corrupted or if this function is called directly
3857 * inside the library. */
3858 if( hkdf->block_number == 0xff )
3859 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003860
3861 /* We need a new block */
3862 ++hkdf->block_number;
3863 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003864
Steven Cooreman094a77e2021-05-06 17:58:36 +02003865 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3866 hash_alg,
3867 hkdf->prk,
3868 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003869 if( status != PSA_SUCCESS )
3870 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003871
Gilles Peskinebef7f142018-07-12 17:22:21 +02003872 if( hkdf->block_number != 1 )
3873 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003874 status = psa_mac_update( &hkdf->hmac,
3875 hkdf->output_block,
3876 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003877 if( status != PSA_SUCCESS )
3878 return( status );
3879 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003880 status = psa_mac_update( &hkdf->hmac,
3881 hkdf->info,
3882 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003883 if( status != PSA_SUCCESS )
3884 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003885 status = psa_mac_update( &hkdf->hmac,
3886 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003887 if( status != PSA_SUCCESS )
3888 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003889 status = psa_mac_sign_finish( &hkdf->hmac,
3890 hkdf->output_block,
3891 sizeof( hkdf->output_block ),
3892 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003893 if( status != PSA_SUCCESS )
3894 return( status );
3895 }
3896
3897 return( PSA_SUCCESS );
3898}
John Durkop07cc04a2020-11-16 22:08:34 -08003899#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003900
John Durkop07cc04a2020-11-16 22:08:34 -08003901#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3902 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003903static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3904 psa_tls12_prf_key_derivation_t *tls12_prf,
3905 psa_algorithm_t alg )
3906{
3907 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003908 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003909 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3910 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003911 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003912
Janos Follath7742fee2019-06-17 12:58:10 +01003913 /* We can't be wanting more output after block 0xff, otherwise
3914 * the capacity check in psa_key_derivation_output_bytes() would have
3915 * prevented this call. It could happen only if the operation
3916 * object was corrupted or if this function is called directly
3917 * inside the library. */
3918 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003919 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003920
3921 /* We need a new block */
3922 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003923 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003924
3925 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3926 *
3927 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3928 *
3929 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3930 * HMAC_hash(secret, A(2) + seed) +
3931 * HMAC_hash(secret, A(3) + seed) + ...
3932 *
3933 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003934 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003935 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003936 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003937 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003938 * is currently extracted as `output_block` and where i is
3939 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003940 */
3941
Steven Cooreman094a77e2021-05-06 17:58:36 +02003942 status = psa_key_derivation_start_hmac( &hmac,
3943 hash_alg,
3944 tls12_prf->secret,
3945 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003946 if( status != PSA_SUCCESS )
3947 goto cleanup;
3948
3949 /* Calculate A(i) where i = tls12_prf->block_number. */
3950 if( tls12_prf->block_number == 1 )
3951 {
3952 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3953 * the variable seed and in this instance means it in the context of the
3954 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003955 status = psa_mac_update( &hmac,
3956 tls12_prf->label,
3957 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003958 if( status != PSA_SUCCESS )
3959 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003960 status = psa_mac_update( &hmac,
3961 tls12_prf->seed,
3962 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003963 if( status != PSA_SUCCESS )
3964 goto cleanup;
3965 }
3966 else
3967 {
3968 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003969 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003970 if( status != PSA_SUCCESS )
3971 goto cleanup;
3972 }
3973
Steven Cooremana6df6042021-04-29 19:32:25 +02003974 status = psa_mac_sign_finish( &hmac,
3975 tls12_prf->Ai, hash_length,
3976 &hmac_output_length );
3977 if( hmac_output_length != hash_length )
3978 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003979 if( status != PSA_SUCCESS )
3980 goto cleanup;
3981
3982 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003983 status = psa_key_derivation_start_hmac( &hmac,
3984 hash_alg,
3985 tls12_prf->secret,
3986 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003987 if( status != PSA_SUCCESS )
3988 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003989 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003990 if( status != PSA_SUCCESS )
3991 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003992 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003993 if( status != PSA_SUCCESS )
3994 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003995 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003996 if( status != PSA_SUCCESS )
3997 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003998 status = psa_mac_sign_finish( &hmac,
3999 tls12_prf->output_block, hash_length,
4000 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004001 if( status != PSA_SUCCESS )
4002 goto cleanup;
4003
Janos Follath7742fee2019-06-17 12:58:10 +01004004
4005cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004006 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004007 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4008 status = cleanup_status;
4009
4010 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004011}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004012
Janos Follath844eb0e2019-06-19 12:10:49 +01004013static psa_status_t psa_key_derivation_tls12_prf_read(
4014 psa_tls12_prf_key_derivation_t *tls12_prf,
4015 psa_algorithm_t alg,
4016 uint8_t *output,
4017 size_t output_length )
4018{
4019 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004020 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004021 psa_status_t status;
4022 uint8_t offset, length;
4023
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004024 switch( tls12_prf->state )
4025 {
4026 case PSA_TLS12_PRF_STATE_LABEL_SET:
4027 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4028 break;
4029 case PSA_TLS12_PRF_STATE_OUTPUT:
4030 break;
4031 default:
4032 return( PSA_ERROR_BAD_STATE );
4033 }
4034
Janos Follath844eb0e2019-06-19 12:10:49 +01004035 while( output_length != 0 )
4036 {
4037 /* Check if we have fully processed the current block. */
4038 if( tls12_prf->left_in_block == 0 )
4039 {
4040 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4041 alg );
4042 if( status != PSA_SUCCESS )
4043 return( status );
4044
4045 continue;
4046 }
4047
4048 if( tls12_prf->left_in_block > output_length )
4049 length = (uint8_t) output_length;
4050 else
4051 length = tls12_prf->left_in_block;
4052
4053 offset = hash_length - tls12_prf->left_in_block;
4054 memcpy( output, tls12_prf->output_block + offset, length );
4055 output += length;
4056 output_length -= length;
4057 tls12_prf->left_in_block -= length;
4058 }
4059
4060 return( PSA_SUCCESS );
4061}
John Durkop07cc04a2020-11-16 22:08:34 -08004062#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4063 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004064
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004065psa_status_t psa_key_derivation_output_bytes(
4066 psa_key_derivation_operation_t *operation,
4067 uint8_t *output,
4068 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004069{
4070 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004071 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004072
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004073 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004074 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004075 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004076 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004077 }
4078
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004079 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004080 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004081 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004082 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004083 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004084 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004085 goto exit;
4086 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004087 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004088 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004089 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004090 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004091 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4092 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004093 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004094 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004095 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004096 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004097 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004098
John Durkopd0321952020-10-29 21:37:36 -07004099#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004100 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004101 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004102 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004103 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004104 output, output_length );
4105 }
Janos Follathadbec812019-06-14 11:05:39 +01004106 else
John Durkop07cc04a2020-11-16 22:08:34 -08004107#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4108#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4109 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004110 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004111 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004112 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004113 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004114 kdf_alg, output,
4115 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004116 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004117 else
John Durkop07cc04a2020-11-16 22:08:34 -08004118#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4119 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004120 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004121 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004122 return( PSA_ERROR_BAD_STATE );
4123 }
4124
4125exit:
4126 if( status != PSA_SUCCESS )
4127 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004128 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004129 * This allows us to differentiate between exhausted operations and
4130 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4131 * operations. */
4132 psa_algorithm_t alg = operation->alg;
4133 psa_key_derivation_abort( operation );
4134 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004135 memset( output, '!', output_length );
4136 }
4137 return( status );
4138}
4139
David Brown7807bf72021-02-09 16:28:23 -07004140#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004141static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4142{
4143 if( data_size >= 8 )
4144 mbedtls_des_key_set_parity( data );
4145 if( data_size >= 16 )
4146 mbedtls_des_key_set_parity( data + 8 );
4147 if( data_size >= 24 )
4148 mbedtls_des_key_set_parity( data + 16 );
4149}
David Brown7807bf72021-02-09 16:28:23 -07004150#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004151
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004152static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004153 psa_key_slot_t *slot,
4154 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004155 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004156{
4157 uint8_t *data = NULL;
4158 size_t bytes = PSA_BITS_TO_BYTES( bits );
4159 psa_status_t status;
4160
Gilles Peskine8e338702019-07-30 20:06:31 +02004161 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004162 return( PSA_ERROR_INVALID_ARGUMENT );
4163 if( bits % 8 != 0 )
4164 return( PSA_ERROR_INVALID_ARGUMENT );
4165 data = mbedtls_calloc( 1, bytes );
4166 if( data == NULL )
4167 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4168
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004169 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004170 if( status != PSA_SUCCESS )
4171 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004172#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004173 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004174 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004175#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004176
4177 status = psa_allocate_buffer_to_slot( slot, bytes );
4178 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004179 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004180
Ronald Cronbf33c932020-11-28 18:06:53 +01004181 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004182 psa_key_attributes_t attributes = {
4183 .core = slot->attr
4184 };
4185
Ronald Cronbf33c932020-11-28 18:06:53 +01004186 status = psa_driver_wrapper_import_key( &attributes,
4187 data, bytes,
4188 slot->key.data,
4189 slot->key.bytes,
4190 &slot->key.bytes, &bits );
4191 if( bits != slot->attr.bits )
4192 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004193
4194exit:
4195 mbedtls_free( data );
4196 return( status );
4197}
4198
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004199psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004200 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004201 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004202{
4203 psa_status_t status;
4204 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004205 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004206
Ronald Cron81709fc2020-11-14 12:10:32 +01004207 *key = MBEDTLS_SVC_KEY_ID_INIT;
4208
Gilles Peskine0f84d622019-09-12 19:03:13 +02004209 /* Reject any attempt to create a zero-length key so that we don't
4210 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4211 if( psa_get_key_bits( attributes ) == 0 )
4212 return( PSA_ERROR_INVALID_ARGUMENT );
4213
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004214 if( ! operation->can_output_key )
4215 return( PSA_ERROR_NOT_PERMITTED );
4216
Ronald Cron81709fc2020-11-14 12:10:32 +01004217 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4218 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004219#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4220 if( driver != NULL )
4221 {
4222 /* Deriving a key in a secure element is not implemented yet. */
4223 status = PSA_ERROR_NOT_SUPPORTED;
4224 }
4225#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004226 if( status == PSA_SUCCESS )
4227 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004228 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004229 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004230 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004231 }
4232 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004233 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004234 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004235 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004236
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004237 return( status );
4238}
4239
Gilles Peskineeab56e42018-07-12 17:12:33 +02004240
4241
4242/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004243/* Key derivation */
4244/****************************************************************/
4245
Steven Cooreman932ffb72021-02-15 12:14:32 +01004246#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004247static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004248 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004249 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004250{
John Durkop07cc04a2020-11-16 22:08:34 -08004251 int is_kdf_alg_supported;
4252
Janos Follath5fe19732019-06-20 15:09:30 +01004253 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4254 * initialisers for this union leave some bytes unspecified.) */
4255 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4256
Gilles Peskine969c5d62019-01-16 15:53:06 +01004257 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004258#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004259 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4260 is_kdf_alg_supported = 1;
4261 else
4262#endif
4263#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4264 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4265 is_kdf_alg_supported = 1;
4266 else
4267#endif
4268#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4269 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4270 is_kdf_alg_supported = 1;
4271 else
4272#endif
4273 is_kdf_alg_supported = 0;
4274
4275 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004276 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004277 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004278 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004279 if( hash_size == 0 )
4280 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004281 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4282 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004283 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004284 {
4285 return( PSA_ERROR_NOT_SUPPORTED );
4286 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004287 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004288 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004289 }
John Durkop07cc04a2020-11-16 22:08:34 -08004290
4291 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004292}
John Durkop07cc04a2020-11-16 22:08:34 -08004293#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004294
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004295psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004296 psa_algorithm_t alg )
4297{
4298 psa_status_t status;
4299
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004300 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004301 return( PSA_ERROR_BAD_STATE );
4302
Gilles Peskine6843c292019-01-18 16:44:49 +01004303 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4304 return( PSA_ERROR_INVALID_ARGUMENT );
4305 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004306 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004307#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004308 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004309 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004310#else
4311 return( PSA_ERROR_NOT_SUPPORTED );
4312#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004313 }
4314 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4315 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004316#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004317 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004318#else
4319 return( PSA_ERROR_NOT_SUPPORTED );
4320#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004321 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004322 else
4323 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004324
4325 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004326 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004327 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004328}
4329
John Durkopd0321952020-10-29 21:37:36 -07004330#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004331static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004332 psa_algorithm_t hash_alg,
4333 psa_key_derivation_step_t step,
4334 const uint8_t *data,
4335 size_t data_length )
4336{
4337 psa_status_t status;
4338 switch( step )
4339 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004340 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004341 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004342 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004343 else
4344 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004345 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4346 hash_alg,
4347 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004348 if( status != PSA_SUCCESS )
4349 return( status );
4350 hkdf->state = HKDF_STATE_STARTED;
4351 return( PSA_SUCCESS );
4352 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004353 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004354 /* If no salt was provided, use an empty salt. */
4355 if( hkdf->state == HKDF_STATE_INIT )
4356 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004357 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4358 hash_alg,
4359 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004360 if( status != PSA_SUCCESS )
4361 return( status );
4362 hkdf->state = HKDF_STATE_STARTED;
4363 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004364 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004365 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004366 status = psa_mac_update( &hkdf->hmac,
4367 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004368 if( status != PSA_SUCCESS )
4369 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004370 status = psa_mac_sign_finish( &hkdf->hmac,
4371 hkdf->prk,
4372 sizeof( hkdf->prk ),
4373 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004374 if( status != PSA_SUCCESS )
4375 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004376 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004377 hkdf->block_number = 0;
4378 hkdf->state = HKDF_STATE_KEYED;
4379 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004380 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004381 if( hkdf->state == HKDF_STATE_OUTPUT )
4382 return( PSA_ERROR_BAD_STATE );
4383 if( hkdf->info_set )
4384 return( PSA_ERROR_BAD_STATE );
4385 hkdf->info_length = data_length;
4386 if( data_length != 0 )
4387 {
4388 hkdf->info = mbedtls_calloc( 1, data_length );
4389 if( hkdf->info == NULL )
4390 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4391 memcpy( hkdf->info, data, data_length );
4392 }
4393 hkdf->info_set = 1;
4394 return( PSA_SUCCESS );
4395 default:
4396 return( PSA_ERROR_INVALID_ARGUMENT );
4397 }
4398}
John Durkop07cc04a2020-11-16 22:08:34 -08004399#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004400
John Durkop07cc04a2020-11-16 22:08:34 -08004401#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4402 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004403static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4404 const uint8_t *data,
4405 size_t data_length )
4406{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004407 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004408 return( PSA_ERROR_BAD_STATE );
4409
Janos Follathd6dce9f2019-07-04 09:11:38 +01004410 if( data_length != 0 )
4411 {
4412 prf->seed = mbedtls_calloc( 1, data_length );
4413 if( prf->seed == NULL )
4414 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004415
Janos Follathd6dce9f2019-07-04 09:11:38 +01004416 memcpy( prf->seed, data, data_length );
4417 prf->seed_length = data_length;
4418 }
Janos Follathf08e2652019-06-13 09:05:41 +01004419
Gilles Peskine43f958b2020-12-13 14:55:14 +01004420 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004421
4422 return( PSA_SUCCESS );
4423}
4424
Janos Follath81550542019-06-13 14:26:34 +01004425static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004426 const uint8_t *data,
4427 size_t data_length )
4428{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004429 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004430 return( PSA_ERROR_BAD_STATE );
4431
Steven Cooremana6df6042021-04-29 19:32:25 +02004432 if( data_length != 0 )
4433 {
4434 prf->secret = mbedtls_calloc( 1, data_length );
4435 if( prf->secret == NULL )
4436 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4437
4438 memcpy( prf->secret, data, data_length );
4439 prf->secret_length = data_length;
4440 }
Janos Follath81550542019-06-13 14:26:34 +01004441
Gilles Peskine43f958b2020-12-13 14:55:14 +01004442 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004443
4444 return( PSA_SUCCESS );
4445}
4446
Janos Follath63028dd2019-06-13 09:15:47 +01004447static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4448 const uint8_t *data,
4449 size_t data_length )
4450{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004451 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004452 return( PSA_ERROR_BAD_STATE );
4453
Janos Follathd6dce9f2019-07-04 09:11:38 +01004454 if( data_length != 0 )
4455 {
4456 prf->label = mbedtls_calloc( 1, data_length );
4457 if( prf->label == NULL )
4458 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004459
Janos Follathd6dce9f2019-07-04 09:11:38 +01004460 memcpy( prf->label, data, data_length );
4461 prf->label_length = data_length;
4462 }
Janos Follath63028dd2019-06-13 09:15:47 +01004463
Gilles Peskine43f958b2020-12-13 14:55:14 +01004464 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004465
4466 return( PSA_SUCCESS );
4467}
4468
Janos Follathb03233e2019-06-11 15:30:30 +01004469static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004470 psa_key_derivation_step_t step,
4471 const uint8_t *data,
4472 size_t data_length )
4473{
Janos Follathb03233e2019-06-11 15:30:30 +01004474 switch( step )
4475 {
Janos Follathf08e2652019-06-13 09:05:41 +01004476 case PSA_KEY_DERIVATION_INPUT_SEED:
4477 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004478 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004479 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004480 case PSA_KEY_DERIVATION_INPUT_LABEL:
4481 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004482 default:
4483 return( PSA_ERROR_INVALID_ARGUMENT );
4484 }
4485}
John Durkop07cc04a2020-11-16 22:08:34 -08004486#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4487 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4488
4489#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4490static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4491 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004492 const uint8_t *data,
4493 size_t data_length )
4494{
4495 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004496 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004497 uint8_t *cur = pms;
4498
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004499 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004500 return( PSA_ERROR_INVALID_ARGUMENT );
4501
4502 /* Quoting RFC 4279, Section 2:
4503 *
4504 * The premaster secret is formed as follows: if the PSK is N octets
4505 * long, concatenate a uint16 with the value N, N zero octets, a second
4506 * uint16 with the value N, and the PSK itself.
4507 */
4508
4509 *cur++ = ( data_length >> 8 ) & 0xff;
4510 *cur++ = ( data_length >> 0 ) & 0xff;
4511 memset( cur, 0, data_length );
4512 cur += data_length;
4513 *cur++ = pms[0];
4514 *cur++ = pms[1];
4515 memcpy( cur, data, data_length );
4516 cur += data_length;
4517
Steven Cooremana6df6042021-04-29 19:32:25 +02004518 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004519
4520 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4521 return( status );
4522}
Janos Follath6660f0e2019-06-17 08:44:03 +01004523
4524static psa_status_t psa_tls12_prf_psk_to_ms_input(
4525 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004526 psa_key_derivation_step_t step,
4527 const uint8_t *data,
4528 size_t data_length )
4529{
4530 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004531 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004532 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004533 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004534 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004535
Steven Cooremana6df6042021-04-29 19:32:25 +02004536 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004537}
John Durkop07cc04a2020-11-16 22:08:34 -08004538#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004539
Gilles Peskineb8965192019-09-24 16:21:10 +02004540/** Check whether the given key type is acceptable for the given
4541 * input step of a key derivation.
4542 *
4543 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4544 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4545 * Both secret and non-secret inputs can alternatively have the type
4546 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4547 * that the input was passed as a buffer rather than via a key object.
4548 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004549static int psa_key_derivation_check_input_type(
4550 psa_key_derivation_step_t step,
4551 psa_key_type_t key_type )
4552{
4553 switch( step )
4554 {
4555 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004556 if( key_type == PSA_KEY_TYPE_DERIVE )
4557 return( PSA_SUCCESS );
4558 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004559 return( PSA_SUCCESS );
4560 break;
4561 case PSA_KEY_DERIVATION_INPUT_LABEL:
4562 case PSA_KEY_DERIVATION_INPUT_SALT:
4563 case PSA_KEY_DERIVATION_INPUT_INFO:
4564 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004565 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4566 return( PSA_SUCCESS );
4567 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004568 return( PSA_SUCCESS );
4569 break;
4570 }
4571 return( PSA_ERROR_INVALID_ARGUMENT );
4572}
4573
Janos Follathb80a94e2019-06-12 15:54:46 +01004574static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004575 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004576 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004577 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004578 const uint8_t *data,
4579 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004580{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004581 psa_status_t status;
4582 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4583
4584 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004585 if( status != PSA_SUCCESS )
4586 goto exit;
4587
John Durkopd0321952020-10-29 21:37:36 -07004588#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004589 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004590 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004591 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004592 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004593 step, data, data_length );
4594 }
John Durkop07cc04a2020-11-16 22:08:34 -08004595 else
4596#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4597#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4598 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004599 {
Janos Follathb03233e2019-06-11 15:30:30 +01004600 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004601 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004602 }
John Durkop07cc04a2020-11-16 22:08:34 -08004603 else
4604#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4605#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4606 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004607 {
4608 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004609 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004610 }
4611 else
John Durkop07cc04a2020-11-16 22:08:34 -08004612#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004613 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004614 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004615 (void) data;
4616 (void) data_length;
4617 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004618 return( PSA_ERROR_BAD_STATE );
4619 }
4620
Gilles Peskine224b0d62019-09-23 18:13:17 +02004621exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004622 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004623 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004624 return( status );
4625}
4626
Janos Follath51f4a0f2019-06-14 11:35:55 +01004627psa_status_t psa_key_derivation_input_bytes(
4628 psa_key_derivation_operation_t *operation,
4629 psa_key_derivation_step_t step,
4630 const uint8_t *data,
4631 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004632{
Gilles Peskineb8965192019-09-24 16:21:10 +02004633 return( psa_key_derivation_input_internal( operation, step,
4634 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004635 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004636}
4637
Janos Follath51f4a0f2019-06-14 11:35:55 +01004638psa_status_t psa_key_derivation_input_key(
4639 psa_key_derivation_operation_t *operation,
4640 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004641 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004642{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004644 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004645 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004646
Ronald Cron5c522922020-11-14 16:35:34 +01004647 status = psa_get_and_lock_transparent_key_slot_with_policy(
4648 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004649 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004650 {
4651 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004652 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004653 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004654
4655 /* Passing a key object as a SECRET input unlocks the permission
4656 * to output to a key object. */
4657 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4658 operation->can_output_key = 1;
4659
Ronald Cronf95a2b12020-10-22 15:24:49 +02004660 status = psa_key_derivation_input_internal( operation,
4661 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004662 slot->key.data,
4663 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004664
Ronald Cron5c522922020-11-14 16:35:34 +01004665 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004666
Ronald Cron5c522922020-11-14 16:35:34 +01004667 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004668}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004669
4670
4671
4672/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004673/* Key agreement */
4674/****************************************************************/
4675
John Durkop6ba40d12020-11-10 08:50:04 -08004676#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004677static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4678 size_t peer_key_length,
4679 const mbedtls_ecp_keypair *our_key,
4680 uint8_t *shared_secret,
4681 size_t shared_secret_size,
4682 size_t *shared_secret_length )
4683{
Steven Cooremand4867872020-08-05 16:31:39 +02004684 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004685 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004686 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004687 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004688 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004689 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004690
Ronald Cron90857082020-11-25 14:58:33 +01004691 status = mbedtls_psa_ecp_load_representation(
4692 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004693 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004694 peer_key,
4695 peer_key_length,
4696 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004697 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004698 goto exit;
4699
Jaeden Amero97271b32019-01-10 19:38:51 +00004700 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004701 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004702 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004703 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004704 status = mbedtls_to_psa_error(
4705 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4706 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004707 goto exit;
4708
Jaeden Amero97271b32019-01-10 19:38:51 +00004709 status = mbedtls_to_psa_error(
4710 mbedtls_ecdh_calc_secret( &ecdh,
4711 shared_secret_length,
4712 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004713 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004714 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004715 if( status != PSA_SUCCESS )
4716 goto exit;
4717 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4718 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004719
4720exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004721 if( status != PSA_SUCCESS )
4722 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004723 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004724 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004725 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004726
Jaeden Amero97271b32019-01-10 19:38:51 +00004727 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004728}
John Durkop6ba40d12020-11-10 08:50:04 -08004729#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004730
Gilles Peskine01d718c2018-09-18 12:01:02 +02004731#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4732
Gilles Peskine0216fe12019-04-11 21:23:21 +02004733static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4734 psa_key_slot_t *private_key,
4735 const uint8_t *peer_key,
4736 size_t peer_key_length,
4737 uint8_t *shared_secret,
4738 size_t shared_secret_size,
4739 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004740{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004741 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004742 {
John Durkop6ba40d12020-11-10 08:50:04 -08004743#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004744 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004745 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004746 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004747 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004748 psa_status_t status = mbedtls_psa_ecp_load_representation(
4749 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004750 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004751 private_key->key.data,
4752 private_key->key.bytes,
4753 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004754 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004755 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004756 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004757 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004758 shared_secret, shared_secret_size,
4759 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004760 mbedtls_ecp_keypair_free( ecp );
4761 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004762 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004763#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004764 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004765 (void) private_key;
4766 (void) peer_key;
4767 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004768 (void) shared_secret;
4769 (void) shared_secret_size;
4770 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004771 return( PSA_ERROR_NOT_SUPPORTED );
4772 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004773}
4774
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004775/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004776 * to potentially free embedded data structures and wipe confidential data.
4777 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004778static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004779 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004780 psa_key_slot_t *private_key,
4781 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004782 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004783{
4784 psa_status_t status;
4785 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4786 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004787 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004788
4789 /* Step 1: run the secret agreement algorithm to generate the shared
4790 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004791 status = psa_key_agreement_raw_internal( ka_alg,
4792 private_key,
4793 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004794 shared_secret,
4795 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004796 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004797 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004798 goto exit;
4799
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004800 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004801 * the shared secret. A shared secret is permitted wherever a key
4802 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004803 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004804 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004805 shared_secret,
4806 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004807exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004808 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004809 return( status );
4810}
4811
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004812psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004813 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004814 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004815 const uint8_t *peer_key,
4816 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004817{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004818 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004819 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004820 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004821
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004822 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004823 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004824 status = psa_get_and_lock_transparent_key_slot_with_policy(
4825 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004826 if( status != PSA_SUCCESS )
4827 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004828 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004829 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004830 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004831 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004832 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004833 else
4834 {
4835 /* If a private key has been added as SECRET, we allow the derived
4836 * key material to be used as a key in PSA Crypto. */
4837 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4838 operation->can_output_key = 1;
4839 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004840
Ronald Cron5c522922020-11-14 16:35:34 +01004841 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004842
Ronald Cron5c522922020-11-14 16:35:34 +01004843 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004844}
4845
Gilles Peskinebe697d82019-05-16 18:00:41 +02004846psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004847 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004848 const uint8_t *peer_key,
4849 size_t peer_key_length,
4850 uint8_t *output,
4851 size_t output_size,
4852 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004853{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004855 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004856 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004857
4858 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4859 {
4860 status = PSA_ERROR_INVALID_ARGUMENT;
4861 goto exit;
4862 }
Ronald Cron5c522922020-11-14 16:35:34 +01004863 status = psa_get_and_lock_transparent_key_slot_with_policy(
4864 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004865 if( status != PSA_SUCCESS )
4866 goto exit;
4867
4868 status = psa_key_agreement_raw_internal( alg, slot,
4869 peer_key, peer_key_length,
4870 output, output_size,
4871 output_length );
4872
4873exit:
4874 if( status != PSA_SUCCESS )
4875 {
4876 /* If an error happens and is not handled properly, the output
4877 * may be used as a key to protect sensitive data. Arrange for such
4878 * a key to be random, which is likely to result in decryption or
4879 * verification errors. This is better than filling the buffer with
4880 * some constant data such as zeros, which would result in the data
4881 * being protected with a reproducible, easily knowable key.
4882 */
4883 psa_generate_random( output, output_size );
4884 *output_length = output_size;
4885 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004886
Ronald Cron5c522922020-11-14 16:35:34 +01004887 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004888
Ronald Cron5c522922020-11-14 16:35:34 +01004889 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004890}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004891
4892
Gilles Peskine30524eb2020-11-13 17:02:26 +01004893
Gilles Peskine86a440b2018-11-12 18:39:40 +01004894/****************************************************************/
4895/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004896/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004897
Gilles Peskine30524eb2020-11-13 17:02:26 +01004898/** Initialize the PSA random generator.
4899 */
4900static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4901{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004902#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4903 memset( rng, 0, sizeof( *rng ) );
4904#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4905
Gilles Peskine30524eb2020-11-13 17:02:26 +01004906 /* Set default configuration if
4907 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4908 if( rng->entropy_init == NULL )
4909 rng->entropy_init = mbedtls_entropy_init;
4910 if( rng->entropy_free == NULL )
4911 rng->entropy_free = mbedtls_entropy_free;
4912
4913 rng->entropy_init( &rng->entropy );
4914#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4915 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4916 /* The PSA entropy injection feature depends on using NV seed as an entropy
4917 * source. Add NV seed as an entropy source for PSA entropy injection. */
4918 mbedtls_entropy_add_source( &rng->entropy,
4919 mbedtls_nv_seed_poll, NULL,
4920 MBEDTLS_ENTROPY_BLOCK_SIZE,
4921 MBEDTLS_ENTROPY_SOURCE_STRONG );
4922#endif
4923
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004924 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004925#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004926}
4927
4928/** Deinitialize the PSA random generator.
4929 */
4930static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4931{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004932#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4933 memset( rng, 0, sizeof( *rng ) );
4934#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004935 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004936 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004937#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004938}
4939
4940/** Seed the PSA random generator.
4941 */
4942static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4943{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004944#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4945 /* Do nothing: the external RNG seeds itself. */
4946 (void) rng;
4947 return( PSA_SUCCESS );
4948#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004949 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004950 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4951 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004952 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004953#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004954}
4955
Gilles Peskinee59236f2018-01-27 23:32:46 +01004956psa_status_t psa_generate_random( uint8_t *output,
4957 size_t output_size )
4958{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004959 GUARD_MODULE_INITIALIZED;
4960
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004961#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4962
4963 size_t output_length = 0;
4964 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4965 output, output_size,
4966 &output_length );
4967 if( status != PSA_SUCCESS )
4968 return( status );
4969 /* Breaking up a request into smaller chunks is currently not supported
4970 * for the extrernal RNG interface. */
4971 if( output_length != output_size )
4972 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4973 return( PSA_SUCCESS );
4974
4975#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4976
Gilles Peskine71ddab92021-01-04 21:01:07 +01004977 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004978 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004979 size_t request_size =
4980 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4981 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4982 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004983 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4984 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004985 if( ret != 0 )
4986 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004987 output_size -= request_size;
4988 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004989 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004990 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004991#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004992}
4993
Gilles Peskine8814fc42020-12-14 15:33:44 +01004994/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004995 *
4996 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4997 * `psa_generate_random(...)`. The state parameter is ignored since the
4998 * PSA API doesn't support passing an explicit state.
4999 *
5000 * In the non-external case, psa_generate_random() calls an
5001 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5002 * and semantics as mbedtls_psa_get_random(). As an optimization,
5003 * instead of doing this back-and-forth between the PSA API and the
5004 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5005 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005006 */
5007#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5008int mbedtls_psa_get_random( void *p_rng,
5009 unsigned char *output,
5010 size_t output_size )
5011{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005012 /* This function takes a pointer to the RNG state because that's what
5013 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5014 * its own state internally and doesn't let the caller access that state.
5015 * So we just ignore the state parameter, and in practice we'll pass
5016 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005017 (void) p_rng;
5018 psa_status_t status = psa_generate_random( output, output_size );
5019 if( status == PSA_SUCCESS )
5020 return( 0 );
5021 else
5022 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5023}
5024#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5025
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005026#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005027#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005028
Gilles Peskine7228da22019-07-15 11:06:15 +02005029psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005030 size_t seed_size )
5031{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005032 if( global_data.initialized )
5033 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005034
5035 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5036 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5037 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5038 return( PSA_ERROR_INVALID_ARGUMENT );
5039
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005040 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005041}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005042#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005043
Ronald Cron3772afe2021-02-08 16:10:05 +01005044/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005045 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005046 * \param type The key type
5047 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005048 *
5049 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005050 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005051 * \retval #PSA_ERROR_INVALID_ARGUMENT
5052 * The size in bits of the key is not valid.
5053 * \retval #PSA_ERROR_NOT_SUPPORTED
5054 * The type and/or the size in bits of the key or the combination of
5055 * the two is not supported.
5056 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005057static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5058 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005059{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005060 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005061
Gilles Peskinee59236f2018-01-27 23:32:46 +01005062 if( key_type_is_raw_bytes( type ) )
5063 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005064 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005065 if( status != PSA_SUCCESS )
5066 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005067 }
5068 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005069#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005070 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5071 {
5072 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5073 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005074
Ronald Cron01b2aba2020-10-05 09:42:02 +02005075 /* Accept only byte-aligned keys, for the same reasons as
5076 * in psa_import_rsa_key(). */
5077 if( bits % 8 != 0 )
5078 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005079 }
5080 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005081#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005082
Ronald Cron5c4d3862020-12-07 11:07:24 +01005083#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005084 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5085 {
Ronald Crond81ab562021-02-16 09:01:16 +01005086 /* To avoid empty block, return successfully here. */
5087 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005088 }
5089 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005090#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005091 {
5092 return( PSA_ERROR_NOT_SUPPORTED );
5093 }
5094
5095 return( PSA_SUCCESS );
5096}
5097
Ronald Cron55ed0592020-10-05 10:30:40 +02005098psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005099 const psa_key_attributes_t *attributes,
5100 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005101{
5102 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005103 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005104
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005105 if( ( attributes->domain_parameters == NULL ) &&
5106 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005107 return( PSA_ERROR_INVALID_ARGUMENT );
5108
Ronald Cron01b2aba2020-10-05 09:42:02 +02005109 if( key_type_is_raw_bytes( type ) )
5110 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005111 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005112 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005113 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005114
David Brown12ca5032021-02-11 11:02:00 -07005115#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005116 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005117 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005118#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005119 }
5120 else
5121
Jaeden Amero424fa932021-05-14 08:34:32 +01005122#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5123 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005124 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005125 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005126 return( mbedtls_psa_rsa_generate_key( attributes,
5127 key_buffer,
5128 key_buffer_size,
5129 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005130 }
5131 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005132#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5133 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005134
John Durkop9814fa22020-11-04 12:28:15 -08005135#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005136 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005137 {
Ronald Cron7023db52020-11-20 18:17:42 +01005138 return( mbedtls_psa_ecp_generate_key( attributes,
5139 key_buffer,
5140 key_buffer_size,
5141 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005142 }
5143 else
John Durkop9814fa22020-11-04 12:28:15 -08005144#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005145 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005146 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005147 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005148 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005149
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005150 return( PSA_SUCCESS );
5151}
Darryl Green0c6575a2018-11-07 16:05:30 +00005152
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005153psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005154 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005155{
5156 psa_status_t status;
5157 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005158 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005159 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005160
Ronald Cron81709fc2020-11-14 12:10:32 +01005161 *key = MBEDTLS_SVC_KEY_ID_INIT;
5162
Gilles Peskine0f84d622019-09-12 19:03:13 +02005163 /* Reject any attempt to create a zero-length key so that we don't
5164 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5165 if( psa_get_key_bits( attributes ) == 0 )
5166 return( PSA_ERROR_INVALID_ARGUMENT );
5167
Ronald Cron81709fc2020-11-14 12:10:32 +01005168 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5169 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005170 if( status != PSA_SUCCESS )
5171 goto exit;
5172
Ronald Cron977c2472020-10-13 08:32:21 +02005173 /* In the case of a transparent key or an opaque key stored in local
5174 * storage (thus not in the case of generating a key in a secure element
5175 * or cryptoprocessor with storage), we have to allocate a buffer to
5176 * hold the generated key material. */
5177 if( slot->key.data == NULL )
5178 {
5179 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5180 PSA_KEY_LOCATION_LOCAL_STORAGE )
5181 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005182 status = psa_validate_key_type_and_size_for_key_generation(
5183 attributes->core.type, attributes->core.bits );
5184 if( status != PSA_SUCCESS )
5185 goto exit;
5186
5187 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5188 attributes->core.type,
5189 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005190 }
5191 else
5192 {
5193 status = psa_driver_wrapper_get_key_buffer_size(
5194 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005195 if( status != PSA_SUCCESS )
5196 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005197 }
Ronald Cron977c2472020-10-13 08:32:21 +02005198
5199 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5200 if( status != PSA_SUCCESS )
5201 goto exit;
5202 }
5203
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005204 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005205 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005206
Ronald Cron2b56bc82020-10-05 10:02:26 +02005207 if( status != PSA_SUCCESS )
5208 psa_remove_key_data_from_memory( slot );
5209
Gilles Peskine11792082019-08-06 18:36:36 +02005210exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005211 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005212 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005213 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005214 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005215
Darryl Green0c6575a2018-11-07 16:05:30 +00005216 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005217}
5218
Gilles Peskinee59236f2018-01-27 23:32:46 +01005219/****************************************************************/
5220/* Module setup */
5221/****************************************************************/
5222
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005223#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005224psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5225 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5226 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5227{
5228 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5229 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005230 global_data.rng.entropy_init = entropy_init;
5231 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005232 return( PSA_SUCCESS );
5233}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005234#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005235
Gilles Peskinee59236f2018-01-27 23:32:46 +01005236void mbedtls_psa_crypto_free( void )
5237{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005238 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005239 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5240 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005241 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005242 }
5243 /* Wipe all remaining data, including configuration.
5244 * In particular, this sets all state indicator to the value
5245 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005246 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005247#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005248 /* Unregister all secure element drivers, so that we restart from
5249 * a pristine state. */
5250 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005251#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005252}
5253
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005254#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5255/** Recover a transaction that was interrupted by a power failure.
5256 *
5257 * This function is called during initialization, before psa_crypto_init()
5258 * returns. If this function returns a failure status, the initialization
5259 * fails.
5260 */
5261static psa_status_t psa_crypto_recover_transaction(
5262 const psa_crypto_transaction_t *transaction )
5263{
5264 switch( transaction->unknown.type )
5265 {
5266 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5267 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005268 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005269 * is implemented.
5270 * https://github.com/ARMmbed/mbed-crypto/issues/218
5271 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005272 default:
5273 /* We found an unsupported transaction in the storage.
5274 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005275 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005276 }
5277}
5278#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5279
Gilles Peskinee59236f2018-01-27 23:32:46 +01005280psa_status_t psa_crypto_init( void )
5281{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005282 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005283
Gilles Peskinec6b69072018-11-20 21:42:52 +01005284 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005285 if( global_data.initialized != 0 )
5286 return( PSA_SUCCESS );
5287
Gilles Peskine30524eb2020-11-13 17:02:26 +01005288 /* Initialize and seed the random generator. */
5289 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005290 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005291 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005292 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005293 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005294 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005295
Gilles Peskine66fb1262018-12-10 16:29:04 +01005296 status = psa_initialize_key_slots( );
5297 if( status != PSA_SUCCESS )
5298 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005299
Gilles Peskined9348f22019-10-01 15:22:29 +02005300#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5301 status = psa_init_all_se_drivers( );
5302 if( status != PSA_SUCCESS )
5303 goto exit;
5304#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5305
Gilles Peskine4b734222019-07-24 15:56:31 +02005306#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005307 status = psa_crypto_load_transaction( );
5308 if( status == PSA_SUCCESS )
5309 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005310 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5311 if( status != PSA_SUCCESS )
5312 goto exit;
5313 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005314 }
5315 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5316 {
5317 /* There's no transaction to complete. It's all good. */
5318 status = PSA_SUCCESS;
5319 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005320#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005321
Gilles Peskinec6b69072018-11-20 21:42:52 +01005322 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005323 global_data.initialized = 1;
5324
5325exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005326 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005327 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005328 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005329}
5330
5331#endif /* MBEDTLS_PSA_CRYPTO_C */