blob: e57184919b68e7213ed0068e963fe48a5cf363bb [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
Ronald Cronddae0f52021-08-24 15:39:44 +0200947 * available, as opposed to a key in a secure element and/or to be used
948 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200949 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200950 * This is a temporary function that may be used instead of
951 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
952 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200953 *
Ronald Cron5c522922020-11-14 16:35:34 +0100954 * On success, the returned key slot is locked. It is the responsibility of the
955 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 */
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
Ronald Cronddae0f52021-08-24 15:39:44 +0200968 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
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}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200977
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200978psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000979{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100980 /* Data pointer will always be either a valid pointer or NULL in an
981 * initialized slot, so we can just free it. */
982 if( slot->key.data != NULL )
983 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
984
985 mbedtls_free( slot->key.data );
986 slot->key.data = NULL;
987 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000988
989 return( PSA_SUCCESS );
990}
991
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100992/** Completely wipe a slot in memory, including its policy.
993 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100994psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100995{
996 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100997
TRodziewicz18cddc02021-07-13 12:19:15 +0200998 /*
999 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +02001000 * do our best to report an unexpected lock counter. Assert with
1001 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1002 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1003 * function is called as part of the execution of a test suite, the
1004 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +02001005 */
Ronald Cron5c522922020-11-14 16:35:34 +01001006 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001007 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001008 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001009 status = PSA_ERROR_CORRUPTION_DETECTED;
1010 }
1011
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001012 /* Multipart operations may still be using the key. This is safe
1013 * because all multipart operation objects are independent from
1014 * the key slot: if they need to access the key after the setup
1015 * phase, they have a copy of the key. Note that this means that
1016 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001017 /* At this point, key material and other type-specific content has
1018 * been wiped. Clear remaining metadata. We can call memset and not
1019 * zeroize because the metadata is not particularly sensitive. */
1020 memset( slot, 0, sizeof( *slot ) );
1021 return( status );
1022}
1023
Ronald Croncf56a0a2020-08-04 09:51:30 +02001024psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001026 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001027 psa_status_t status; /* status of the last operation */
1028 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001029#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1030 psa_se_drv_table_entry_t *driver;
1031#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001032
Ronald Croncf56a0a2020-08-04 09:51:30 +02001033 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001034 return( PSA_SUCCESS );
1035
Ronald Cronf2911112020-10-29 17:51:10 +01001036 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001037 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001038 * key, this will load the key description from persistent memory if not
1039 * done yet. We cannot avoid this loading as without it we don't know if
1040 * the key is operated by an SE or not and this information is needed by
1041 * the current implementation.
1042 */
Ronald Cron5c522922020-11-14 16:35:34 +01001043 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001044 if( status != PSA_SUCCESS )
1045 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001046
Ronald Cronf2911112020-10-29 17:51:10 +01001047 /*
1048 * If the key slot containing the key description is under access by the
1049 * library (apart from the present access), the key cannot be destroyed
1050 * yet. For the time being, just return in error. Eventually (to be
1051 * implemented), the key should be destroyed when all accesses have
1052 * stopped.
1053 */
Ronald Cron5c522922020-11-14 16:35:34 +01001054 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001055 {
Ronald Cron5c522922020-11-14 16:35:34 +01001056 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001057 return( PSA_ERROR_GENERIC_ERROR );
1058 }
1059
Gilles Peskine6687cd02021-04-21 22:32:05 +02001060 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1061 {
1062 /* Refuse the destruction of a read-only key (which may or may not work
1063 * if we attempt it, depending on whether the key is merely read-only
1064 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001065 * Just do the best we can, which is to wipe the copy in memory
1066 * (done in this function's cleanup code). */
1067 overall_status = PSA_ERROR_NOT_PERMITTED;
1068 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001069 }
1070
Gilles Peskine354f7672019-07-12 23:46:38 +02001071#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001072 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001073 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001074 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001075 /* For a key in a secure element, we need to do three things:
1076 * remove the key file in internal storage, destroy the
1077 * key inside the secure element, and update the driver's
1078 * persistent data. Start a transaction that will encompass these
1079 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001080 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001081 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001082 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001083 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 status = psa_crypto_save_transaction( );
1085 if( status != PSA_SUCCESS )
1086 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001087 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001088 /* We should still try to destroy the key in the secure
1089 * element and the key metadata in storage. This is especially
1090 * important if the error is that the storage is full.
1091 * But how to do it exactly without risking an inconsistent
1092 * state after a reset?
1093 * https://github.com/ARMmbed/mbed-crypto/issues/215
1094 */
1095 overall_status = status;
1096 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001097 }
1098
Ronald Cronea0f8a62020-11-25 17:52:23 +01001099 status = psa_destroy_se_key( driver,
1100 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001101 if( overall_status == PSA_SUCCESS )
1102 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001103 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001104#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1105
Darryl Greend49a4992018-06-18 17:27:26 +01001106#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001107 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001108 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001109 status = psa_destroy_persistent_key( slot->attr.id );
1110 if( overall_status == PSA_SUCCESS )
1111 overall_status = status;
1112
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001113 /* TODO: other slots may have a copy of the same key. We should
1114 * invalidate them.
1115 * https://github.com/ARMmbed/mbed-crypto/issues/214
1116 */
Darryl Greend49a4992018-06-18 17:27:26 +01001117 }
1118#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001119
Gilles Peskinefc762652019-07-22 19:30:34 +02001120#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1121 if( driver != NULL )
1122 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001123 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001124 if( overall_status == PSA_SUCCESS )
1125 overall_status = status;
1126 status = psa_crypto_stop_transaction( );
1127 if( overall_status == PSA_SUCCESS )
1128 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001129 }
1130#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1131
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001132exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001133 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001134 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001135 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001136 overall_status = status;
1137 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001138}
1139
John Durkop07cc04a2020-11-16 22:08:34 -08001140#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001141 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001142static psa_status_t psa_get_rsa_public_exponent(
1143 const mbedtls_rsa_context *rsa,
1144 psa_key_attributes_t *attributes )
1145{
1146 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001148 uint8_t *buffer = NULL;
1149 size_t buflen;
1150 mbedtls_mpi_init( &mpi );
1151
1152 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1153 if( ret != 0 )
1154 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001155 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1156 {
1157 /* It's the default value, which is reported as an empty string,
1158 * so there's nothing to do. */
1159 goto exit;
1160 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001161
1162 buflen = mbedtls_mpi_size( &mpi );
1163 buffer = mbedtls_calloc( 1, buflen );
1164 if( buffer == NULL )
1165 {
1166 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1167 goto exit;
1168 }
1169 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1170 if( ret != 0 )
1171 goto exit;
1172 attributes->domain_parameters = buffer;
1173 attributes->domain_parameters_size = buflen;
1174
1175exit:
1176 mbedtls_mpi_free( &mpi );
1177 if( ret != 0 )
1178 mbedtls_free( buffer );
1179 return( mbedtls_to_psa_error( ret ) );
1180}
John Durkop07cc04a2020-11-16 22:08:34 -08001181#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001182 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001183
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001184/** Retrieve all the publicly-accessible attributes of a key.
1185 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001186psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001187 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001188{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001189 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001190 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001191 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001192
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001193 psa_reset_key_attributes( attributes );
1194
Ronald Cron5c522922020-11-14 16:35:34 +01001195 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001196 if( status != PSA_SUCCESS )
1197 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001198
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001199 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001200 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1201 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1202
1203#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001204 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001205 psa_set_key_slot_number( attributes,
1206 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001207#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001208
Gilles Peskine8e338702019-07-30 20:06:31 +02001209 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001210 {
John Durkop07cc04a2020-11-16 22:08:34 -08001211#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001212 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001213 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001214 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001215 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001216 * is not yet implemented.
1217 * https://github.com/ARMmbed/mbed-crypto/issues/216
1218 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001219 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001220 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001221 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001222
Ronald Cron90857082020-11-25 14:58:33 +01001223 status = mbedtls_psa_rsa_load_representation(
1224 slot->attr.type,
1225 slot->key.data,
1226 slot->key.bytes,
1227 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001228 if( status != PSA_SUCCESS )
1229 break;
1230
Steven Cooremana2371e52020-07-28 14:30:39 +02001231 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001232 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001233 mbedtls_rsa_free( rsa );
1234 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001237#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001238 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001239 default:
1240 /* Nothing else to do. */
1241 break;
1242 }
1243
1244 if( status != PSA_SUCCESS )
1245 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001246
Ronald Cron5c522922020-11-14 16:35:34 +01001247 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001248
Ronald Cron5c522922020-11-14 16:35:34 +01001249 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001250}
1251
Gilles Peskinec8000c02019-08-02 20:15:51 +02001252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1253psa_status_t psa_get_key_slot_number(
1254 const psa_key_attributes_t *attributes,
1255 psa_key_slot_number_t *slot_number )
1256{
1257 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1258 {
1259 *slot_number = attributes->slot_number;
1260 return( PSA_SUCCESS );
1261 }
1262 else
1263 return( PSA_ERROR_INVALID_ARGUMENT );
1264}
1265#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1266
Ronald Crond18b5f82020-11-25 16:46:05 +01001267static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1268 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 uint8_t *data,
1270 size_t data_size,
1271 size_t *data_length )
1272{
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001274 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001275 memcpy( data, key_buffer, key_buffer_size );
1276 memset( data + key_buffer_size, 0,
1277 data_size - key_buffer_size );
1278 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001279 return( PSA_SUCCESS );
1280}
1281
Ronald Cron7285cda2020-11-26 14:46:37 +01001282psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 const psa_key_attributes_t *attributes,
1284 const uint8_t *key_buffer, size_t key_buffer_size,
1285 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001286{
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 psa_key_type_t type = attributes->core.type;
1288
Ronald Crond18b5f82020-11-25 16:46:05 +01001289 if( key_type_is_raw_bytes( type ) ||
1290 PSA_KEY_TYPE_IS_RSA( type ) ||
1291 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001292 {
1293 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001294 key_buffer, key_buffer_size,
1295 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001296 }
1297 else
1298 {
1299 /* This shouldn't happen in the reference implementation, but
1300 it is valid for a special-purpose implementation to omit
1301 support for exporting certain key types. */
1302 return( PSA_ERROR_NOT_SUPPORTED );
1303 }
1304}
1305
1306psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1307 uint8_t *data,
1308 size_t data_size,
1309 size_t *data_length )
1310{
1311 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1312 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1313 psa_key_slot_t *slot;
1314
Ronald Crone907e552021-01-18 13:22:38 +01001315 /* Reject a zero-length output buffer now, since this can never be a
1316 * valid key representation. This way we know that data must be a valid
1317 * pointer and we can do things like memset(data, ..., data_size). */
1318 if( data_size == 0 )
1319 return( PSA_ERROR_BUFFER_TOO_SMALL );
1320
Ronald Cron9486f9d2020-11-26 13:36:23 +01001321 /* Set the key to empty now, so that even when there are errors, we always
1322 * set data_length to a value between 0 and data_size. On error, setting
1323 * the key to empty is a good choice because an empty key representation is
1324 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001325 *data_length = 0;
1326
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327 /* Export requires the EXPORT flag. There is an exception for public keys,
1328 * which don't require any flag, but
1329 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1330 */
1331 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1332 PSA_KEY_USAGE_EXPORT, 0 );
1333 if( status != PSA_SUCCESS )
1334 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001335
Ronald Crond18b5f82020-11-25 16:46:05 +01001336 psa_key_attributes_t attributes = {
1337 .core = slot->attr
1338 };
Ronald Cron67227982020-11-26 15:16:05 +01001339 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 slot->key.data, slot->key.bytes,
1341 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342
Ronald Cron9486f9d2020-11-26 13:36:23 +01001343 unlock_status = psa_unlock_key_slot( slot );
1344
1345 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1346}
1347
Ronald Cron7285cda2020-11-26 14:46:37 +01001348psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 const psa_key_attributes_t *attributes,
1350 const uint8_t *key_buffer,
1351 size_t key_buffer_size,
1352 uint8_t *data,
1353 size_t data_size,
1354 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001355{
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001357
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001359 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001360 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001361 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001362 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001363 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001364 key_buffer, key_buffer_size,
1365 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001366 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001367
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001369 {
John Durkop0e005192020-10-31 22:06:54 -07001370#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1371 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001372 return( mbedtls_psa_rsa_export_public_key( attributes,
1373 key_buffer,
1374 key_buffer_size,
1375 data,
1376 data_size,
1377 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001378#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001379 /* We don't know how to convert a private RSA key to public. */
1380 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001381#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1382 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001383 }
1384 else
Moran Pekera998bc62018-04-16 18:16:20 +03001385 {
John Durkop6ba40d12020-11-10 08:50:04 -08001386#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1387 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001388 return( mbedtls_psa_ecp_export_public_key( attributes,
1389 key_buffer,
1390 key_buffer_size,
1391 data,
1392 data_size,
1393 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001394#else
1395 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001396 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001397#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1398 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001399 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001400 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001401 else
1402 {
1403 /* This shouldn't happen in the reference implementation, but
1404 it is valid for a special-purpose implementation to omit
1405 support for exporting certain key types. */
1406 return( PSA_ERROR_NOT_SUPPORTED );
1407 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001408}
Ronald Crond18b5f82020-11-25 16:46:05 +01001409
Ronald Croncf56a0a2020-08-04 09:51:30 +02001410psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001411 uint8_t *data,
1412 size_t data_size,
1413 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001414{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001416 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001417 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001418
Ronald Crone907e552021-01-18 13:22:38 +01001419 /* Reject a zero-length output buffer now, since this can never be a
1420 * valid key representation. This way we know that data must be a valid
1421 * pointer and we can do things like memset(data, ..., data_size). */
1422 if( data_size == 0 )
1423 return( PSA_ERROR_BUFFER_TOO_SMALL );
1424
Darryl Greendd8fb772018-11-07 16:00:44 +00001425 /* Set the key to empty now, so that even when there are errors, we always
1426 * set data_length to a value between 0 and data_size. On error, setting
1427 * the key to empty is a good choice because an empty key representation is
1428 * unlikely to be accepted anywhere. */
1429 *data_length = 0;
1430
1431 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001432 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001433 if( status != PSA_SUCCESS )
1434 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001435
Ronald Cron9486f9d2020-11-26 13:36:23 +01001436 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1437 {
1438 status = PSA_ERROR_INVALID_ARGUMENT;
1439 goto exit;
1440 }
1441
Ronald Crond18b5f82020-11-25 16:46:05 +01001442 psa_key_attributes_t attributes = {
1443 .core = slot->attr
1444 };
Ronald Cron67227982020-11-26 15:16:05 +01001445 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001446 &attributes, slot->key.data, slot->key.bytes,
1447 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001448
1449exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001450 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001451
Ronald Cron5c522922020-11-14 16:35:34 +01001452 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001453}
1454
Gilles Peskine91e8c332019-08-02 19:19:39 +02001455#if defined(static_assert)
1456static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1457 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001458static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001459 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001460static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001461 "One or more key attribute flag is listed as both internal-only and external-only" );
1462#endif
1463
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001464/** Validate that a key policy is internally well-formed.
1465 *
1466 * This function only rejects invalid policies. It does not validate the
1467 * consistency of the policy with respect to other attributes of the key
1468 * such as the key type.
1469 */
1470static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001471{
1472 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001473 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 PSA_KEY_USAGE_ENCRYPT |
1475 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001476 PSA_KEY_USAGE_SIGN_MESSAGE |
1477 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001478 PSA_KEY_USAGE_SIGN_HASH |
1479 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001480 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001481 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1482 return( PSA_ERROR_INVALID_ARGUMENT );
1483
Gilles Peskine4747d192019-04-17 15:05:45 +02001484 return( PSA_SUCCESS );
1485}
1486
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001487/** Validate the internal consistency of key attributes.
1488 *
1489 * This function only rejects invalid attribute values. If does not
1490 * validate the consistency of the attributes with any key data that may
1491 * be involved in the creation of the key.
1492 *
1493 * Call this function early in the key creation process.
1494 *
1495 * \param[in] attributes Key attributes for the new key.
1496 * \param[out] p_drv On any return, the driver for the key, if any.
1497 * NULL for a transparent key.
1498 *
1499 */
1500static psa_status_t psa_validate_key_attributes(
1501 const psa_key_attributes_t *attributes,
1502 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001503{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001504 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001505 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001506 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001507
Ronald Cron54b90082020-10-29 15:26:43 +01001508 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001509 if( status != PSA_SUCCESS )
1510 return( status );
1511
Ronald Crond2ed4812020-07-17 16:11:30 +02001512 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001513 if( status != PSA_SUCCESS )
1514 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001515
Ronald Cron65f38a32020-10-23 17:11:13 +02001516 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1517 {
1518 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1519 return( PSA_ERROR_INVALID_ARGUMENT );
1520 }
1521 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001522 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001523 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1524 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001525 }
1526
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001527 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001528 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001529 return( status );
1530
1531 /* Refuse to create overly large keys.
1532 * Note that this doesn't trigger on import if the attributes don't
1533 * explicitly specify a size (so psa_get_key_bits returns 0), so
1534 * psa_import_key() needs its own checks. */
1535 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1536 return( PSA_ERROR_NOT_SUPPORTED );
1537
Gilles Peskine91e8c332019-08-02 19:19:39 +02001538 /* Reject invalid flags. These should not be reachable through the API. */
1539 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1540 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1541 return( PSA_ERROR_INVALID_ARGUMENT );
1542
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001543 return( PSA_SUCCESS );
1544}
1545
Gilles Peskine4747d192019-04-17 15:05:45 +02001546/** Prepare a key slot to receive key material.
1547 *
1548 * This function allocates a key slot and sets its metadata.
1549 *
1550 * If this function fails, call psa_fail_key_creation().
1551 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001552 * This function is intended to be used as follows:
1553 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001554 * it with the specified attributes, and in case of a volatile key assign it
1555 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001556 * -# Populate the slot with the key material.
1557 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1558 * In case of failure at any step, stop the sequence and call
1559 * psa_fail_key_creation().
1560 *
Ronald Cron5c522922020-11-14 16:35:34 +01001561 * On success, the key slot is locked. It is the responsibility of the caller
1562 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001563 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001564 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001565 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001566 * \param[out] p_slot On success, a pointer to the prepared slot.
1567 * \param[out] p_drv On any return, the driver for the key, if any.
1568 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001569 *
1570 * \retval #PSA_SUCCESS
1571 * The key slot is ready to receive key material.
1572 * \return If this function fails, the key slot is an invalid state.
1573 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 */
1575static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001577 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001578 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001579 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001580{
1581 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001582 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 psa_key_slot_t *slot;
1584
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001586 *p_drv = NULL;
1587
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001588 status = psa_validate_key_attributes( attributes, p_drv );
1589 if( status != PSA_SUCCESS )
1590 return( status );
1591
Ronald Cronc4d1b512020-07-31 11:26:37 +02001592 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001593 if( status != PSA_SUCCESS )
1594 return( status );
1595 slot = *p_slot;
1596
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001597 /* We're storing the declared bit-size of the key. It's up to each
1598 * creation mechanism to verify that this information is correct.
1599 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001600 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001601 * is optional (import, copy). In case of a volatile key, assign it the
1602 * volatile key identifier associated to the slot returned to contain its
1603 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001604
1605 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001606 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1607 {
1608#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1609 slot->attr.id = volatile_key_id;
1610#else
1611 slot->attr.id.key_id = volatile_key_id;
1612#endif
1613 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001614
Gilles Peskine91e8c332019-08-02 19:19:39 +02001615 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001616 * external-only flags, query `attributes`. Thanks to the check
1617 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001618 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001619 * may have set. */
1620 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001621
Gilles Peskinecbaff462019-07-12 23:46:04 +02001622#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001623 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001624 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001625 * create the key file in internal storage, create the
1626 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001627 * persistent data. This is done by starting a transaction that will
1628 * encompass these three actions.
1629 * For registering a volatile key, we just need to find an appropriate
1630 * slot number inside the SE. Since the key is designated volatile, creating
1631 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001632 /* The first thing to do is to find a slot number for the new key.
1633 * We save the slot number in persistent storage as part of the
1634 * transaction data. It will be needed to recover if the power
1635 * fails during the key creation process, to clean up on the secure
1636 * element side after restarting. Obtaining a slot number from the
1637 * secure element driver updates its persistent state, but we do not yet
1638 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001639 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001640 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001641 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001642 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001643 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001644 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001645 if( status != PSA_SUCCESS )
1646 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001647
1648 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001649 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001650 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1651 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001653 psa_crypto_transaction.key.id = slot->attr.id;
1654 status = psa_crypto_save_transaction( );
1655 if( status != PSA_SUCCESS )
1656 {
1657 (void) psa_crypto_stop_transaction( );
1658 return( status );
1659 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001660 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661
1662 status = psa_copy_key_material_into_slot(
1663 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001664 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001665
1666 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1667 {
1668 /* Key registration only makes sense with a secure element. */
1669 return( PSA_ERROR_INVALID_ARGUMENT );
1670 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001671#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1672
Ronald Cronc4d1b512020-07-31 11:26:37 +02001673 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001674}
Gilles Peskine4747d192019-04-17 15:05:45 +02001675
1676/** Finalize the creation of a key once its key material has been set.
1677 *
1678 * This entails writing the key to persistent storage.
1679 *
1680 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001681 * See the documentation of psa_start_key_creation() for the intended use
1682 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001683 *
Ronald Cron5c522922020-11-14 16:35:34 +01001684 * If the finalization succeeds, the function unlocks the key slot (it was
1685 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1686 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001687 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001688 * \param[in,out] slot Pointer to the slot with key material.
1689 * \param[in] driver The secure element driver for the key,
1690 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001691 * \param[out] key On success, identifier of the key. Note that the
1692 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001693 *
1694 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001695 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001696 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1697 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1698 * \retval #PSA_ERROR_ALREADY_EXISTS
1699 * \retval #PSA_ERROR_DATA_INVALID
1700 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001701 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001702 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001703 * \return If this function fails, the key slot is an invalid state.
1704 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001705 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001706static psa_status_t psa_finish_key_creation(
1707 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001708 psa_se_drv_table_entry_t *driver,
1709 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001710{
1711 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001712 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001713 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001714
1715#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001716 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001717 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001718#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1719 if( driver != NULL )
1720 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001721 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001722 psa_key_slot_number_t slot_number =
1723 psa_key_slot_get_slot_number( slot ) ;
1724
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001726 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001727 sizeof( data.slot_number ),
1728 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001729#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001730 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001731 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001732 (uint8_t*) &data,
1733 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001734 }
1735 else
1736#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1737 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001738 /* Key material is saved in export representation in the slot, so
1739 * just pass the slot buffer for storage. */
1740 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741 slot->key.data,
1742 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001743 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001744 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001745#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1746
Gilles Peskinecbaff462019-07-12 23:46:04 +02001747#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001748 /* Finish the transaction for a key creation. This does not
1749 * happen when registering an existing key. Detect this case
1750 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001751 * creation of a persistent key in a secure element requires a transaction,
1752 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001753 if( driver != NULL &&
1754 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001755 {
1756 status = psa_save_se_persistent_data( driver );
1757 if( status != PSA_SUCCESS )
1758 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001759 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001760 return( status );
1761 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001762 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001763 }
1764#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1765
Ronald Cron50972942020-11-14 11:28:25 +01001766 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 {
1768 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001769 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001770 if( status != PSA_SUCCESS )
1771 *key = MBEDTLS_SVC_KEY_ID_INIT;
1772 }
Ronald Cron50972942020-11-14 11:28:25 +01001773
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 return( status );
1775}
1776
1777/** Abort the creation of a key.
1778 *
1779 * You may call this function after calling psa_start_key_creation(),
1780 * or after psa_finish_key_creation() fails. In other circumstances, this
1781 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001782 * See the documentation of psa_start_key_creation() for the intended use
1783 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001784 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001785 * \param[in,out] slot Pointer to the slot with key material.
1786 * \param[in] driver The secure element driver for the key,
1787 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001789static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001790 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001791{
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 (void) driver;
1793
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 if( slot == NULL )
1795 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001796
1797#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001798 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001799 * element, and the failure happened later (when saving metadata
1800 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001801 * element.
1802 * https://github.com/ARMmbed/mbed-crypto/issues/217
1803 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001804
Gilles Peskined7729582019-08-05 15:55:54 +02001805 /* Abort the ongoing transaction if any (there may not be one if
1806 * the creation process failed before starting one, or if the
1807 * key creation is a registration of a key in a secure element).
1808 * Earlier functions must already have done what it takes to undo any
1809 * partial creation. All that's left is to update the transaction data
1810 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001811 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001812#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1813
Gilles Peskine4747d192019-04-17 15:05:45 +02001814 psa_wipe_key_slot( slot );
1815}
1816
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817/** Validate optional attributes during key creation.
1818 *
1819 * Some key attributes are optional during key creation. If they are
1820 * specified in the attributes structure, check that they are consistent
1821 * with the data in the slot.
1822 *
1823 * This function should be called near the end of key creation, after
1824 * the slot in memory is fully populated but before saving persistent data.
1825 */
1826static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001827 const psa_key_slot_t *slot,
1828 const psa_key_attributes_t *attributes )
1829{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001830 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001832 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001833 return( PSA_ERROR_INVALID_ARGUMENT );
1834 }
1835
1836 if( attributes->domain_parameters_size != 0 )
1837 {
John Durkop0e005192020-10-31 22:06:54 -07001838#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1839 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001840 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001842 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001843 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001845
Ronald Cron90857082020-11-25 14:58:33 +01001846 psa_status_t status = mbedtls_psa_rsa_load_representation(
1847 slot->attr.type,
1848 slot->key.data,
1849 slot->key.bytes,
1850 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001851 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001852 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001853
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001854 mbedtls_mpi_init( &actual );
1855 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001856 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001857 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001858 mbedtls_rsa_free( rsa );
1859 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 if( ret != 0 )
1861 goto rsa_exit;
1862 ret = mbedtls_mpi_read_binary( &required,
1863 attributes->domain_parameters,
1864 attributes->domain_parameters_size );
1865 if( ret != 0 )
1866 goto rsa_exit;
1867 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1868 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1869 rsa_exit:
1870 mbedtls_mpi_free( &actual );
1871 mbedtls_mpi_free( &required );
1872 if( ret != 0)
1873 return( mbedtls_to_psa_error( ret ) );
1874 }
1875 else
John Durkop9814fa22020-11-04 12:28:15 -08001876#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1877 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001878 {
1879 return( PSA_ERROR_INVALID_ARGUMENT );
1880 }
1881 }
1882
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001883 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001885 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886 return( PSA_ERROR_INVALID_ARGUMENT );
1887 }
1888
1889 return( PSA_SUCCESS );
1890}
1891
Gilles Peskine4747d192019-04-17 15:05:45 +02001892psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001893 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001894 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001895 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001896{
1897 psa_status_t status;
1898 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001899 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001900 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901
Ronald Cron81709fc2020-11-14 12:10:32 +01001902 *key = MBEDTLS_SVC_KEY_ID_INIT;
1903
Gilles Peskine0f84d622019-09-12 19:03:13 +02001904 /* Reject zero-length symmetric keys (including raw data key objects).
1905 * This also rejects any key which might be encoded as an empty string,
1906 * which is never valid. */
1907 if( data_length == 0 )
1908 return( PSA_ERROR_INVALID_ARGUMENT );
1909
Gilles Peskinedf179142019-07-15 22:02:14 +02001910 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001911 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001912 if( status != PSA_SUCCESS )
1913 goto exit;
1914
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001915 /* In the case of a transparent key or an opaque key stored in local
1916 * storage (thus not in the case of generating a key in a secure element
1917 * or cryptoprocessor with storage), we have to allocate a buffer to
1918 * hold the generated key material. */
1919 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001920 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001921 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001922 if( status != PSA_SUCCESS )
1923 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001924 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001925
1926 bits = slot->attr.bits;
1927 status = psa_driver_wrapper_import_key( attributes,
1928 data, data_length,
1929 slot->key.data,
1930 slot->key.bytes,
1931 &slot->key.bytes, &bits );
1932 if( status != PSA_SUCCESS )
1933 goto exit;
1934
1935 if( slot->attr.bits == 0 )
1936 slot->attr.bits = (psa_key_bits_t) bits;
1937 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001938 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001939 status = PSA_ERROR_INVALID_ARGUMENT;
1940 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001941 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001942
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001943 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001944 if( status != PSA_SUCCESS )
1945 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001948exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001949 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001950 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001951
Gilles Peskine4747d192019-04-17 15:05:45 +02001952 return( status );
1953}
1954
Gilles Peskined7729582019-08-05 15:55:54 +02001955#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1956psa_status_t mbedtls_psa_register_se_key(
1957 const psa_key_attributes_t *attributes )
1958{
1959 psa_status_t status;
1960 psa_key_slot_t *slot = NULL;
1961 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001962 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001963
1964 /* Leaving attributes unspecified is not currently supported.
1965 * It could make sense to query the key type and size from the
1966 * secure element, but not all secure elements support this
1967 * and the driver HAL doesn't currently support it. */
1968 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1969 return( PSA_ERROR_NOT_SUPPORTED );
1970 if( psa_get_key_bits( attributes ) == 0 )
1971 return( PSA_ERROR_NOT_SUPPORTED );
1972
1973 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001974 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001975 if( status != PSA_SUCCESS )
1976 goto exit;
1977
Ronald Cron81709fc2020-11-14 12:10:32 +01001978 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001979
1980exit:
1981 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001982 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001983
Gilles Peskined7729582019-08-05 15:55:54 +02001984 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001985 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001986 return( status );
1987}
1988#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1989
Gilles Peskinef603c712019-01-19 13:40:11 +01001990static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001991 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001992{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001993 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001994 source->key.data,
1995 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001996 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001997 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001998
Steven Cooreman398aee52020-10-13 14:35:45 +02001999 target->attr.type = source->attr.type;
2000 target->attr.bits = source->attr.bits;
2001
2002 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002003}
2004
Ronald Croncf56a0a2020-08-04 09:51:30 +02002005psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002006 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002007 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002008{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002010 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002011 psa_key_slot_t *source_slot = NULL;
2012 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002013 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002014 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002015
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2017
Ronald Cron5c522922020-11-14 16:35:34 +01002018 status = psa_get_and_lock_transparent_key_slot_with_policy(
2019 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002020 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 goto exit;
2022
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002023 status = psa_validate_optional_attributes( source_slot,
2024 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002025 if( status != PSA_SUCCESS )
2026 goto exit;
2027
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002028 status = psa_restrict_key_policy( source_slot->attr.type,
2029 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002030 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002031 if( status != PSA_SUCCESS )
2032 goto exit;
2033
Ronald Cron81709fc2020-11-14 12:10:32 +01002034 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2035 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 if( status != PSA_SUCCESS )
2037 goto exit;
2038
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002039#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2040 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002041 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002042 /* Copying to a secure element is not implemented yet. */
2043 status = PSA_ERROR_NOT_SUPPORTED;
2044 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002045 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002047
Ronald Cron6cc66312021-04-02 12:27:47 +02002048 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2049 {
2050 /*
2051 * Copying through an opaque driver is not implemented yet, consider
2052 * a lifetime with an external location as an invalid parameter for
2053 * now.
2054 */
2055 status = PSA_ERROR_INVALID_ARGUMENT;
2056 goto exit;
2057 }
2058
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002059 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002060 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002061 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002062
Ronald Cron81709fc2020-11-14 12:10:32 +01002063 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002064exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002065 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002066 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002067
Ronald Cron5c522922020-11-14 16:35:34 +01002068 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002069
Ronald Cron5c522922020-11-14 16:35:34 +01002070 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002071}
2072
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002073
2074
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002075/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002076/* Message digests */
2077/****************************************************************/
2078
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002079psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2080{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002081 /* Aborting a non-active operation is allowed */
2082 if( operation->id == 0 )
2083 return( PSA_SUCCESS );
2084
2085 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2086 operation->id = 0;
2087
2088 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002089}
2090
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002091psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002092 psa_algorithm_t alg )
2093{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002094 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002095
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002096 /* A context must be freshly initialized before it can be set up. */
2097 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002098 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002099 status = PSA_ERROR_BAD_STATE;
2100 goto exit;
2101 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002102
2103 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002104 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002105 status = PSA_ERROR_INVALID_ARGUMENT;
2106 goto exit;
2107 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002108
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002109 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2110 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002111 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2112
Dave Rodgman685b6a72021-06-24 11:49:14 +01002113 status = psa_driver_wrapper_hash_setup( operation, alg );
2114
2115exit:
2116 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002117 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002118
2119 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002120}
2121
2122psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2123 const uint8_t *input,
2124 size_t input_length )
2125{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2127
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002128 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002129 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002130 status = PSA_ERROR_BAD_STATE;
2131 goto exit;
2132 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002133
Steven Cooremanc8288352021-03-04 14:02:19 +01002134 /* Don't require hash implementations to behave correctly on a
2135 * zero-length input, which may have an invalid pointer. */
2136 if( input_length == 0 )
2137 return( PSA_SUCCESS );
2138
Dave Rodgman685b6a72021-06-24 11:49:14 +01002139 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2140
2141exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002142 if( status != PSA_SUCCESS )
2143 psa_hash_abort( operation );
2144
2145 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146}
2147
2148psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2149 uint8_t *hash,
2150 size_t hash_size,
2151 size_t *hash_length )
2152{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002153 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002154 if( operation->id == 0 )
2155 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156
Steven Cooreman1e582352021-02-18 17:24:37 +01002157 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002158 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002159 psa_hash_abort( operation );
2160 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002161}
2162
Gilles Peskine2d277862018-06-18 15:41:12 +02002163psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2164 const uint8_t *hash,
2165 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166{
2167 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2168 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002169 psa_status_t status = psa_hash_finish(
2170 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002171 actual_hash, sizeof( actual_hash ),
2172 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002173
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002174 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002175 goto exit;
2176
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002178 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002179 status = PSA_ERROR_INVALID_SIGNATURE;
2180 goto exit;
2181 }
2182
Steven Cooreman36876a02021-04-29 16:37:59 +02002183 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002184 status = PSA_ERROR_INVALID_SIGNATURE;
2185
2186exit:
2187 if( status != PSA_SUCCESS )
2188 psa_hash_abort(operation);
2189
2190 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002191}
2192
Gilles Peskine0a749c82019-11-28 19:33:58 +01002193psa_status_t psa_hash_compute( psa_algorithm_t alg,
2194 const uint8_t *input, size_t input_length,
2195 uint8_t *hash, size_t hash_size,
2196 size_t *hash_length )
2197{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002198 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002199 if( !PSA_ALG_IS_HASH( alg ) )
2200 return( PSA_ERROR_INVALID_ARGUMENT );
2201
Steven Cooreman1e582352021-02-18 17:24:37 +01002202 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2203 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002204}
2205
2206psa_status_t psa_hash_compare( psa_algorithm_t alg,
2207 const uint8_t *input, size_t input_length,
2208 const uint8_t *hash, size_t hash_length )
2209{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002210 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2211 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002212
2213 if( !PSA_ALG_IS_HASH( alg ) )
2214 return( PSA_ERROR_INVALID_ARGUMENT );
2215
Steven Cooreman1e582352021-02-18 17:24:37 +01002216 psa_status_t status = psa_driver_wrapper_hash_compute(
2217 alg, input, input_length,
2218 actual_hash, sizeof(actual_hash),
2219 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002220 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002221 return( status );
2222 if( actual_hash_length != hash_length )
2223 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002224 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002225 return( PSA_ERROR_INVALID_SIGNATURE );
2226 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002227}
2228
Gilles Peskineeb35d782019-01-22 17:56:16 +01002229psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2230 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002231{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232 if( source_operation->id == 0 ||
2233 target_operation->id != 0 )
2234 {
2235 return( PSA_ERROR_BAD_STATE );
2236 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002237
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002238 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2239 target_operation );
2240 if( status != PSA_SUCCESS )
2241 psa_hash_abort( target_operation );
2242
2243 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002244}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245
2246
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002247/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002248/* MAC */
2249/****************************************************************/
2250
Steven Cooremane6804192021-03-19 18:28:56 +01002251psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002252{
Steven Cooremane6804192021-03-19 18:28:56 +01002253 /* Aborting a non-active operation is allowed */
2254 if( operation->id == 0 )
2255 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002256
Steven Cooremane6804192021-03-19 18:28:56 +01002257 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002258 operation->mac_size = 0;
2259 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002260 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002261
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002262 return( status );
2263}
2264
Ronald Cron2dff3b22021-06-17 16:33:22 +02002265static psa_status_t psa_mac_finalize_alg_and_key_validation(
2266 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002267 const psa_key_attributes_t *attributes,
2268 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002269{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002271 psa_key_type_t key_type = psa_get_key_type( attributes );
2272 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002273
Ronald Cron28ea0502021-06-17 16:10:24 +02002274 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002275 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002276
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002277 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002278 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002279 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002280 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002281
Steven Cooremand1a68f12021-05-10 11:13:41 +02002282 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002283 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002284
Ronald Cron79bdd822021-06-17 16:46:44 +02002285 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002286 {
2287 /* A very short MAC is too short for security since it can be
2288 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2289 * so we make this our minimum, even though 32 bits is still
2290 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002291 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002292 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002293
Ronald Cron79bdd822021-06-17 16:46:44 +02002294 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2295 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002296 {
2297 /* It's impossible to "truncate" to a larger length than the full length
2298 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002299 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002300 }
2301
Ronald Cron79bdd822021-06-17 16:46:44 +02002302 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002303}
2304
Gilles Peskinee59236f2018-01-27 23:32:46 +01002305static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2306 mbedtls_svc_key_id_t key,
2307 psa_algorithm_t alg,
2308 int is_sign )
2309{
2310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2311 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002312 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002313
2314 /* A context must be freshly initialized before it can be set up. */
2315 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002316 {
Dave Rodgman54648242021-06-24 11:49:45 +01002317 status = PSA_ERROR_BAD_STATE;
2318 goto exit;
2319 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320
Gilles Peskine8c9def32018-02-08 10:02:12 +01002321 status = psa_get_and_lock_key_slot_with_policy(
2322 key,
2323 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002324 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002325 alg );
2326 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002327 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328
2329 psa_key_attributes_t attributes = {
2330 .core = slot->attr
2331 };
2332
Ronald Cron79bdd822021-06-17 16:46:44 +02002333 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2334 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002335 if( status != PSA_SUCCESS )
2336 goto exit;
2337
2338 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002339 /* Dispatch the MAC setup call with validated input */
2340 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002341 {
Steven Cooremane6804192021-03-19 18:28:56 +01002342 status = psa_driver_wrapper_mac_sign_setup( operation,
2343 &attributes,
2344 slot->key.data,
2345 slot->key.bytes,
2346 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002347 }
2348 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002349 {
Steven Cooremane6804192021-03-19 18:28:56 +01002350 status = psa_driver_wrapper_mac_verify_setup( operation,
2351 &attributes,
2352 slot->key.data,
2353 slot->key.bytes,
2354 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002356
Gilles Peskinefbfac682018-07-08 20:51:54 +02002357exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002358 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002359 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002360
Ronald Cron5c522922020-11-14 16:35:34 +01002361 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002362
Ronald Cron5c522922020-11-14 16:35:34 +01002363 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002364}
2365
Gilles Peskine89167cb2018-07-08 20:12:23 +02002366psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002367 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002368 psa_algorithm_t alg )
2369{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002370 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002371}
2372
2373psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002374 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002375 psa_algorithm_t alg )
2376{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002377 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002378}
2379
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002380psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002381 const uint8_t *input,
2382 size_t input_length )
2383{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002384 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002385 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002386
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002387 /* Don't require hash implementations to behave correctly on a
2388 * zero-length input, which may have an invalid pointer. */
2389 if( input_length == 0 )
2390 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002391
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002392 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2393 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002394 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002395 psa_mac_abort( operation );
2396
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002397 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002398}
2399
Steven Cooremana5b860a2021-03-19 19:04:39 +01002400psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002401 uint8_t *mac,
2402 size_t mac_size,
2403 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002404{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2406 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002407
Steven Cooremana5b860a2021-03-19 19:04:39 +01002408 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002409 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002410 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002411 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002412 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002413
Steven Cooreman72f736a2021-05-07 14:14:37 +02002414 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002415 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002416 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002417 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002418 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002419
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002420 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2421 * once all the error checks are done. */
2422 if( operation->mac_size == 0 )
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 Cooreman8af5c5c2021-05-11 11:09:13 +02002427
2428 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002429 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002430 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002431 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002432 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002433
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002435 mac, operation->mac_size,
2436 mac_length );
2437
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002438exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002439 /* In case of success, set the potential excess room in the output buffer
2440 * to an invalid value, to avoid potentially leaking a longer MAC.
2441 * In case of error, set the output length and content to a safe default,
2442 * such that in case the caller misses an error check, the output would be
2443 * an unachievable MAC.
2444 */
2445 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002446 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002447 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002448 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002449 }
mohammad16036df908f2018-04-02 08:34:15 -07002450
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002451 if( mac_size > operation->mac_size )
2452 memset( &mac[operation->mac_size], '!',
2453 mac_size - operation->mac_size );
2454
Steven Cooremana5b860a2021-03-19 19:04:39 +01002455 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002456
Steven Cooremana5b860a2021-03-19 19:04:39 +01002457 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002458}
2459
Steven Cooremana5b860a2021-03-19 19:04:39 +01002460psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002461 const uint8_t *mac,
2462 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002463{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002464 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2465 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002466
Steven Cooremana5b860a2021-03-19 19:04:39 +01002467 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002468 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002469 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002470 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002471 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002472
Steven Cooreman72f736a2021-05-07 14:14:37 +02002473 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002474 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002475 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002476 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002477 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002478
2479 if( operation->mac_size != mac_length )
2480 {
2481 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002482 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002483 }
2484
Steven Cooremana5b860a2021-03-19 19:04:39 +01002485 status = psa_driver_wrapper_mac_verify_finish( operation,
2486 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002487
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002488exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002489 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002490
Steven Cooremana5b860a2021-03-19 19:04:39 +01002491 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002492}
2493
Ronald Croncd989b52021-06-18 14:23:33 +02002494static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2495 psa_algorithm_t alg,
2496 const uint8_t *input,
2497 size_t input_length,
2498 uint8_t *mac,
2499 size_t mac_size,
2500 size_t *mac_length,
2501 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002502{
2503 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002504 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2505 psa_key_slot_t *slot;
2506 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002507
Ronald Cron51131b52021-06-17 17:17:20 +02002508 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002509 key,
2510 &slot,
2511 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002512 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002513 if( status != PSA_SUCCESS )
2514 goto exit;
2515
Ronald Cron51131b52021-06-17 17:17:20 +02002516 psa_key_attributes_t attributes = {
2517 .core = slot->attr
2518 };
2519
2520 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2521 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002522 if( status != PSA_SUCCESS )
2523 goto exit;
2524
Ronald Cron51131b52021-06-17 17:17:20 +02002525 if( mac_size < operation_mac_size )
2526 {
2527 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002528 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002529 }
2530
2531 status = psa_driver_wrapper_mac_compute(
2532 &attributes,
2533 slot->key.data, slot->key.bytes,
2534 alg,
2535 input, input_length,
2536 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002537
2538exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002539 /* In case of success, set the potential excess room in the output buffer
2540 * to an invalid value, to avoid potentially leaking a longer MAC.
2541 * In case of error, set the output length and content to a safe default,
2542 * such that in case the caller misses an error check, the output would be
2543 * an unachievable MAC.
2544 */
2545 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002546 {
Ronald Cron51131b52021-06-17 17:17:20 +02002547 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002548 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002549 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002550 if( mac_size > operation_mac_size )
2551 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002552
Ronald Cron51131b52021-06-17 17:17:20 +02002553 unlock_status = psa_unlock_key_slot( slot );
2554
2555 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002556}
2557
Ronald Croncd989b52021-06-18 14:23:33 +02002558psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2559 psa_algorithm_t alg,
2560 const uint8_t *input,
2561 size_t input_length,
2562 uint8_t *mac,
2563 size_t mac_size,
2564 size_t *mac_length)
2565{
2566 return( psa_mac_compute_internal( key, alg,
2567 input, input_length,
2568 mac, mac_size, mac_length, 1 ) );
2569}
2570
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002571psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2572 psa_algorithm_t alg,
2573 const uint8_t *input,
2574 size_t input_length,
2575 const uint8_t *mac,
2576 size_t mac_length)
2577{
2578 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002579 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2580 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002581
Ronald Crona587cbc2021-06-18 14:51:29 +02002582 status = psa_mac_compute_internal( key, alg,
2583 input, input_length,
2584 actual_mac, sizeof( actual_mac ),
2585 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002586 if( status != PSA_SUCCESS )
2587 goto exit;
2588
Ronald Crona587cbc2021-06-18 14:51:29 +02002589 if( mac_length != actual_mac_length )
2590 {
2591 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002592 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002593 }
2594 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2595 {
2596 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002597 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002598 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002599
2600exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002601 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602
2603 return ( status );
2604}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002605
Gilles Peskinee59236f2018-01-27 23:32:46 +01002606/****************************************************************/
2607/* Asymmetric cryptography */
2608/****************************************************************/
2609
gabor-mezei-armf0486182021-05-12 11:03:09 +02002610static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002611 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002612{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002613 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002614 {
2615 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2616 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002617
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002618 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2619 {
2620 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2621 return( PSA_ERROR_INVALID_ARGUMENT );
2622 }
2623 }
2624 else
2625 {
2626 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2627 return( PSA_ERROR_INVALID_ARGUMENT );
2628 }
2629
2630 return( PSA_SUCCESS );
2631}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002632
2633static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002634 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002635 psa_algorithm_t alg,
2636 const uint8_t * input,
2637 size_t input_length,
2638 uint8_t * signature,
2639 size_t signature_size,
2640 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002641{
2642 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2643 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2644 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002645
2646 *signature_length = 0;
2647
gabor-mezei-armf0486182021-05-12 11:03:09 +02002648 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002649 if( status != PSA_SUCCESS )
2650 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002651
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002652 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002653 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002654 * buffer can in principle be empty since it doesn't actually have
2655 * to be a hash.) */
2656 if( signature_size == 0 )
2657 return( PSA_ERROR_BUFFER_TOO_SMALL );
2658
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002659 status = psa_get_and_lock_key_slot_with_policy(
2660 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002661 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2662 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002663 alg );
2664
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002665 if( status != PSA_SUCCESS )
2666 goto exit;
2667
2668 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2669 {
2670 status = PSA_ERROR_INVALID_ARGUMENT;
2671 goto exit;
2672 }
2673
2674 psa_key_attributes_t attributes = {
2675 .core = slot->attr
2676 };
2677
gabor-mezei-armf0486182021-05-12 11:03:09 +02002678 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002679 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002680 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002681 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002682 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002683 signature, signature_size, signature_length );
2684 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002685 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002686 {
2687
2688 status = psa_driver_wrapper_sign_hash(
2689 &attributes, slot->key.data, slot->key.bytes,
2690 alg, input, input_length,
2691 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002692 }
2693
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002694
2695exit:
2696 /* Fill the unused part of the output buffer (the whole buffer on error,
2697 * the trailing part on success) with something that isn't a valid signature
2698 * (barring an attack on the signature and deliberately-crafted input),
2699 * in case the caller doesn't check the return status properly. */
2700 if( status == PSA_SUCCESS )
2701 memset( signature + *signature_length, '!',
2702 signature_size - *signature_length );
2703 else
2704 memset( signature, '!', signature_size );
2705 /* If signature_size is 0 then we have nothing to do. We must not call
2706 * memset because signature may be NULL in this case. */
2707
2708 unlock_status = psa_unlock_key_slot( slot );
2709
2710 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2711}
2712
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002713static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002714 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002715 psa_algorithm_t alg,
2716 const uint8_t * input,
2717 size_t input_length,
2718 const uint8_t * signature,
2719 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002720{
2721 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2722 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2723 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002724
gabor-mezei-armf0486182021-05-12 11:03:09 +02002725 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002726 if( status != PSA_SUCCESS )
2727 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002728
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002729 status = psa_get_and_lock_key_slot_with_policy(
2730 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002731 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2732 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002733 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002734
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002735 if( status != PSA_SUCCESS )
2736 return( status );
2737
2738 psa_key_attributes_t attributes = {
2739 .core = slot->attr
2740 };
2741
gabor-mezei-armf0486182021-05-12 11:03:09 +02002742 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002743 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002744 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002745 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002746 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002747 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002748 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002749 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002750 {
2751 status = psa_driver_wrapper_verify_hash(
2752 &attributes, slot->key.data, slot->key.bytes,
2753 alg, input, input_length,
2754 signature, signature_length );
2755 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002756
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002757 unlock_status = psa_unlock_key_slot( slot );
2758
2759 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002760
2761}
2762
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002763psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002764 const psa_key_attributes_t *attributes,
2765 const uint8_t *key_buffer,
2766 size_t key_buffer_size,
2767 psa_algorithm_t alg,
2768 const uint8_t *input,
2769 size_t input_length,
2770 uint8_t *signature,
2771 size_t signature_size,
2772 size_t *signature_length )
2773{
2774 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002775
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002776 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2777 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002778 size_t hash_length;
2779 uint8_t hash[PSA_HASH_MAX_SIZE];
2780
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002781 status = psa_driver_wrapper_hash_compute(
2782 PSA_ALG_SIGN_GET_HASH( alg ),
2783 input, input_length,
2784 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002785
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002786 if( status != PSA_SUCCESS )
2787 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002788
2789 return psa_driver_wrapper_sign_hash(
2790 attributes, key_buffer, key_buffer_size,
2791 alg, hash, hash_length,
2792 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002793 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002794
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002795 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002796}
2797
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002798psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2799 psa_algorithm_t alg,
2800 const uint8_t * input,
2801 size_t input_length,
2802 uint8_t * signature,
2803 size_t signature_size,
2804 size_t * signature_length )
2805{
2806 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002807 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002808 signature, signature_size, signature_length );
2809}
2810
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002811psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002812 const psa_key_attributes_t *attributes,
2813 const uint8_t *key_buffer,
2814 size_t key_buffer_size,
2815 psa_algorithm_t alg,
2816 const uint8_t *input,
2817 size_t input_length,
2818 const uint8_t *signature,
2819 size_t signature_length )
2820{
2821 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002822
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002823 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2824 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002825 size_t hash_length;
2826 uint8_t hash[PSA_HASH_MAX_SIZE];
2827
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002828 status = psa_driver_wrapper_hash_compute(
2829 PSA_ALG_SIGN_GET_HASH( alg ),
2830 input, input_length,
2831 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002832
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002833 if( status != PSA_SUCCESS )
2834 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002835
2836 return psa_driver_wrapper_verify_hash(
2837 attributes, key_buffer, key_buffer_size,
2838 alg, hash, hash_length,
2839 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002840 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002841
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002842 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002843}
2844
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002845psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2846 psa_algorithm_t alg,
2847 const uint8_t * input,
2848 size_t input_length,
2849 const uint8_t * signature,
2850 size_t signature_length )
2851{
2852 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002853 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002854 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002855}
2856
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002857psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002858 const psa_key_attributes_t *attributes,
2859 const uint8_t *key_buffer, size_t key_buffer_size,
2860 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2861 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002862{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002863 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002864 {
Ronald Cron4501c982021-03-19 20:09:32 +01002865 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2866 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002867 {
Ronald Cron4501c982021-03-19 20:09:32 +01002868#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2869 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2870 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002871 attributes,
2872 key_buffer, key_buffer_size,
2873 alg, hash, hash_length,
2874 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002875#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2876 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002877 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002878 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002879 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002880 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002881 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002882 }
2883 else
Ronald Cron4501c982021-03-19 20:09:32 +01002884 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2885 {
2886 if( PSA_ALG_IS_ECDSA( alg ) )
2887 {
2888#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2889 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2890 return( mbedtls_psa_ecdsa_sign_hash(
2891 attributes,
2892 key_buffer, key_buffer_size,
2893 alg, hash, hash_length,
2894 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002895#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2896 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002897 }
2898 else
2899 {
2900 return( PSA_ERROR_INVALID_ARGUMENT );
2901 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002902 }
Ronald Cron4501c982021-03-19 20:09:32 +01002903
2904 (void)key_buffer;
2905 (void)key_buffer_size;
2906 (void)hash;
2907 (void)hash_length;
2908 (void)signature;
2909 (void)signature_size;
2910 (void)signature_length;
2911
2912 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002913}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002914
2915psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2916 psa_algorithm_t alg,
2917 const uint8_t *hash,
2918 size_t hash_length,
2919 uint8_t *signature,
2920 size_t signature_size,
2921 size_t *signature_length )
2922{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002923 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002924 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002925 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002926}
2927
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002928psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002929 const psa_key_attributes_t *attributes,
2930 const uint8_t *key_buffer, size_t key_buffer_size,
2931 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2932 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002933{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002934 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002935 {
Ronald Cron4501c982021-03-19 20:09:32 +01002936 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2937 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002938 {
Ronald Cron4501c982021-03-19 20:09:32 +01002939#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2940 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2941 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002942 attributes,
2943 key_buffer, key_buffer_size,
2944 alg, hash, hash_length,
2945 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002946#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2947 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002948 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002949 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002950 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002951 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002952 }
itayzafrir5c753392018-05-08 11:18:38 +03002953 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002954 else
Ronald Cron4501c982021-03-19 20:09:32 +01002955 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002956 {
Ronald Cron4501c982021-03-19 20:09:32 +01002957 if( PSA_ALG_IS_ECDSA( alg ) )
2958 {
2959#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2960 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2961 return( mbedtls_psa_ecdsa_verify_hash(
2962 attributes,
2963 key_buffer, key_buffer_size,
2964 alg, hash, hash_length,
2965 signature, signature_length ) );
2966#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2967 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2968 }
2969 else
2970 {
2971 return( PSA_ERROR_INVALID_ARGUMENT );
2972 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002973 }
Ronald Cron4501c982021-03-19 20:09:32 +01002974
2975 (void)key_buffer;
2976 (void)key_buffer_size;
2977 (void)hash;
2978 (void)hash_length;
2979 (void)signature;
2980 (void)signature_length;
2981
2982 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002983}
2984
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002985psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2986 psa_algorithm_t alg,
2987 const uint8_t *hash,
2988 size_t hash_length,
2989 const uint8_t *signature,
2990 size_t signature_length )
2991{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002992 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002993 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002994 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002995}
2996
John Durkop0e005192020-10-31 22:06:54 -07002997#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002998static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2999 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003000{
3001 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3002 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3003 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003004
3005 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003006}
John Durkop0e005192020-10-31 22:06:54 -07003007#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003008
Ronald Croncf56a0a2020-08-04 09:51:30 +02003009psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003010 psa_algorithm_t alg,
3011 const uint8_t *input,
3012 size_t input_length,
3013 const uint8_t *salt,
3014 size_t salt_length,
3015 uint8_t *output,
3016 size_t output_size,
3017 size_t *output_length )
3018{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003019 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003020 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003021 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003022
Darryl Green5cc689a2018-07-24 15:34:10 +01003023 (void) input;
3024 (void) input_length;
3025 (void) salt;
3026 (void) output;
3027 (void) output_size;
3028
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003029 *output_length = 0;
3030
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003031 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3032 return( PSA_ERROR_INVALID_ARGUMENT );
3033
Ronald Cron5c522922020-11-14 16:35:34 +01003034 status = psa_get_and_lock_transparent_key_slot_with_policy(
3035 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003036 if( status != PSA_SUCCESS )
3037 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003038 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3039 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003040 {
3041 status = PSA_ERROR_INVALID_ARGUMENT;
3042 goto exit;
3043 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003044
John Durkop6ba40d12020-11-10 08:50:04 -08003045#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3046 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003047 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003048 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003049 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003050 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3051 slot->key.data,
3052 slot->key.bytes,
3053 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003054 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003055 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003056
3057 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003058 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003059 status = PSA_ERROR_BUFFER_TOO_SMALL;
3060 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003061 }
John Durkop0e005192020-10-31 22:06:54 -07003062#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003063 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3064 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003065 status = mbedtls_to_psa_error(
3066 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003067 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003068 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003069 input_length,
3070 input,
3071 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003072 }
3073 else
John Durkop0e005192020-10-31 22:06:54 -07003074#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3075#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003076 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3077 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003078 status = mbedtls_to_psa_error(
3079 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3080 if( status != PSA_SUCCESS )
3081 goto rsa_exit;
3082
Steven Cooreman4fed4552020-08-03 14:46:03 +02003083 status = mbedtls_to_psa_error(
3084 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003085 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003086 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003087 salt, salt_length,
3088 input_length,
3089 input,
3090 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003091 }
3092 else
John Durkop0e005192020-10-31 22:06:54 -07003093#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003094 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003095 status = PSA_ERROR_INVALID_ARGUMENT;
3096 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003098rsa_exit:
3099 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003100 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003101
Steven Cooremana2371e52020-07-28 14:30:39 +02003102 mbedtls_rsa_free( rsa );
3103 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003105 else
John Durkop9814fa22020-11-04 12:28:15 -08003106#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003107 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003109 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003110 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003111
3112exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003113 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003114
Ronald Cron5c522922020-11-14 16:35:34 +01003115 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003116}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003117
Ronald Croncf56a0a2020-08-04 09:51:30 +02003118psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003119 psa_algorithm_t alg,
3120 const uint8_t *input,
3121 size_t input_length,
3122 const uint8_t *salt,
3123 size_t salt_length,
3124 uint8_t *output,
3125 size_t output_size,
3126 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003128 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003129 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003130 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003131
Darryl Green5cc689a2018-07-24 15:34:10 +01003132 (void) input;
3133 (void) input_length;
3134 (void) salt;
3135 (void) output;
3136 (void) output_size;
3137
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003138 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003140 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3141 return( PSA_ERROR_INVALID_ARGUMENT );
3142
Ronald Cron5c522922020-11-14 16:35:34 +01003143 status = psa_get_and_lock_transparent_key_slot_with_policy(
3144 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003145 if( status != PSA_SUCCESS )
3146 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003147 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003148 {
3149 status = PSA_ERROR_INVALID_ARGUMENT;
3150 goto exit;
3151 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003152
John Durkop6ba40d12020-11-10 08:50:04 -08003153#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3154 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003155 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003157 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003158 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3159 slot->key.data,
3160 slot->key.bytes,
3161 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003162 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003163 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003164
Steven Cooremana2371e52020-07-28 14:30:39 +02003165 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003166 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003167 status = PSA_ERROR_INVALID_ARGUMENT;
3168 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003169 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003170
John Durkop0e005192020-10-31 22:06:54 -07003171#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003172 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003173 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003174 status = mbedtls_to_psa_error(
3175 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003176 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003177 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003178 output_length,
3179 input,
3180 output,
3181 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003182 }
3183 else
John Durkop0e005192020-10-31 22:06:54 -07003184#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3185#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003186 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003187 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003188 status = mbedtls_to_psa_error(
3189 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3190 if( status != PSA_SUCCESS )
3191 goto rsa_exit;
3192
Steven Cooreman4fed4552020-08-03 14:46:03 +02003193 status = mbedtls_to_psa_error(
3194 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003195 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003196 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003197 salt, salt_length,
3198 output_length,
3199 input,
3200 output,
3201 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003202 }
3203 else
John Durkop0e005192020-10-31 22:06:54 -07003204#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003206 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003207 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003208
Steven Cooreman4fed4552020-08-03 14:46:03 +02003209rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003210 mbedtls_rsa_free( rsa );
3211 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003212 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003213 else
John Durkop6ba40d12020-11-10 08:50:04 -08003214#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3215 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003216 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003217 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003218 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003219
3220exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003221 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003222
Ronald Cron5c522922020-11-14 16:35:34 +01003223 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003224}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003225
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003226
3227
mohammad1603503973b2018-03-12 15:59:30 +02003228/****************************************************************/
3229/* Symmetric cryptography */
3230/****************************************************************/
3231
Ronald Cronab99ac22020-10-01 16:38:28 +02003232static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3233 mbedtls_svc_key_id_t key,
3234 psa_algorithm_t alg,
3235 mbedtls_operation_t cipher_operation )
3236{
3237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3238 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003239 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003240 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3241 PSA_KEY_USAGE_ENCRYPT :
3242 PSA_KEY_USAGE_DECRYPT );
3243
3244 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003245 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003246 {
Dave Rodgman54648242021-06-24 11:49:45 +01003247 status = PSA_ERROR_BAD_STATE;
3248 goto exit;
3249 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003250
Ronald Cronab99ac22020-10-01 16:38:28 +02003251 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003252 {
Dave Rodgman54648242021-06-24 11:49:45 +01003253 status = PSA_ERROR_INVALID_ARGUMENT;
3254 goto exit;
3255 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003256
Ronald Cronab99ac22020-10-01 16:38:28 +02003257 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3258 if( status != PSA_SUCCESS )
3259 goto exit;
3260
Ronald Cron49fafa92021-03-10 08:34:23 +01003261 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003262 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003263 * so we only set it (in the driver wrapper) after resources have been
3264 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003265 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003266 if( alg == PSA_ALG_ECB_NO_PADDING )
3267 operation->iv_required = 0;
3268 else
3269 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003270 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003271
Ronald Crona4af55f2020-12-14 14:36:06 +01003272 psa_key_attributes_t attributes = {
3273 .core = slot->attr
3274 };
3275
Ronald Cronab99ac22020-10-01 16:38:28 +02003276 /* Try doing the operation through a driver before using software fallback. */
3277 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003278 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3279 &attributes,
3280 slot->key.data,
3281 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003282 alg );
3283 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003284 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3285 &attributes,
3286 slot->key.data,
3287 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003288 alg );
3289
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003290exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003291 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003292 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003293
Ronald Cron5c522922020-11-14 16:35:34 +01003294 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003295
Ronald Cron5c522922020-11-14 16:35:34 +01003296 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003297}
3298
Gilles Peskinefe119512018-07-08 21:39:34 +02003299psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003300 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003301 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003302{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003303 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003304}
3305
Gilles Peskinefe119512018-07-08 21:39:34 +02003306psa_status_t psa_cipher_decrypt_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_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003311}
3312
Gilles Peskinefe119512018-07-08 21:39:34 +02003313psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003314 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003315 size_t iv_size,
3316 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003317{
Ronald Cron6d051732020-10-01 14:10:20 +02003318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003319
Ronald Cron5618a392021-03-26 09:52:26 +01003320 *iv_length = 0;
3321
Ronald Cron49fafa92021-03-10 08:34:23 +01003322 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003323 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003324 status = PSA_ERROR_BAD_STATE;
3325 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003326 }
3327
Steven Cooreman7df02922020-09-09 15:28:49 +02003328 if( operation->iv_set || ! operation->iv_required )
3329 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003330 status = PSA_ERROR_BAD_STATE;
3331 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003332 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003333
Ronald Cron5618a392021-03-26 09:52:26 +01003334 if( iv_size < operation->default_iv_length )
3335 {
3336 status = PSA_ERROR_BUFFER_TOO_SMALL;
3337 goto exit;
3338 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003339
Ronald Cron5618a392021-03-26 09:52:26 +01003340 status = psa_generate_random( iv, operation->default_iv_length );
3341 if( status != PSA_SUCCESS )
3342 goto exit;
3343
3344 status = psa_driver_wrapper_cipher_set_iv( operation,
3345 iv,
3346 operation->default_iv_length );
3347
3348exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003349 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003350 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003351 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003352 *iv_length = operation->default_iv_length;
3353 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003354 else
Moran Peker395db872018-05-31 14:07:14 +03003355 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003356
itayzafrir534bd7c2018-08-02 13:56:32 +03003357 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003358}
3359
Gilles Peskinefe119512018-07-08 21:39:34 +02003360psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003361 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003362 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003363{
Ronald Cron6d051732020-10-01 14:10:20 +02003364 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003365
Ronald Cron49fafa92021-03-10 08:34:23 +01003366 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003367 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003368 status = PSA_ERROR_BAD_STATE;
3369 goto exit;
3370 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003371
Steven Cooreman7df02922020-09-09 15:28:49 +02003372 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003373 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003374 status = PSA_ERROR_BAD_STATE;
3375 goto exit;
3376 }
Ronald Crona0d68172021-03-26 10:15:08 +01003377
3378 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003379 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003380 status = PSA_ERROR_INVALID_ARGUMENT;
3381 goto exit;
3382 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003383
Ronald Crondd24c9b2020-12-15 14:10:01 +01003384 status = psa_driver_wrapper_cipher_set_iv( operation,
3385 iv,
3386 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003387
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003388exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003389 if( status == PSA_SUCCESS )
3390 operation->iv_set = 1;
3391 else
mohammad1603503973b2018-03-12 15:59:30 +02003392 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003393 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003394}
3395
Gilles Peskinee553c652018-06-04 16:22:46 +02003396psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3397 const uint8_t *input,
3398 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003399 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003400 size_t output_size,
3401 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003402{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003404
Ronald Cron49fafa92021-03-10 08:34:23 +01003405 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003406 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003407 status = PSA_ERROR_BAD_STATE;
3408 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003409 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003410
Steven Cooreman7df02922020-09-09 15:28:49 +02003411 if( operation->iv_required && ! operation->iv_set )
3412 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003413 status = PSA_ERROR_BAD_STATE;
3414 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003415 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003416
Ronald Crondd24c9b2020-12-15 14:10:01 +01003417 status = psa_driver_wrapper_cipher_update( operation,
3418 input,
3419 input_length,
3420 output,
3421 output_size,
3422 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003423
3424exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003425 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003426 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003427
itayzafrir534bd7c2018-08-02 13:56:32 +03003428 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003429}
3430
Gilles Peskinee553c652018-06-04 16:22:46 +02003431psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3432 uint8_t *output,
3433 size_t output_size,
3434 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003435{
David Saadab4ecc272019-02-14 13:48:10 +02003436 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003437
Ronald Cron49fafa92021-03-10 08:34:23 +01003438 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003439 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003440 status = PSA_ERROR_BAD_STATE;
3441 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003442 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003443
Steven Cooreman7df02922020-09-09 15:28:49 +02003444 if( operation->iv_required && ! operation->iv_set )
3445 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003446 status = PSA_ERROR_BAD_STATE;
3447 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003448 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003449
Ronald Crondd24c9b2020-12-15 14:10:01 +01003450 status = psa_driver_wrapper_cipher_finish( operation,
3451 output,
3452 output_size,
3453 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003454
3455exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003456 if( status == PSA_SUCCESS )
3457 return( psa_cipher_abort( operation ) );
3458 else
3459 {
3460 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003461 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003462
Steven Cooremanef8575e2020-09-11 11:44:50 +02003463 return( status );
3464 }
mohammad1603503973b2018-03-12 15:59:30 +02003465}
3466
Gilles Peskinee553c652018-06-04 16:22:46 +02003467psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3468{
Ronald Cron49fafa92021-03-10 08:34:23 +01003469 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003470 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003471 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003472 * in use. It's ok to call abort on such an object, and there's
3473 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003474 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003475 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003476
Ronald Crondd24c9b2020-12-15 14:10:01 +01003477 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003478
Ronald Cron49fafa92021-03-10 08:34:23 +01003479 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003480 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003481 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003482
Moran Peker395db872018-05-31 14:07:14 +03003483 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003484}
3485
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003486psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3487 psa_algorithm_t alg,
3488 const uint8_t *input,
3489 size_t input_length,
3490 uint8_t *output,
3491 size_t output_size,
3492 size_t *output_length )
3493{
3494 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003495 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3496 psa_key_slot_t *slot;
3497 psa_key_type_t key_type;
3498 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003499
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003500 *output_length = 0;
3501
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003502 if( ! PSA_ALG_IS_CIPHER( alg ) )
3503 return( PSA_ERROR_INVALID_ARGUMENT );
3504
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003505 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3506 PSA_KEY_USAGE_ENCRYPT,
3507 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003508 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003509 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003510
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003511 psa_key_attributes_t attributes = {
3512 .core = slot->attr
3513 };
3514
3515 key_type = slot->attr.type;
3516 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3517
3518 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003519 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003520 if( output_size < iv_length )
3521 {
3522 status = PSA_ERROR_BUFFER_TOO_SMALL;
3523 goto exit;
3524 }
3525
3526 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003527 if( status != PSA_SUCCESS )
3528 goto exit;
3529 }
3530
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003531 status = psa_driver_wrapper_cipher_encrypt(
3532 &attributes, slot->key.data, slot->key.bytes,
3533 alg, input, input_length,
3534 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003535
3536exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003537 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003538
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003539 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003540}
3541
3542psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3543 psa_algorithm_t alg,
3544 const uint8_t *input,
3545 size_t input_length,
3546 uint8_t *output,
3547 size_t output_size,
3548 size_t *output_length )
3549{
3550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003551 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3552 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003553
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003554 *output_length = 0;
3555
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003556 if( ! PSA_ALG_IS_CIPHER( alg ) )
3557 return( PSA_ERROR_INVALID_ARGUMENT );
3558
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003559 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3560 PSA_KEY_USAGE_DECRYPT,
3561 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003562 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003563 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003564
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003565 psa_key_attributes_t attributes = {
3566 .core = slot->attr
3567 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003568
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003569 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3570 {
3571 status = PSA_ERROR_INVALID_ARGUMENT;
3572 goto exit;
3573 }
3574
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003575 status = psa_driver_wrapper_cipher_decrypt(
3576 &attributes, slot->key.data, slot->key.bytes,
3577 alg, input, input_length,
3578 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003579
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003580exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003581 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003582
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003583 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003584}
3585
3586
mohammad16035955c982018-04-26 00:53:03 +03003587/****************************************************************/
3588/* AEAD */
3589/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003590
Ronald Croncf56a0a2020-08-04 09:51:30 +02003591psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003592 psa_algorithm_t alg,
3593 const uint8_t *nonce,
3594 size_t nonce_length,
3595 const uint8_t *additional_data,
3596 size_t additional_data_length,
3597 const uint8_t *plaintext,
3598 size_t plaintext_length,
3599 uint8_t *ciphertext,
3600 size_t ciphertext_size,
3601 size_t *ciphertext_length )
3602{
Ronald Cron215633c2021-03-16 17:15:37 +01003603 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3604 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003605
mohammad1603f08a5502018-06-03 15:05:47 +03003606 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003607
Steven Cooremanea7ab132021-03-17 16:28:00 +01003608 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3609 return( PSA_ERROR_NOT_SUPPORTED );
3610
Ronald Cron9a986162021-03-26 12:40:07 +01003611 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003612 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003613 if( status != PSA_SUCCESS )
3614 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003615
Ronald Cron215633c2021-03-16 17:15:37 +01003616 psa_key_attributes_t attributes = {
3617 .core = slot->attr
3618 };
mohammad16035955c982018-04-26 00:53:03 +03003619
Ronald Cronde822812021-03-17 16:08:20 +01003620 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003621 &attributes, slot->key.data, slot->key.bytes,
3622 alg,
3623 nonce, nonce_length,
3624 additional_data, additional_data_length,
3625 plaintext, plaintext_length,
3626 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003627
Gilles Peskineedf9a652018-08-17 18:11:56 +02003628 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3629 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003630
Ronald Cron9f310172021-03-16 16:36:37 +01003631 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003632
mohammad16035955c982018-04-26 00:53:03 +03003633 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003634}
3635
Ronald Croncf56a0a2020-08-04 09:51:30 +02003636psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003637 psa_algorithm_t alg,
3638 const uint8_t *nonce,
3639 size_t nonce_length,
3640 const uint8_t *additional_data,
3641 size_t additional_data_length,
3642 const uint8_t *ciphertext,
3643 size_t ciphertext_length,
3644 uint8_t *plaintext,
3645 size_t plaintext_size,
3646 size_t *plaintext_length )
3647{
Ronald Cron215633c2021-03-16 17:15:37 +01003648 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3649 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003650
Gilles Peskineee652a32018-06-01 19:23:52 +02003651 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003652
Steven Cooremanea7ab132021-03-17 16:28:00 +01003653 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3654 return( PSA_ERROR_NOT_SUPPORTED );
3655
Ronald Cron9a986162021-03-26 12:40:07 +01003656 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003657 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003658 if( status != PSA_SUCCESS )
3659 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003660
Ronald Cron215633c2021-03-16 17:15:37 +01003661 psa_key_attributes_t attributes = {
3662 .core = slot->attr
3663 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003664
Ronald Cronde822812021-03-17 16:08:20 +01003665 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003666 &attributes, slot->key.data, slot->key.bytes,
3667 alg,
3668 nonce, nonce_length,
3669 additional_data, additional_data_length,
3670 ciphertext, ciphertext_length,
3671 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003672
Gilles Peskineedf9a652018-08-17 18:11:56 +02003673 if( status != PSA_SUCCESS && plaintext_size != 0 )
3674 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003675
Ronald Cron215633c2021-03-16 17:15:37 +01003676 psa_unlock_key_slot( slot );
3677
Gilles Peskineedf9a652018-08-17 18:11:56 +02003678 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003679}
3680
Gilles Peskinee59236f2018-01-27 23:32:46 +01003681/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003682/* Generators */
3683/****************************************************************/
3684
John Durkop07cc04a2020-11-16 22:08:34 -08003685#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3686 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3687 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3688#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003689#endif /* At least one builtin KDF */
3690
3691#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3692 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3693 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3694static psa_status_t psa_key_derivation_start_hmac(
3695 psa_mac_operation_t *operation,
3696 psa_algorithm_t hash_alg,
3697 const uint8_t *hmac_key,
3698 size_t hmac_key_length )
3699{
3700 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3701 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3702 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3703 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3704 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3705
Steven Cooreman72f736a2021-05-07 14:14:37 +02003706 operation->is_sign = 1;
3707 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3708
Steven Cooreman094a77e2021-05-06 17:58:36 +02003709 status = psa_driver_wrapper_mac_sign_setup( operation,
3710 &attributes,
3711 hmac_key, hmac_key_length,
3712 PSA_ALG_HMAC( hash_alg ) );
3713
3714 psa_reset_key_attributes( &attributes );
3715 return( status );
3716}
3717#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003718
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003719#define HKDF_STATE_INIT 0 /* no input yet */
3720#define HKDF_STATE_STARTED 1 /* got salt */
3721#define HKDF_STATE_KEYED 2 /* got key */
3722#define HKDF_STATE_OUTPUT 3 /* output started */
3723
Gilles Peskinecbe66502019-05-16 16:59:18 +02003724static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003725 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003726{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003727 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3728 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003729 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003730 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003731}
3732
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003733psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003734{
3735 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003736 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003737 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003738 {
3739 /* The object has (apparently) been initialized but it is not
3740 * in use. It's ok to call abort on such an object, and there's
3741 * nothing to do. */
3742 }
3743 else
John Durkopd0321952020-10-29 21:37:36 -07003744#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003745 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003746 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003747 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003748 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003749 }
John Durkop07cc04a2020-11-16 22:08:34 -08003750 else
3751#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3752#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3753 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3754 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003755 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003756 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003757 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003758 if( operation->ctx.tls12_prf.secret != NULL )
3759 {
3760 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3761 operation->ctx.tls12_prf.secret_length );
3762 mbedtls_free( operation->ctx.tls12_prf.secret );
3763 }
3764
Janos Follath6a1d2622019-06-11 10:37:28 +01003765 if( operation->ctx.tls12_prf.seed != NULL )
3766 {
3767 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3768 operation->ctx.tls12_prf.seed_length );
3769 mbedtls_free( operation->ctx.tls12_prf.seed );
3770 }
3771
3772 if( operation->ctx.tls12_prf.label != NULL )
3773 {
3774 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3775 operation->ctx.tls12_prf.label_length );
3776 mbedtls_free( operation->ctx.tls12_prf.label );
3777 }
3778
Steven Cooremana6df6042021-04-29 19:32:25 +02003779 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003780
3781 /* We leave the fields Ai and output_block to be erased safely by the
3782 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003783 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003784 else
John Durkop07cc04a2020-11-16 22:08:34 -08003785#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3786 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003787 {
3788 status = PSA_ERROR_BAD_STATE;
3789 }
Janos Follath083036a2019-06-11 10:22:26 +01003790 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003791 return( status );
3792}
3793
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003794psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003795 size_t *capacity)
3796{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003797 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003798 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003799 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003800 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003801 }
3802
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003803 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003804 return( PSA_SUCCESS );
3805}
3806
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003807psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003808 size_t capacity )
3809{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003810 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003811 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003812 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003813 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003814 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003815 return( PSA_SUCCESS );
3816}
3817
John Durkopd0321952020-10-29 21:37:36 -07003818#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003819/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003820 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003821static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003822 psa_algorithm_t hash_alg,
3823 uint8_t *output,
3824 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003825{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003826 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003827 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003828 psa_status_t status;
3829
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003830 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3831 return( PSA_ERROR_BAD_STATE );
3832 hkdf->state = HKDF_STATE_OUTPUT;
3833
Gilles Peskinebef7f142018-07-12 17:22:21 +02003834 while( output_length != 0 )
3835 {
3836 /* Copy what remains of the current block */
3837 uint8_t n = hash_length - hkdf->offset_in_block;
3838 if( n > output_length )
3839 n = (uint8_t) output_length;
3840 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3841 output += n;
3842 output_length -= n;
3843 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003844 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003845 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003846 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003847 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003848 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003849 * object was corrupted or if this function is called directly
3850 * inside the library. */
3851 if( hkdf->block_number == 0xff )
3852 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003853
3854 /* We need a new block */
3855 ++hkdf->block_number;
3856 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003857
Steven Cooreman094a77e2021-05-06 17:58:36 +02003858 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3859 hash_alg,
3860 hkdf->prk,
3861 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003862 if( status != PSA_SUCCESS )
3863 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003864
Gilles Peskinebef7f142018-07-12 17:22:21 +02003865 if( hkdf->block_number != 1 )
3866 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003867 status = psa_mac_update( &hkdf->hmac,
3868 hkdf->output_block,
3869 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003870 if( status != PSA_SUCCESS )
3871 return( status );
3872 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003873 status = psa_mac_update( &hkdf->hmac,
3874 hkdf->info,
3875 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003876 if( status != PSA_SUCCESS )
3877 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003878 status = psa_mac_update( &hkdf->hmac,
3879 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003880 if( status != PSA_SUCCESS )
3881 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003882 status = psa_mac_sign_finish( &hkdf->hmac,
3883 hkdf->output_block,
3884 sizeof( hkdf->output_block ),
3885 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003886 if( status != PSA_SUCCESS )
3887 return( status );
3888 }
3889
3890 return( PSA_SUCCESS );
3891}
John Durkop07cc04a2020-11-16 22:08:34 -08003892#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003893
John Durkop07cc04a2020-11-16 22:08:34 -08003894#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3895 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003896static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3897 psa_tls12_prf_key_derivation_t *tls12_prf,
3898 psa_algorithm_t alg )
3899{
3900 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003901 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003902 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3903 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003904 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003905
Janos Follath7742fee2019-06-17 12:58:10 +01003906 /* We can't be wanting more output after block 0xff, otherwise
3907 * the capacity check in psa_key_derivation_output_bytes() would have
3908 * prevented this call. It could happen only if the operation
3909 * object was corrupted or if this function is called directly
3910 * inside the library. */
3911 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003912 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003913
3914 /* We need a new block */
3915 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003916 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003917
3918 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3919 *
3920 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3921 *
3922 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3923 * HMAC_hash(secret, A(2) + seed) +
3924 * HMAC_hash(secret, A(3) + seed) + ...
3925 *
3926 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003927 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003928 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003929 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003930 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003931 * is currently extracted as `output_block` and where i is
3932 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003933 */
3934
Steven Cooreman094a77e2021-05-06 17:58:36 +02003935 status = psa_key_derivation_start_hmac( &hmac,
3936 hash_alg,
3937 tls12_prf->secret,
3938 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003939 if( status != PSA_SUCCESS )
3940 goto cleanup;
3941
3942 /* Calculate A(i) where i = tls12_prf->block_number. */
3943 if( tls12_prf->block_number == 1 )
3944 {
3945 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3946 * the variable seed and in this instance means it in the context of the
3947 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003948 status = psa_mac_update( &hmac,
3949 tls12_prf->label,
3950 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003951 if( status != PSA_SUCCESS )
3952 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003953 status = psa_mac_update( &hmac,
3954 tls12_prf->seed,
3955 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003956 if( status != PSA_SUCCESS )
3957 goto cleanup;
3958 }
3959 else
3960 {
3961 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003962 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003963 if( status != PSA_SUCCESS )
3964 goto cleanup;
3965 }
3966
Steven Cooremana6df6042021-04-29 19:32:25 +02003967 status = psa_mac_sign_finish( &hmac,
3968 tls12_prf->Ai, hash_length,
3969 &hmac_output_length );
3970 if( hmac_output_length != hash_length )
3971 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003972 if( status != PSA_SUCCESS )
3973 goto cleanup;
3974
3975 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003976 status = psa_key_derivation_start_hmac( &hmac,
3977 hash_alg,
3978 tls12_prf->secret,
3979 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003980 if( status != PSA_SUCCESS )
3981 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003982 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003983 if( status != PSA_SUCCESS )
3984 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003985 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003986 if( status != PSA_SUCCESS )
3987 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003988 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003989 if( status != PSA_SUCCESS )
3990 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003991 status = psa_mac_sign_finish( &hmac,
3992 tls12_prf->output_block, hash_length,
3993 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003994 if( status != PSA_SUCCESS )
3995 goto cleanup;
3996
Janos Follath7742fee2019-06-17 12:58:10 +01003997
3998cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003999 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004000 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4001 status = cleanup_status;
4002
4003 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004004}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004005
Janos Follath844eb0e2019-06-19 12:10:49 +01004006static psa_status_t psa_key_derivation_tls12_prf_read(
4007 psa_tls12_prf_key_derivation_t *tls12_prf,
4008 psa_algorithm_t alg,
4009 uint8_t *output,
4010 size_t output_length )
4011{
4012 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004013 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004014 psa_status_t status;
4015 uint8_t offset, length;
4016
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004017 switch( tls12_prf->state )
4018 {
4019 case PSA_TLS12_PRF_STATE_LABEL_SET:
4020 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4021 break;
4022 case PSA_TLS12_PRF_STATE_OUTPUT:
4023 break;
4024 default:
4025 return( PSA_ERROR_BAD_STATE );
4026 }
4027
Janos Follath844eb0e2019-06-19 12:10:49 +01004028 while( output_length != 0 )
4029 {
4030 /* Check if we have fully processed the current block. */
4031 if( tls12_prf->left_in_block == 0 )
4032 {
4033 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4034 alg );
4035 if( status != PSA_SUCCESS )
4036 return( status );
4037
4038 continue;
4039 }
4040
4041 if( tls12_prf->left_in_block > output_length )
4042 length = (uint8_t) output_length;
4043 else
4044 length = tls12_prf->left_in_block;
4045
4046 offset = hash_length - tls12_prf->left_in_block;
4047 memcpy( output, tls12_prf->output_block + offset, length );
4048 output += length;
4049 output_length -= length;
4050 tls12_prf->left_in_block -= length;
4051 }
4052
4053 return( PSA_SUCCESS );
4054}
John Durkop07cc04a2020-11-16 22:08:34 -08004055#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4056 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004057
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004058psa_status_t psa_key_derivation_output_bytes(
4059 psa_key_derivation_operation_t *operation,
4060 uint8_t *output,
4061 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004062{
4063 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004064 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004065
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004066 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004067 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004068 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004069 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004070 }
4071
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004072 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004073 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004074 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004075 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004076 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004077 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004078 goto exit;
4079 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004080 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004081 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004082 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004083 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004084 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4085 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004086 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004087 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004088 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004089 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004090 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004091
John Durkopd0321952020-10-29 21:37:36 -07004092#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004093 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004094 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004095 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004096 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004097 output, output_length );
4098 }
Janos Follathadbec812019-06-14 11:05:39 +01004099 else
John Durkop07cc04a2020-11-16 22:08:34 -08004100#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4101#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4102 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004103 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004104 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004105 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004106 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004107 kdf_alg, output,
4108 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004109 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004110 else
John Durkop07cc04a2020-11-16 22:08:34 -08004111#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4112 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004113 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004114 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004115 return( PSA_ERROR_BAD_STATE );
4116 }
4117
4118exit:
4119 if( status != PSA_SUCCESS )
4120 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004121 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004122 * This allows us to differentiate between exhausted operations and
4123 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4124 * operations. */
4125 psa_algorithm_t alg = operation->alg;
4126 psa_key_derivation_abort( operation );
4127 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004128 memset( output, '!', output_length );
4129 }
4130 return( status );
4131}
4132
David Brown7807bf72021-02-09 16:28:23 -07004133#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004134static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4135{
4136 if( data_size >= 8 )
4137 mbedtls_des_key_set_parity( data );
4138 if( data_size >= 16 )
4139 mbedtls_des_key_set_parity( data + 8 );
4140 if( data_size >= 24 )
4141 mbedtls_des_key_set_parity( data + 16 );
4142}
David Brown7807bf72021-02-09 16:28:23 -07004143#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004144
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004145static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004146 psa_key_slot_t *slot,
4147 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004148 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004149{
4150 uint8_t *data = NULL;
4151 size_t bytes = PSA_BITS_TO_BYTES( bits );
4152 psa_status_t status;
4153
Gilles Peskine8e338702019-07-30 20:06:31 +02004154 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004155 return( PSA_ERROR_INVALID_ARGUMENT );
4156 if( bits % 8 != 0 )
4157 return( PSA_ERROR_INVALID_ARGUMENT );
4158 data = mbedtls_calloc( 1, bytes );
4159 if( data == NULL )
4160 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4161
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004162 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004163 if( status != PSA_SUCCESS )
4164 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004165#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004166 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004167 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004168#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004169
4170 status = psa_allocate_buffer_to_slot( slot, bytes );
4171 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004172 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004173
Ronald Cronbf33c932020-11-28 18:06:53 +01004174 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004175 psa_key_attributes_t attributes = {
4176 .core = slot->attr
4177 };
4178
Ronald Cronbf33c932020-11-28 18:06:53 +01004179 status = psa_driver_wrapper_import_key( &attributes,
4180 data, bytes,
4181 slot->key.data,
4182 slot->key.bytes,
4183 &slot->key.bytes, &bits );
4184 if( bits != slot->attr.bits )
4185 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004186
4187exit:
4188 mbedtls_free( data );
4189 return( status );
4190}
4191
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004192psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004193 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004194 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004195{
4196 psa_status_t status;
4197 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004198 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004199
Ronald Cron81709fc2020-11-14 12:10:32 +01004200 *key = MBEDTLS_SVC_KEY_ID_INIT;
4201
Gilles Peskine0f84d622019-09-12 19:03:13 +02004202 /* Reject any attempt to create a zero-length key so that we don't
4203 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4204 if( psa_get_key_bits( attributes ) == 0 )
4205 return( PSA_ERROR_INVALID_ARGUMENT );
4206
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004207 if( ! operation->can_output_key )
4208 return( PSA_ERROR_NOT_PERMITTED );
4209
Ronald Cron81709fc2020-11-14 12:10:32 +01004210 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4211 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004212#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4213 if( driver != NULL )
4214 {
4215 /* Deriving a key in a secure element is not implemented yet. */
4216 status = PSA_ERROR_NOT_SUPPORTED;
4217 }
4218#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004219 if( status == PSA_SUCCESS )
4220 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004221 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004222 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004223 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004224 }
4225 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004226 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004227 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004228 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004229
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004230 return( status );
4231}
4232
Gilles Peskineeab56e42018-07-12 17:12:33 +02004233
4234
4235/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004236/* Key derivation */
4237/****************************************************************/
4238
Steven Cooreman932ffb72021-02-15 12:14:32 +01004239#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004240static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004241 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004242 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004243{
John Durkop07cc04a2020-11-16 22:08:34 -08004244 int is_kdf_alg_supported;
4245
Janos Follath5fe19732019-06-20 15:09:30 +01004246 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4247 * initialisers for this union leave some bytes unspecified.) */
4248 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4249
Gilles Peskine969c5d62019-01-16 15:53:06 +01004250 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004251#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004252 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4253 is_kdf_alg_supported = 1;
4254 else
4255#endif
4256#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4257 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4258 is_kdf_alg_supported = 1;
4259 else
4260#endif
4261#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4262 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4263 is_kdf_alg_supported = 1;
4264 else
4265#endif
4266 is_kdf_alg_supported = 0;
4267
4268 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004269 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004270 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004271 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004272 if( hash_size == 0 )
4273 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004274 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4275 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004276 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004277 {
4278 return( PSA_ERROR_NOT_SUPPORTED );
4279 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004280 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004281 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004282 }
John Durkop07cc04a2020-11-16 22:08:34 -08004283
4284 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004285}
John Durkop07cc04a2020-11-16 22:08:34 -08004286#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004287
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004288psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004289 psa_algorithm_t alg )
4290{
4291 psa_status_t status;
4292
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004293 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004294 return( PSA_ERROR_BAD_STATE );
4295
Gilles Peskine6843c292019-01-18 16:44:49 +01004296 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4297 return( PSA_ERROR_INVALID_ARGUMENT );
4298 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004299 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004300#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004301 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004302 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004303#else
4304 return( PSA_ERROR_NOT_SUPPORTED );
4305#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004306 }
4307 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4308 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004309#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004310 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004311#else
4312 return( PSA_ERROR_NOT_SUPPORTED );
4313#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004314 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004315 else
4316 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004317
4318 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004319 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004320 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004321}
4322
John Durkopd0321952020-10-29 21:37:36 -07004323#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004324static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004325 psa_algorithm_t hash_alg,
4326 psa_key_derivation_step_t step,
4327 const uint8_t *data,
4328 size_t data_length )
4329{
4330 psa_status_t status;
4331 switch( step )
4332 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004333 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004334 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004335 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004336 else
4337 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004338 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4339 hash_alg,
4340 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004341 if( status != PSA_SUCCESS )
4342 return( status );
4343 hkdf->state = HKDF_STATE_STARTED;
4344 return( PSA_SUCCESS );
4345 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004346 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004347 /* If no salt was provided, use an empty salt. */
4348 if( hkdf->state == HKDF_STATE_INIT )
4349 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004350 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4351 hash_alg,
4352 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004353 if( status != PSA_SUCCESS )
4354 return( status );
4355 hkdf->state = HKDF_STATE_STARTED;
4356 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004357 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004358 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004359 status = psa_mac_update( &hkdf->hmac,
4360 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004361 if( status != PSA_SUCCESS )
4362 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004363 status = psa_mac_sign_finish( &hkdf->hmac,
4364 hkdf->prk,
4365 sizeof( hkdf->prk ),
4366 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004367 if( status != PSA_SUCCESS )
4368 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004369 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004370 hkdf->block_number = 0;
4371 hkdf->state = HKDF_STATE_KEYED;
4372 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004373 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004374 if( hkdf->state == HKDF_STATE_OUTPUT )
4375 return( PSA_ERROR_BAD_STATE );
4376 if( hkdf->info_set )
4377 return( PSA_ERROR_BAD_STATE );
4378 hkdf->info_length = data_length;
4379 if( data_length != 0 )
4380 {
4381 hkdf->info = mbedtls_calloc( 1, data_length );
4382 if( hkdf->info == NULL )
4383 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4384 memcpy( hkdf->info, data, data_length );
4385 }
4386 hkdf->info_set = 1;
4387 return( PSA_SUCCESS );
4388 default:
4389 return( PSA_ERROR_INVALID_ARGUMENT );
4390 }
4391}
John Durkop07cc04a2020-11-16 22:08:34 -08004392#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004393
John Durkop07cc04a2020-11-16 22:08:34 -08004394#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4395 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004396static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4397 const uint8_t *data,
4398 size_t data_length )
4399{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004400 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004401 return( PSA_ERROR_BAD_STATE );
4402
Janos Follathd6dce9f2019-07-04 09:11:38 +01004403 if( data_length != 0 )
4404 {
4405 prf->seed = mbedtls_calloc( 1, data_length );
4406 if( prf->seed == NULL )
4407 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004408
Janos Follathd6dce9f2019-07-04 09:11:38 +01004409 memcpy( prf->seed, data, data_length );
4410 prf->seed_length = data_length;
4411 }
Janos Follathf08e2652019-06-13 09:05:41 +01004412
Gilles Peskine43f958b2020-12-13 14:55:14 +01004413 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004414
4415 return( PSA_SUCCESS );
4416}
4417
Janos Follath81550542019-06-13 14:26:34 +01004418static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004419 const uint8_t *data,
4420 size_t data_length )
4421{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004422 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004423 return( PSA_ERROR_BAD_STATE );
4424
Steven Cooremana6df6042021-04-29 19:32:25 +02004425 if( data_length != 0 )
4426 {
4427 prf->secret = mbedtls_calloc( 1, data_length );
4428 if( prf->secret == NULL )
4429 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4430
4431 memcpy( prf->secret, data, data_length );
4432 prf->secret_length = data_length;
4433 }
Janos Follath81550542019-06-13 14:26:34 +01004434
Gilles Peskine43f958b2020-12-13 14:55:14 +01004435 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004436
4437 return( PSA_SUCCESS );
4438}
4439
Janos Follath63028dd2019-06-13 09:15:47 +01004440static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4441 const uint8_t *data,
4442 size_t data_length )
4443{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004444 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004445 return( PSA_ERROR_BAD_STATE );
4446
Janos Follathd6dce9f2019-07-04 09:11:38 +01004447 if( data_length != 0 )
4448 {
4449 prf->label = mbedtls_calloc( 1, data_length );
4450 if( prf->label == NULL )
4451 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004452
Janos Follathd6dce9f2019-07-04 09:11:38 +01004453 memcpy( prf->label, data, data_length );
4454 prf->label_length = data_length;
4455 }
Janos Follath63028dd2019-06-13 09:15:47 +01004456
Gilles Peskine43f958b2020-12-13 14:55:14 +01004457 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004458
4459 return( PSA_SUCCESS );
4460}
4461
Janos Follathb03233e2019-06-11 15:30:30 +01004462static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004463 psa_key_derivation_step_t step,
4464 const uint8_t *data,
4465 size_t data_length )
4466{
Janos Follathb03233e2019-06-11 15:30:30 +01004467 switch( step )
4468 {
Janos Follathf08e2652019-06-13 09:05:41 +01004469 case PSA_KEY_DERIVATION_INPUT_SEED:
4470 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004471 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004472 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004473 case PSA_KEY_DERIVATION_INPUT_LABEL:
4474 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004475 default:
4476 return( PSA_ERROR_INVALID_ARGUMENT );
4477 }
4478}
John Durkop07cc04a2020-11-16 22:08:34 -08004479#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4480 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4481
4482#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4483static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4484 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004485 const uint8_t *data,
4486 size_t data_length )
4487{
4488 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004489 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004490 uint8_t *cur = pms;
4491
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004492 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004493 return( PSA_ERROR_INVALID_ARGUMENT );
4494
4495 /* Quoting RFC 4279, Section 2:
4496 *
4497 * The premaster secret is formed as follows: if the PSK is N octets
4498 * long, concatenate a uint16 with the value N, N zero octets, a second
4499 * uint16 with the value N, and the PSK itself.
4500 */
4501
Joe Subbiani5ecac212021-06-24 13:00:03 +01004502 *cur++ = MBEDTLS_BYTE_1( data_length );
4503 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004504 memset( cur, 0, data_length );
4505 cur += data_length;
4506 *cur++ = pms[0];
4507 *cur++ = pms[1];
4508 memcpy( cur, data, data_length );
4509 cur += data_length;
4510
Steven Cooremana6df6042021-04-29 19:32:25 +02004511 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004512
4513 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4514 return( status );
4515}
Janos Follath6660f0e2019-06-17 08:44:03 +01004516
4517static psa_status_t psa_tls12_prf_psk_to_ms_input(
4518 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004519 psa_key_derivation_step_t step,
4520 const uint8_t *data,
4521 size_t data_length )
4522{
4523 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004524 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004525 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004526 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004527 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004528
Steven Cooremana6df6042021-04-29 19:32:25 +02004529 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004530}
John Durkop07cc04a2020-11-16 22:08:34 -08004531#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004532
Gilles Peskineb8965192019-09-24 16:21:10 +02004533/** Check whether the given key type is acceptable for the given
4534 * input step of a key derivation.
4535 *
4536 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4537 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4538 * Both secret and non-secret inputs can alternatively have the type
4539 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4540 * that the input was passed as a buffer rather than via a key object.
4541 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004542static int psa_key_derivation_check_input_type(
4543 psa_key_derivation_step_t step,
4544 psa_key_type_t key_type )
4545{
4546 switch( step )
4547 {
4548 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004549 if( key_type == PSA_KEY_TYPE_DERIVE )
4550 return( PSA_SUCCESS );
4551 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004552 return( PSA_SUCCESS );
4553 break;
4554 case PSA_KEY_DERIVATION_INPUT_LABEL:
4555 case PSA_KEY_DERIVATION_INPUT_SALT:
4556 case PSA_KEY_DERIVATION_INPUT_INFO:
4557 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004558 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4559 return( PSA_SUCCESS );
4560 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004561 return( PSA_SUCCESS );
4562 break;
4563 }
4564 return( PSA_ERROR_INVALID_ARGUMENT );
4565}
4566
Janos Follathb80a94e2019-06-12 15:54:46 +01004567static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004568 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004569 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004570 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004571 const uint8_t *data,
4572 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004573{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004574 psa_status_t status;
4575 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4576
4577 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004578 if( status != PSA_SUCCESS )
4579 goto exit;
4580
John Durkopd0321952020-10-29 21:37:36 -07004581#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004582 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004583 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004584 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004585 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004586 step, data, data_length );
4587 }
John Durkop07cc04a2020-11-16 22:08:34 -08004588 else
4589#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4590#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4591 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004592 {
Janos Follathb03233e2019-06-11 15:30:30 +01004593 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004594 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004595 }
John Durkop07cc04a2020-11-16 22:08:34 -08004596 else
4597#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4598#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4599 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004600 {
4601 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004602 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004603 }
4604 else
John Durkop07cc04a2020-11-16 22:08:34 -08004605#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004606 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004607 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004608 (void) data;
4609 (void) data_length;
4610 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004611 return( PSA_ERROR_BAD_STATE );
4612 }
4613
Gilles Peskine224b0d62019-09-23 18:13:17 +02004614exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004615 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004616 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004617 return( status );
4618}
4619
Janos Follath51f4a0f2019-06-14 11:35:55 +01004620psa_status_t psa_key_derivation_input_bytes(
4621 psa_key_derivation_operation_t *operation,
4622 psa_key_derivation_step_t step,
4623 const uint8_t *data,
4624 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004625{
Gilles Peskineb8965192019-09-24 16:21:10 +02004626 return( psa_key_derivation_input_internal( operation, step,
4627 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004628 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004629}
4630
Janos Follath51f4a0f2019-06-14 11:35:55 +01004631psa_status_t psa_key_derivation_input_key(
4632 psa_key_derivation_operation_t *operation,
4633 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004634 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004635{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004636 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004637 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004638 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004639
Ronald Cron5c522922020-11-14 16:35:34 +01004640 status = psa_get_and_lock_transparent_key_slot_with_policy(
4641 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004642 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004643 {
4644 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004645 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004646 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004647
4648 /* Passing a key object as a SECRET input unlocks the permission
4649 * to output to a key object. */
4650 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4651 operation->can_output_key = 1;
4652
Ronald Cronf95a2b12020-10-22 15:24:49 +02004653 status = psa_key_derivation_input_internal( operation,
4654 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004655 slot->key.data,
4656 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004657
Ronald Cron5c522922020-11-14 16:35:34 +01004658 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004659
Ronald Cron5c522922020-11-14 16:35:34 +01004660 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004661}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004662
4663
4664
4665/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004666/* Key agreement */
4667/****************************************************************/
4668
John Durkop6ba40d12020-11-10 08:50:04 -08004669#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004670static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4671 size_t peer_key_length,
4672 const mbedtls_ecp_keypair *our_key,
4673 uint8_t *shared_secret,
4674 size_t shared_secret_size,
4675 size_t *shared_secret_length )
4676{
Steven Cooremand4867872020-08-05 16:31:39 +02004677 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004678 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004679 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004680 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004681 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004682 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004683
Ronald Cron90857082020-11-25 14:58:33 +01004684 status = mbedtls_psa_ecp_load_representation(
4685 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004686 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004687 peer_key,
4688 peer_key_length,
4689 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004690 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004691 goto exit;
4692
Jaeden Amero97271b32019-01-10 19:38:51 +00004693 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004694 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004695 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004696 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004697 status = mbedtls_to_psa_error(
4698 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4699 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004700 goto exit;
4701
Jaeden Amero97271b32019-01-10 19:38:51 +00004702 status = mbedtls_to_psa_error(
4703 mbedtls_ecdh_calc_secret( &ecdh,
4704 shared_secret_length,
4705 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004706 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004707 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004708 if( status != PSA_SUCCESS )
4709 goto exit;
4710 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4711 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004712
4713exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004714 if( status != PSA_SUCCESS )
4715 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004716 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004717 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004718 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004719
Jaeden Amero97271b32019-01-10 19:38:51 +00004720 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004721}
John Durkop6ba40d12020-11-10 08:50:04 -08004722#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004723
Gilles Peskine01d718c2018-09-18 12:01:02 +02004724#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4725
Gilles Peskine0216fe12019-04-11 21:23:21 +02004726static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4727 psa_key_slot_t *private_key,
4728 const uint8_t *peer_key,
4729 size_t peer_key_length,
4730 uint8_t *shared_secret,
4731 size_t shared_secret_size,
4732 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004733{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004734 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004735 {
John Durkop6ba40d12020-11-10 08:50:04 -08004736#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004737 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004738 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004739 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004740 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004741 psa_status_t status = mbedtls_psa_ecp_load_representation(
4742 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004743 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004744 private_key->key.data,
4745 private_key->key.bytes,
4746 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004747 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004748 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004749 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004750 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004751 shared_secret, shared_secret_size,
4752 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004753 mbedtls_ecp_keypair_free( ecp );
4754 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004755 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004756#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004757 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004758 (void) private_key;
4759 (void) peer_key;
4760 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004761 (void) shared_secret;
4762 (void) shared_secret_size;
4763 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004764 return( PSA_ERROR_NOT_SUPPORTED );
4765 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004766}
4767
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004768/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004769 * to potentially free embedded data structures and wipe confidential data.
4770 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004771static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004772 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004773 psa_key_slot_t *private_key,
4774 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004775 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004776{
4777 psa_status_t status;
4778 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4779 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004780 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004781
4782 /* Step 1: run the secret agreement algorithm to generate the shared
4783 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004784 status = psa_key_agreement_raw_internal( ka_alg,
4785 private_key,
4786 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004787 shared_secret,
4788 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004789 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004790 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004791 goto exit;
4792
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004793 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004794 * the shared secret. A shared secret is permitted wherever a key
4795 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004796 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004797 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004798 shared_secret,
4799 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004800exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004801 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004802 return( status );
4803}
4804
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004805psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004806 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004807 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004808 const uint8_t *peer_key,
4809 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004810{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004811 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004812 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004813 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004814
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004815 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004816 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004817 status = psa_get_and_lock_transparent_key_slot_with_policy(
4818 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004819 if( status != PSA_SUCCESS )
4820 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004821 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004822 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004823 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004824 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004825 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004826 else
4827 {
4828 /* If a private key has been added as SECRET, we allow the derived
4829 * key material to be used as a key in PSA Crypto. */
4830 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4831 operation->can_output_key = 1;
4832 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004833
Ronald Cron5c522922020-11-14 16:35:34 +01004834 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004835
Ronald Cron5c522922020-11-14 16:35:34 +01004836 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004837}
4838
Gilles Peskinebe697d82019-05-16 18:00:41 +02004839psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004840 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004841 const uint8_t *peer_key,
4842 size_t peer_key_length,
4843 uint8_t *output,
4844 size_t output_size,
4845 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004846{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004847 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004848 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004849 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004850
4851 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4852 {
4853 status = PSA_ERROR_INVALID_ARGUMENT;
4854 goto exit;
4855 }
Ronald Cron5c522922020-11-14 16:35:34 +01004856 status = psa_get_and_lock_transparent_key_slot_with_policy(
4857 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004858 if( status != PSA_SUCCESS )
4859 goto exit;
4860
4861 status = psa_key_agreement_raw_internal( alg, slot,
4862 peer_key, peer_key_length,
4863 output, output_size,
4864 output_length );
4865
4866exit:
4867 if( status != PSA_SUCCESS )
4868 {
4869 /* If an error happens and is not handled properly, the output
4870 * may be used as a key to protect sensitive data. Arrange for such
4871 * a key to be random, which is likely to result in decryption or
4872 * verification errors. This is better than filling the buffer with
4873 * some constant data such as zeros, which would result in the data
4874 * being protected with a reproducible, easily knowable key.
4875 */
4876 psa_generate_random( output, output_size );
4877 *output_length = output_size;
4878 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004879
Ronald Cron5c522922020-11-14 16:35:34 +01004880 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004881
Ronald Cron5c522922020-11-14 16:35:34 +01004882 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004883}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004884
4885
Gilles Peskine30524eb2020-11-13 17:02:26 +01004886
Gilles Peskine86a440b2018-11-12 18:39:40 +01004887/****************************************************************/
4888/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004889/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004890
Gilles Peskine30524eb2020-11-13 17:02:26 +01004891/** Initialize the PSA random generator.
4892 */
4893static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4894{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004895#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4896 memset( rng, 0, sizeof( *rng ) );
4897#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4898
Gilles Peskine30524eb2020-11-13 17:02:26 +01004899 /* Set default configuration if
4900 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4901 if( rng->entropy_init == NULL )
4902 rng->entropy_init = mbedtls_entropy_init;
4903 if( rng->entropy_free == NULL )
4904 rng->entropy_free = mbedtls_entropy_free;
4905
4906 rng->entropy_init( &rng->entropy );
4907#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4908 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4909 /* The PSA entropy injection feature depends on using NV seed as an entropy
4910 * source. Add NV seed as an entropy source for PSA entropy injection. */
4911 mbedtls_entropy_add_source( &rng->entropy,
4912 mbedtls_nv_seed_poll, NULL,
4913 MBEDTLS_ENTROPY_BLOCK_SIZE,
4914 MBEDTLS_ENTROPY_SOURCE_STRONG );
4915#endif
4916
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004917 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004918#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004919}
4920
4921/** Deinitialize the PSA random generator.
4922 */
4923static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4924{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004925#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4926 memset( rng, 0, sizeof( *rng ) );
4927#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004928 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004929 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004930#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004931}
4932
4933/** Seed the PSA random generator.
4934 */
4935static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4936{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004937#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4938 /* Do nothing: the external RNG seeds itself. */
4939 (void) rng;
4940 return( PSA_SUCCESS );
4941#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004942 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004943 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4944 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004945 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004946#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004947}
4948
Gilles Peskinee59236f2018-01-27 23:32:46 +01004949psa_status_t psa_generate_random( uint8_t *output,
4950 size_t output_size )
4951{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004952 GUARD_MODULE_INITIALIZED;
4953
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004954#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4955
4956 size_t output_length = 0;
4957 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4958 output, output_size,
4959 &output_length );
4960 if( status != PSA_SUCCESS )
4961 return( status );
4962 /* Breaking up a request into smaller chunks is currently not supported
4963 * for the extrernal RNG interface. */
4964 if( output_length != output_size )
4965 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4966 return( PSA_SUCCESS );
4967
4968#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4969
Gilles Peskine71ddab92021-01-04 21:01:07 +01004970 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004971 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004972 size_t request_size =
4973 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4974 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4975 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004976 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4977 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004978 if( ret != 0 )
4979 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004980 output_size -= request_size;
4981 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004982 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004983 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004984#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004985}
4986
Gilles Peskine8814fc42020-12-14 15:33:44 +01004987/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004988 *
4989 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4990 * `psa_generate_random(...)`. The state parameter is ignored since the
4991 * PSA API doesn't support passing an explicit state.
4992 *
4993 * In the non-external case, psa_generate_random() calls an
4994 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4995 * and semantics as mbedtls_psa_get_random(). As an optimization,
4996 * instead of doing this back-and-forth between the PSA API and the
4997 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4998 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004999 */
5000#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5001int mbedtls_psa_get_random( void *p_rng,
5002 unsigned char *output,
5003 size_t output_size )
5004{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005005 /* This function takes a pointer to the RNG state because that's what
5006 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5007 * its own state internally and doesn't let the caller access that state.
5008 * So we just ignore the state parameter, and in practice we'll pass
5009 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005010 (void) p_rng;
5011 psa_status_t status = psa_generate_random( output, output_size );
5012 if( status == PSA_SUCCESS )
5013 return( 0 );
5014 else
5015 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5016}
5017#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5018
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005019#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005020#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005021
Gilles Peskine7228da22019-07-15 11:06:15 +02005022psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005023 size_t seed_size )
5024{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005025 if( global_data.initialized )
5026 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005027
5028 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5029 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5030 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5031 return( PSA_ERROR_INVALID_ARGUMENT );
5032
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005033 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005034}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005035#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005036
Ronald Cron3772afe2021-02-08 16:10:05 +01005037/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005038 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005039 * \param type The key type
5040 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005041 *
5042 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005043 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005044 * \retval #PSA_ERROR_INVALID_ARGUMENT
5045 * The size in bits of the key is not valid.
5046 * \retval #PSA_ERROR_NOT_SUPPORTED
5047 * The type and/or the size in bits of the key or the combination of
5048 * the two is not supported.
5049 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005050static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5051 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005052{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005053 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005054
Gilles Peskinee59236f2018-01-27 23:32:46 +01005055 if( key_type_is_raw_bytes( type ) )
5056 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005057 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005058 if( status != PSA_SUCCESS )
5059 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005060 }
5061 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005062#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005063 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5064 {
5065 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5066 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005067
Ronald Cron01b2aba2020-10-05 09:42:02 +02005068 /* Accept only byte-aligned keys, for the same reasons as
5069 * in psa_import_rsa_key(). */
5070 if( bits % 8 != 0 )
5071 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005072 }
5073 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005074#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005075
Ronald Cron5c4d3862020-12-07 11:07:24 +01005076#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005077 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5078 {
Ronald Crond81ab562021-02-16 09:01:16 +01005079 /* To avoid empty block, return successfully here. */
5080 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005081 }
5082 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005083#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005084 {
5085 return( PSA_ERROR_NOT_SUPPORTED );
5086 }
5087
5088 return( PSA_SUCCESS );
5089}
5090
Ronald Cron55ed0592020-10-05 10:30:40 +02005091psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005092 const psa_key_attributes_t *attributes,
5093 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005094{
5095 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005096 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005097
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005098 if( ( attributes->domain_parameters == NULL ) &&
5099 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005100 return( PSA_ERROR_INVALID_ARGUMENT );
5101
Ronald Cron01b2aba2020-10-05 09:42:02 +02005102 if( key_type_is_raw_bytes( type ) )
5103 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005104 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005105 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005106 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005107
David Brown12ca5032021-02-11 11:02:00 -07005108#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005109 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005110 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005111#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005112 }
5113 else
5114
Jaeden Amero424fa932021-05-14 08:34:32 +01005115#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5116 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005117 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005118 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005119 return( mbedtls_psa_rsa_generate_key( attributes,
5120 key_buffer,
5121 key_buffer_size,
5122 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005123 }
5124 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005125#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5126 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005127
John Durkop9814fa22020-11-04 12:28:15 -08005128#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005129 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005130 {
Ronald Cron7023db52020-11-20 18:17:42 +01005131 return( mbedtls_psa_ecp_generate_key( attributes,
5132 key_buffer,
5133 key_buffer_size,
5134 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005135 }
5136 else
John Durkop9814fa22020-11-04 12:28:15 -08005137#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005138 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005139 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005140 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005141 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005142
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005143 return( PSA_SUCCESS );
5144}
Darryl Green0c6575a2018-11-07 16:05:30 +00005145
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005146psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005147 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005148{
5149 psa_status_t status;
5150 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005151 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005152 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005153
Ronald Cron81709fc2020-11-14 12:10:32 +01005154 *key = MBEDTLS_SVC_KEY_ID_INIT;
5155
Gilles Peskine0f84d622019-09-12 19:03:13 +02005156 /* Reject any attempt to create a zero-length key so that we don't
5157 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5158 if( psa_get_key_bits( attributes ) == 0 )
5159 return( PSA_ERROR_INVALID_ARGUMENT );
5160
Ronald Cron81709fc2020-11-14 12:10:32 +01005161 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5162 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005163 if( status != PSA_SUCCESS )
5164 goto exit;
5165
Ronald Cron977c2472020-10-13 08:32:21 +02005166 /* In the case of a transparent key or an opaque key stored in local
5167 * storage (thus not in the case of generating a key in a secure element
5168 * or cryptoprocessor with storage), we have to allocate a buffer to
5169 * hold the generated key material. */
5170 if( slot->key.data == NULL )
5171 {
5172 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5173 PSA_KEY_LOCATION_LOCAL_STORAGE )
5174 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005175 status = psa_validate_key_type_and_size_for_key_generation(
5176 attributes->core.type, attributes->core.bits );
5177 if( status != PSA_SUCCESS )
5178 goto exit;
5179
5180 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5181 attributes->core.type,
5182 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005183 }
5184 else
5185 {
5186 status = psa_driver_wrapper_get_key_buffer_size(
5187 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005188 if( status != PSA_SUCCESS )
5189 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005190 }
Ronald Cron977c2472020-10-13 08:32:21 +02005191
5192 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5193 if( status != PSA_SUCCESS )
5194 goto exit;
5195 }
5196
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005197 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005198 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005199
Ronald Cron2b56bc82020-10-05 10:02:26 +02005200 if( status != PSA_SUCCESS )
5201 psa_remove_key_data_from_memory( slot );
5202
Gilles Peskine11792082019-08-06 18:36:36 +02005203exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005204 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005205 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005206 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005207 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005208
Darryl Green0c6575a2018-11-07 16:05:30 +00005209 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005210}
5211
Gilles Peskinee59236f2018-01-27 23:32:46 +01005212/****************************************************************/
5213/* Module setup */
5214/****************************************************************/
5215
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005216#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005217psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5218 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5219 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5220{
5221 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5222 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005223 global_data.rng.entropy_init = entropy_init;
5224 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005225 return( PSA_SUCCESS );
5226}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005227#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005228
Gilles Peskinee59236f2018-01-27 23:32:46 +01005229void mbedtls_psa_crypto_free( void )
5230{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005231 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005232 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5233 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005234 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005235 }
5236 /* Wipe all remaining data, including configuration.
5237 * In particular, this sets all state indicator to the value
5238 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005239 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005240#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005241 /* Unregister all secure element drivers, so that we restart from
5242 * a pristine state. */
5243 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005244#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005245}
5246
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005247#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5248/** Recover a transaction that was interrupted by a power failure.
5249 *
5250 * This function is called during initialization, before psa_crypto_init()
5251 * returns. If this function returns a failure status, the initialization
5252 * fails.
5253 */
5254static psa_status_t psa_crypto_recover_transaction(
5255 const psa_crypto_transaction_t *transaction )
5256{
5257 switch( transaction->unknown.type )
5258 {
5259 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5260 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005261 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005262 * is implemented.
5263 * https://github.com/ARMmbed/mbed-crypto/issues/218
5264 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005265 default:
5266 /* We found an unsupported transaction in the storage.
5267 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005268 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005269 }
5270}
5271#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5272
Gilles Peskinee59236f2018-01-27 23:32:46 +01005273psa_status_t psa_crypto_init( void )
5274{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005275 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005276
Gilles Peskinec6b69072018-11-20 21:42:52 +01005277 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005278 if( global_data.initialized != 0 )
5279 return( PSA_SUCCESS );
5280
Gilles Peskine30524eb2020-11-13 17:02:26 +01005281 /* Initialize and seed the random generator. */
5282 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005283 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005284 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005285 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005286 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005287 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005288
Gilles Peskine66fb1262018-12-10 16:29:04 +01005289 status = psa_initialize_key_slots( );
5290 if( status != PSA_SUCCESS )
5291 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005292
Gilles Peskined9348f22019-10-01 15:22:29 +02005293#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5294 status = psa_init_all_se_drivers( );
5295 if( status != PSA_SUCCESS )
5296 goto exit;
5297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5298
Gilles Peskine4b734222019-07-24 15:56:31 +02005299#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005300 status = psa_crypto_load_transaction( );
5301 if( status == PSA_SUCCESS )
5302 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005303 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5304 if( status != PSA_SUCCESS )
5305 goto exit;
5306 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005307 }
5308 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5309 {
5310 /* There's no transaction to complete. It's all good. */
5311 status = PSA_SUCCESS;
5312 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005313#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005314
Gilles Peskinec6b69072018-11-20 21:42:52 +01005315 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005316 global_data.initialized = 1;
5317
5318exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005319 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005320 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005321 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005322}
5323
5324#endif /* MBEDTLS_PSA_CRYPTO_C */