blob: d88836b0a03e5a908a51faa849f4c4e1ef737b9c [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)
1204 if( psa_key_slot_is_external( slot ) )
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:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001215#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001216 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001217 * is not yet implemented.
1218 * https://github.com/ARMmbed/mbed-crypto/issues/216
1219 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001220 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001221 break;
1222#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001223 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001224 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001225
Ronald Cron90857082020-11-25 14:58:33 +01001226 status = mbedtls_psa_rsa_load_representation(
1227 slot->attr.type,
1228 slot->key.data,
1229 slot->key.bytes,
1230 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001231 if( status != PSA_SUCCESS )
1232 break;
1233
Steven Cooremana2371e52020-07-28 14:30:39 +02001234 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001235 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001236 mbedtls_rsa_free( rsa );
1237 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001238 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001239 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001240#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001241 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001242 default:
1243 /* Nothing else to do. */
1244 break;
1245 }
1246
1247 if( status != PSA_SUCCESS )
1248 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001249
Ronald Cron5c522922020-11-14 16:35:34 +01001250 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001251
Ronald Cron5c522922020-11-14 16:35:34 +01001252 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001253}
1254
Gilles Peskinec8000c02019-08-02 20:15:51 +02001255#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1256psa_status_t psa_get_key_slot_number(
1257 const psa_key_attributes_t *attributes,
1258 psa_key_slot_number_t *slot_number )
1259{
1260 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1261 {
1262 *slot_number = attributes->slot_number;
1263 return( PSA_SUCCESS );
1264 }
1265 else
1266 return( PSA_ERROR_INVALID_ARGUMENT );
1267}
1268#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1269
Ronald Crond18b5f82020-11-25 16:46:05 +01001270static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1271 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001272 uint8_t *data,
1273 size_t data_size,
1274 size_t *data_length )
1275{
Ronald Crond18b5f82020-11-25 16:46:05 +01001276 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001277 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001278 memcpy( data, key_buffer, key_buffer_size );
1279 memset( data + key_buffer_size, 0,
1280 data_size - key_buffer_size );
1281 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001282 return( PSA_SUCCESS );
1283}
1284
Ronald Cron7285cda2020-11-26 14:46:37 +01001285psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001286 const psa_key_attributes_t *attributes,
1287 const uint8_t *key_buffer, size_t key_buffer_size,
1288 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001289{
Ronald Crond18b5f82020-11-25 16:46:05 +01001290 psa_key_type_t type = attributes->core.type;
1291
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 if( key_type_is_raw_bytes( type ) ||
1293 PSA_KEY_TYPE_IS_RSA( type ) ||
1294 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001295 {
1296 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001297 key_buffer, key_buffer_size,
1298 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001299 }
1300 else
1301 {
1302 /* This shouldn't happen in the reference implementation, but
1303 it is valid for a special-purpose implementation to omit
1304 support for exporting certain key types. */
1305 return( PSA_ERROR_NOT_SUPPORTED );
1306 }
1307}
1308
1309psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1310 uint8_t *data,
1311 size_t data_size,
1312 size_t *data_length )
1313{
1314 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1315 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1316 psa_key_slot_t *slot;
1317
Ronald Crone907e552021-01-18 13:22:38 +01001318 /* Reject a zero-length output buffer now, since this can never be a
1319 * valid key representation. This way we know that data must be a valid
1320 * pointer and we can do things like memset(data, ..., data_size). */
1321 if( data_size == 0 )
1322 return( PSA_ERROR_BUFFER_TOO_SMALL );
1323
Ronald Cron9486f9d2020-11-26 13:36:23 +01001324 /* Set the key to empty now, so that even when there are errors, we always
1325 * set data_length to a value between 0 and data_size. On error, setting
1326 * the key to empty is a good choice because an empty key representation is
1327 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001328 *data_length = 0;
1329
Ronald Cron9486f9d2020-11-26 13:36:23 +01001330 /* Export requires the EXPORT flag. There is an exception for public keys,
1331 * which don't require any flag, but
1332 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1333 */
1334 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1335 PSA_KEY_USAGE_EXPORT, 0 );
1336 if( status != PSA_SUCCESS )
1337 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001338
Ronald Crond18b5f82020-11-25 16:46:05 +01001339 psa_key_attributes_t attributes = {
1340 .core = slot->attr
1341 };
Ronald Cron67227982020-11-26 15:16:05 +01001342 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 slot->key.data, slot->key.bytes,
1344 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001345
Ronald Cron9486f9d2020-11-26 13:36:23 +01001346 unlock_status = psa_unlock_key_slot( slot );
1347
1348 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1349}
1350
Ronald Cron7285cda2020-11-26 14:46:37 +01001351psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001352 const psa_key_attributes_t *attributes,
1353 const uint8_t *key_buffer,
1354 size_t key_buffer_size,
1355 uint8_t *data,
1356 size_t data_size,
1357 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001358{
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001360
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001362 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001364 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001365 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001366 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 key_buffer, key_buffer_size,
1368 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001369 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001370
Ronald Crond18b5f82020-11-25 16:46:05 +01001371 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001372 {
John Durkop0e005192020-10-31 22:06:54 -07001373#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001375 return( mbedtls_psa_rsa_export_public_key( attributes,
1376 key_buffer,
1377 key_buffer_size,
1378 data,
1379 data_size,
1380 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001381#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001382 /* We don't know how to convert a private RSA key to public. */
1383 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001384#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1385 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001386 }
1387 else
Moran Pekera998bc62018-04-16 18:16:20 +03001388 {
John Durkop6ba40d12020-11-10 08:50:04 -08001389#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1390 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001391 return( mbedtls_psa_ecp_export_public_key( attributes,
1392 key_buffer,
1393 key_buffer_size,
1394 data,
1395 data_size,
1396 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001397#else
1398 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001399 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001400#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1401 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001402 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001403 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001404 else
1405 {
1406 /* This shouldn't happen in the reference implementation, but
1407 it is valid for a special-purpose implementation to omit
1408 support for exporting certain key types. */
1409 return( PSA_ERROR_NOT_SUPPORTED );
1410 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001411}
Ronald Crond18b5f82020-11-25 16:46:05 +01001412
Ronald Croncf56a0a2020-08-04 09:51:30 +02001413psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001414 uint8_t *data,
1415 size_t data_size,
1416 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001417{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001419 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001420 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001421
Ronald Crone907e552021-01-18 13:22:38 +01001422 /* Reject a zero-length output buffer now, since this can never be a
1423 * valid key representation. This way we know that data must be a valid
1424 * pointer and we can do things like memset(data, ..., data_size). */
1425 if( data_size == 0 )
1426 return( PSA_ERROR_BUFFER_TOO_SMALL );
1427
Darryl Greendd8fb772018-11-07 16:00:44 +00001428 /* Set the key to empty now, so that even when there are errors, we always
1429 * set data_length to a value between 0 and data_size. On error, setting
1430 * the key to empty is a good choice because an empty key representation is
1431 * unlikely to be accepted anywhere. */
1432 *data_length = 0;
1433
1434 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001435 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001436 if( status != PSA_SUCCESS )
1437 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001438
Ronald Cron9486f9d2020-11-26 13:36:23 +01001439 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1440 {
1441 status = PSA_ERROR_INVALID_ARGUMENT;
1442 goto exit;
1443 }
1444
Ronald Crond18b5f82020-11-25 16:46:05 +01001445 psa_key_attributes_t attributes = {
1446 .core = slot->attr
1447 };
Ronald Cron67227982020-11-26 15:16:05 +01001448 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001449 &attributes, slot->key.data, slot->key.bytes,
1450 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001451
1452exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001453 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001454
Ronald Cron5c522922020-11-14 16:35:34 +01001455 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001456}
1457
Gilles Peskine91e8c332019-08-02 19:19:39 +02001458#if defined(static_assert)
1459static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1460 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001461static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001462 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001463static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001464 "One or more key attribute flag is listed as both internal-only and external-only" );
1465#endif
1466
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001467/** Validate that a key policy is internally well-formed.
1468 *
1469 * This function only rejects invalid policies. It does not validate the
1470 * consistency of the policy with respect to other attributes of the key
1471 * such as the key type.
1472 */
1473static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001474{
1475 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001476 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001477 PSA_KEY_USAGE_ENCRYPT |
1478 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001479 PSA_KEY_USAGE_SIGN_MESSAGE |
1480 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001481 PSA_KEY_USAGE_SIGN_HASH |
1482 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001483 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001484 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1485 return( PSA_ERROR_INVALID_ARGUMENT );
1486
Gilles Peskine4747d192019-04-17 15:05:45 +02001487 return( PSA_SUCCESS );
1488}
1489
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001490/** Validate the internal consistency of key attributes.
1491 *
1492 * This function only rejects invalid attribute values. If does not
1493 * validate the consistency of the attributes with any key data that may
1494 * be involved in the creation of the key.
1495 *
1496 * Call this function early in the key creation process.
1497 *
1498 * \param[in] attributes Key attributes for the new key.
1499 * \param[out] p_drv On any return, the driver for the key, if any.
1500 * NULL for a transparent key.
1501 *
1502 */
1503static psa_status_t psa_validate_key_attributes(
1504 const psa_key_attributes_t *attributes,
1505 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001506{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001507 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001508 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001509 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001510
Ronald Cron54b90082020-10-29 15:26:43 +01001511 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001512 if( status != PSA_SUCCESS )
1513 return( status );
1514
Ronald Crond2ed4812020-07-17 16:11:30 +02001515 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001516 if( status != PSA_SUCCESS )
1517 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001518
Ronald Cron65f38a32020-10-23 17:11:13 +02001519 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1520 {
1521 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1522 return( PSA_ERROR_INVALID_ARGUMENT );
1523 }
1524 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001525 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001526 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1527 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001528 }
1529
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001530 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001531 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001532 return( status );
1533
1534 /* Refuse to create overly large keys.
1535 * Note that this doesn't trigger on import if the attributes don't
1536 * explicitly specify a size (so psa_get_key_bits returns 0), so
1537 * psa_import_key() needs its own checks. */
1538 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1539 return( PSA_ERROR_NOT_SUPPORTED );
1540
Gilles Peskine91e8c332019-08-02 19:19:39 +02001541 /* Reject invalid flags. These should not be reachable through the API. */
1542 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1543 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1544 return( PSA_ERROR_INVALID_ARGUMENT );
1545
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001546 return( PSA_SUCCESS );
1547}
1548
Gilles Peskine4747d192019-04-17 15:05:45 +02001549/** Prepare a key slot to receive key material.
1550 *
1551 * This function allocates a key slot and sets its metadata.
1552 *
1553 * If this function fails, call psa_fail_key_creation().
1554 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001555 * This function is intended to be used as follows:
1556 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001557 * it with the specified attributes, and in case of a volatile key assign it
1558 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001559 * -# Populate the slot with the key material.
1560 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1561 * In case of failure at any step, stop the sequence and call
1562 * psa_fail_key_creation().
1563 *
Ronald Cron5c522922020-11-14 16:35:34 +01001564 * On success, the key slot is locked. It is the responsibility of the caller
1565 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001566 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001567 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001568 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001569 * \param[out] p_slot On success, a pointer to the prepared slot.
1570 * \param[out] p_drv On any return, the driver for the key, if any.
1571 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001572 *
1573 * \retval #PSA_SUCCESS
1574 * The key slot is ready to receive key material.
1575 * \return If this function fails, the key slot is an invalid state.
1576 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001577 */
1578static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001579 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001580 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001581 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001582 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001583{
1584 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001585 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 psa_key_slot_t *slot;
1587
Gilles Peskinedf179142019-07-15 22:02:14 +02001588 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001589 *p_drv = NULL;
1590
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001591 status = psa_validate_key_attributes( attributes, p_drv );
1592 if( status != PSA_SUCCESS )
1593 return( status );
1594
Ronald Cronc4d1b512020-07-31 11:26:37 +02001595 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001596 if( status != PSA_SUCCESS )
1597 return( status );
1598 slot = *p_slot;
1599
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001600 /* We're storing the declared bit-size of the key. It's up to each
1601 * creation mechanism to verify that this information is correct.
1602 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001603 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001604 * is optional (import, copy). In case of a volatile key, assign it the
1605 * volatile key identifier associated to the slot returned to contain its
1606 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001607
1608 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001609 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1610 {
1611#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1612 slot->attr.id = volatile_key_id;
1613#else
1614 slot->attr.id.key_id = volatile_key_id;
1615#endif
1616 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001617
Gilles Peskine91e8c332019-08-02 19:19:39 +02001618 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001619 * external-only flags, query `attributes`. Thanks to the check
1620 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001621 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001622 * may have set. */
1623 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001624
Gilles Peskinecbaff462019-07-12 23:46:04 +02001625#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001626 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001627 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001628 * create the key file in internal storage, create the
1629 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001630 * persistent data. This is done by starting a transaction that will
1631 * encompass these three actions.
1632 * For registering a volatile key, we just need to find an appropriate
1633 * slot number inside the SE. Since the key is designated volatile, creating
1634 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001635 /* The first thing to do is to find a slot number for the new key.
1636 * We save the slot number in persistent storage as part of the
1637 * transaction data. It will be needed to recover if the power
1638 * fails during the key creation process, to clean up on the secure
1639 * element side after restarting. Obtaining a slot number from the
1640 * secure element driver updates its persistent state, but we do not yet
1641 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001642 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001643 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001644 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001645 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001646 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001647 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001648 if( status != PSA_SUCCESS )
1649 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001650
1651 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001652 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001653 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1654 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001655 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001656 psa_crypto_transaction.key.id = slot->attr.id;
1657 status = psa_crypto_save_transaction( );
1658 if( status != PSA_SUCCESS )
1659 {
1660 (void) psa_crypto_stop_transaction( );
1661 return( status );
1662 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001663 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001664
1665 status = psa_copy_key_material_into_slot(
1666 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001667 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001668
1669 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1670 {
1671 /* Key registration only makes sense with a secure element. */
1672 return( PSA_ERROR_INVALID_ARGUMENT );
1673 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001674#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1675
Ronald Cronc4d1b512020-07-31 11:26:37 +02001676 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001677}
Gilles Peskine4747d192019-04-17 15:05:45 +02001678
1679/** Finalize the creation of a key once its key material has been set.
1680 *
1681 * This entails writing the key to persistent storage.
1682 *
1683 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001684 * See the documentation of psa_start_key_creation() for the intended use
1685 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001686 *
Ronald Cron5c522922020-11-14 16:35:34 +01001687 * If the finalization succeeds, the function unlocks the key slot (it was
1688 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1689 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001690 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001691 * \param[in,out] slot Pointer to the slot with key material.
1692 * \param[in] driver The secure element driver for the key,
1693 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001694 * \param[out] key On success, identifier of the key. Note that the
1695 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001696 *
1697 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001698 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001699 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1700 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1701 * \retval #PSA_ERROR_ALREADY_EXISTS
1702 * \retval #PSA_ERROR_DATA_INVALID
1703 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001704 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001705 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001706 * \return If this function fails, the key slot is an invalid state.
1707 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001708 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001709static psa_status_t psa_finish_key_creation(
1710 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001711 psa_se_drv_table_entry_t *driver,
1712 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001713{
1714 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001715 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001716 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001717
1718#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001719 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001720 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001721#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1722 if( driver != NULL )
1723 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001724 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001725 psa_key_slot_number_t slot_number =
1726 psa_key_slot_get_slot_number( slot ) ;
1727
Gilles Peskineb46bef22019-07-30 21:32:04 +02001728#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001730 sizeof( data.slot_number ),
1731 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001732#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001733 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001734 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001735 (uint8_t*) &data,
1736 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001737 }
1738 else
1739#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1740 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001741 /* Key material is saved in export representation in the slot, so
1742 * just pass the slot buffer for storage. */
1743 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001744 slot->key.data,
1745 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001746 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001747 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001748#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1749
Gilles Peskinecbaff462019-07-12 23:46:04 +02001750#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001751 /* Finish the transaction for a key creation. This does not
1752 * happen when registering an existing key. Detect this case
1753 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001754 * creation of a persistent key in a secure element requires a transaction,
1755 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001756 if( driver != NULL &&
1757 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001758 {
1759 status = psa_save_se_persistent_data( driver );
1760 if( status != PSA_SUCCESS )
1761 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001762 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001763 return( status );
1764 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001765 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001766 }
1767#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1768
Ronald Cron50972942020-11-14 11:28:25 +01001769 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001770 {
1771 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001772 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001773 if( status != PSA_SUCCESS )
1774 *key = MBEDTLS_SVC_KEY_ID_INIT;
1775 }
Ronald Cron50972942020-11-14 11:28:25 +01001776
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 return( status );
1778}
1779
1780/** Abort the creation of a key.
1781 *
1782 * You may call this function after calling psa_start_key_creation(),
1783 * or after psa_finish_key_creation() fails. In other circumstances, this
1784 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001785 * See the documentation of psa_start_key_creation() for the intended use
1786 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001788 * \param[in,out] slot Pointer to the slot with key material.
1789 * \param[in] driver The secure element driver for the key,
1790 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001791 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001792static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001793 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001794{
Gilles Peskine011e4282019-06-26 18:34:38 +02001795 (void) driver;
1796
Gilles Peskine4747d192019-04-17 15:05:45 +02001797 if( slot == NULL )
1798 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001799
1800#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001801 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001802 * element, and the failure happened later (when saving metadata
1803 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001804 * element.
1805 * https://github.com/ARMmbed/mbed-crypto/issues/217
1806 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001807
Gilles Peskined7729582019-08-05 15:55:54 +02001808 /* Abort the ongoing transaction if any (there may not be one if
1809 * the creation process failed before starting one, or if the
1810 * key creation is a registration of a key in a secure element).
1811 * Earlier functions must already have done what it takes to undo any
1812 * partial creation. All that's left is to update the transaction data
1813 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001814 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001815#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1816
Gilles Peskine4747d192019-04-17 15:05:45 +02001817 psa_wipe_key_slot( slot );
1818}
1819
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001820/** Validate optional attributes during key creation.
1821 *
1822 * Some key attributes are optional during key creation. If they are
1823 * specified in the attributes structure, check that they are consistent
1824 * with the data in the slot.
1825 *
1826 * This function should be called near the end of key creation, after
1827 * the slot in memory is fully populated but before saving persistent data.
1828 */
1829static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001830 const psa_key_slot_t *slot,
1831 const psa_key_attributes_t *attributes )
1832{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001833 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001834 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001835 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001836 return( PSA_ERROR_INVALID_ARGUMENT );
1837 }
1838
1839 if( attributes->domain_parameters_size != 0 )
1840 {
John Durkop0e005192020-10-31 22:06:54 -07001841#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1842 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001843 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001845 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001846 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001847 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001848
Ronald Cron90857082020-11-25 14:58:33 +01001849 psa_status_t status = mbedtls_psa_rsa_load_representation(
1850 slot->attr.type,
1851 slot->key.data,
1852 slot->key.bytes,
1853 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001854 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001855 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001856
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001857 mbedtls_mpi_init( &actual );
1858 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001859 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001861 mbedtls_rsa_free( rsa );
1862 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863 if( ret != 0 )
1864 goto rsa_exit;
1865 ret = mbedtls_mpi_read_binary( &required,
1866 attributes->domain_parameters,
1867 attributes->domain_parameters_size );
1868 if( ret != 0 )
1869 goto rsa_exit;
1870 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1871 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1872 rsa_exit:
1873 mbedtls_mpi_free( &actual );
1874 mbedtls_mpi_free( &required );
1875 if( ret != 0)
1876 return( mbedtls_to_psa_error( ret ) );
1877 }
1878 else
John Durkop9814fa22020-11-04 12:28:15 -08001879#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1880 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001881 {
1882 return( PSA_ERROR_INVALID_ARGUMENT );
1883 }
1884 }
1885
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001886 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001888 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001889 return( PSA_ERROR_INVALID_ARGUMENT );
1890 }
1891
1892 return( PSA_SUCCESS );
1893}
1894
Gilles Peskine4747d192019-04-17 15:05:45 +02001895psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001896 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001897 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001898 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001899{
1900 psa_status_t status;
1901 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001902 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001903 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904
Ronald Cron81709fc2020-11-14 12:10:32 +01001905 *key = MBEDTLS_SVC_KEY_ID_INIT;
1906
Gilles Peskine0f84d622019-09-12 19:03:13 +02001907 /* Reject zero-length symmetric keys (including raw data key objects).
1908 * This also rejects any key which might be encoded as an empty string,
1909 * which is never valid. */
1910 if( data_length == 0 )
1911 return( PSA_ERROR_INVALID_ARGUMENT );
1912
Gilles Peskinedf179142019-07-15 22:02:14 +02001913 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001914 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001915 if( status != PSA_SUCCESS )
1916 goto exit;
1917
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001918 /* In the case of a transparent key or an opaque key stored in local
1919 * storage (thus not in the case of generating a key in a secure element
1920 * or cryptoprocessor with storage), we have to allocate a buffer to
1921 * hold the generated key material. */
1922 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001923 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001924 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001925 if( status != PSA_SUCCESS )
1926 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001927 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001928
1929 bits = slot->attr.bits;
1930 status = psa_driver_wrapper_import_key( attributes,
1931 data, data_length,
1932 slot->key.data,
1933 slot->key.bytes,
1934 &slot->key.bytes, &bits );
1935 if( status != PSA_SUCCESS )
1936 goto exit;
1937
1938 if( slot->attr.bits == 0 )
1939 slot->attr.bits = (psa_key_bits_t) bits;
1940 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001941 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001942 status = PSA_ERROR_INVALID_ARGUMENT;
1943 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001944 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001945
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001946 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001947 if( status != PSA_SUCCESS )
1948 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001949
Ronald Cron81709fc2020-11-14 12:10:32 +01001950 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001951exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001952 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001953 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001954
Gilles Peskine4747d192019-04-17 15:05:45 +02001955 return( status );
1956}
1957
Gilles Peskined7729582019-08-05 15:55:54 +02001958#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1959psa_status_t mbedtls_psa_register_se_key(
1960 const psa_key_attributes_t *attributes )
1961{
1962 psa_status_t status;
1963 psa_key_slot_t *slot = NULL;
1964 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001965 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001966
1967 /* Leaving attributes unspecified is not currently supported.
1968 * It could make sense to query the key type and size from the
1969 * secure element, but not all secure elements support this
1970 * and the driver HAL doesn't currently support it. */
1971 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1972 return( PSA_ERROR_NOT_SUPPORTED );
1973 if( psa_get_key_bits( attributes ) == 0 )
1974 return( PSA_ERROR_NOT_SUPPORTED );
1975
1976 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001977 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001978 if( status != PSA_SUCCESS )
1979 goto exit;
1980
Ronald Cron81709fc2020-11-14 12:10:32 +01001981 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001982
1983exit:
1984 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001985 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001986
Gilles Peskined7729582019-08-05 15:55:54 +02001987 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001988 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001989 return( status );
1990}
1991#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1992
Gilles Peskinef603c712019-01-19 13:40:11 +01001993static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001994 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001995{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001996 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001997 source->key.data,
1998 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001999 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002000 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002001
Steven Cooreman398aee52020-10-13 14:35:45 +02002002 target->attr.type = source->attr.type;
2003 target->attr.bits = source->attr.bits;
2004
2005 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002006}
2007
Ronald Croncf56a0a2020-08-04 09:51:30 +02002008psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002009 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002010 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002011{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002013 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002014 psa_key_slot_t *source_slot = NULL;
2015 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002016 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002017 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002018
Ronald Cron81709fc2020-11-14 12:10:32 +01002019 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2020
Ronald Cron5c522922020-11-14 16:35:34 +01002021 status = psa_get_and_lock_transparent_key_slot_with_policy(
2022 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002023 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002024 goto exit;
2025
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002026 status = psa_validate_optional_attributes( source_slot,
2027 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002028 if( status != PSA_SUCCESS )
2029 goto exit;
2030
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002031 status = psa_restrict_key_policy( source_slot->attr.type,
2032 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002033 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002034 if( status != PSA_SUCCESS )
2035 goto exit;
2036
Ronald Cron81709fc2020-11-14 12:10:32 +01002037 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2038 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002039 if( status != PSA_SUCCESS )
2040 goto exit;
2041
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002042#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2043 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002044 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002045 /* Copying to a secure element is not implemented yet. */
2046 status = PSA_ERROR_NOT_SUPPORTED;
2047 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002048 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002049#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002050
Ronald Cron6cc66312021-04-02 12:27:47 +02002051 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2052 {
2053 /*
2054 * Copying through an opaque driver is not implemented yet, consider
2055 * a lifetime with an external location as an invalid parameter for
2056 * now.
2057 */
2058 status = PSA_ERROR_INVALID_ARGUMENT;
2059 goto exit;
2060 }
2061
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002062 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002063 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002064 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002065
Ronald Cron81709fc2020-11-14 12:10:32 +01002066 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002069 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002070
Ronald Cron5c522922020-11-14 16:35:34 +01002071 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002072
Ronald Cron5c522922020-11-14 16:35:34 +01002073 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002074}
2075
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002076
2077
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002078/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002079/* Message digests */
2080/****************************************************************/
2081
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002082psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2083{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002084 /* Aborting a non-active operation is allowed */
2085 if( operation->id == 0 )
2086 return( PSA_SUCCESS );
2087
2088 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2089 operation->id = 0;
2090
2091 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002092}
2093
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002094psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002095 psa_algorithm_t alg )
2096{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002098
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002099 /* A context must be freshly initialized before it can be set up. */
2100 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002101 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002102 status = PSA_ERROR_BAD_STATE;
2103 goto exit;
2104 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002105
2106 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002107 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002108 status = PSA_ERROR_INVALID_ARGUMENT;
2109 goto exit;
2110 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002111
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002112 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2113 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002114 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2115
Dave Rodgman685b6a72021-06-24 11:49:14 +01002116 status = psa_driver_wrapper_hash_setup( operation, alg );
2117
2118exit:
2119 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002120 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002121
2122 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002123}
2124
2125psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2126 const uint8_t *input,
2127 size_t input_length )
2128{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2130
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002131 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002132 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002133 status = PSA_ERROR_BAD_STATE;
2134 goto exit;
2135 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002136
Steven Cooremanc8288352021-03-04 14:02:19 +01002137 /* Don't require hash implementations to behave correctly on a
2138 * zero-length input, which may have an invalid pointer. */
2139 if( input_length == 0 )
2140 return( PSA_SUCCESS );
2141
Dave Rodgman685b6a72021-06-24 11:49:14 +01002142 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2143
2144exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002145 if( status != PSA_SUCCESS )
2146 psa_hash_abort( operation );
2147
2148 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002149}
2150
2151psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2152 uint8_t *hash,
2153 size_t hash_size,
2154 size_t *hash_length )
2155{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002156 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 if( operation->id == 0 )
2158 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002159
Steven Cooreman1e582352021-02-18 17:24:37 +01002160 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002161 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002162 psa_hash_abort( operation );
2163 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002164}
2165
Gilles Peskine2d277862018-06-18 15:41:12 +02002166psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2167 const uint8_t *hash,
2168 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169{
2170 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2171 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002172 psa_status_t status = psa_hash_finish(
2173 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002174 actual_hash, sizeof( actual_hash ),
2175 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002176
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002178 goto exit;
2179
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002180 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002181 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002182 status = PSA_ERROR_INVALID_SIGNATURE;
2183 goto exit;
2184 }
2185
Steven Cooreman36876a02021-04-29 16:37:59 +02002186 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002187 status = PSA_ERROR_INVALID_SIGNATURE;
2188
2189exit:
2190 if( status != PSA_SUCCESS )
2191 psa_hash_abort(operation);
2192
2193 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194}
2195
Gilles Peskine0a749c82019-11-28 19:33:58 +01002196psa_status_t psa_hash_compute( psa_algorithm_t alg,
2197 const uint8_t *input, size_t input_length,
2198 uint8_t *hash, size_t hash_size,
2199 size_t *hash_length )
2200{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002201 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002202 if( !PSA_ALG_IS_HASH( alg ) )
2203 return( PSA_ERROR_INVALID_ARGUMENT );
2204
Steven Cooreman1e582352021-02-18 17:24:37 +01002205 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2206 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002207}
2208
2209psa_status_t psa_hash_compare( psa_algorithm_t alg,
2210 const uint8_t *input, size_t input_length,
2211 const uint8_t *hash, size_t hash_length )
2212{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002213 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2214 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002215
2216 if( !PSA_ALG_IS_HASH( alg ) )
2217 return( PSA_ERROR_INVALID_ARGUMENT );
2218
Steven Cooreman1e582352021-02-18 17:24:37 +01002219 psa_status_t status = psa_driver_wrapper_hash_compute(
2220 alg, input, input_length,
2221 actual_hash, sizeof(actual_hash),
2222 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002223 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002224 return( status );
2225 if( actual_hash_length != hash_length )
2226 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002227 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002228 return( PSA_ERROR_INVALID_SIGNATURE );
2229 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002230}
2231
Gilles Peskineeb35d782019-01-22 17:56:16 +01002232psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2233 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002234{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002235 if( source_operation->id == 0 ||
2236 target_operation->id != 0 )
2237 {
2238 return( PSA_ERROR_BAD_STATE );
2239 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002240
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002241 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2242 target_operation );
2243 if( status != PSA_SUCCESS )
2244 psa_hash_abort( target_operation );
2245
2246 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002247}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248
2249
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002251/* MAC */
2252/****************************************************************/
2253
Steven Cooremane6804192021-03-19 18:28:56 +01002254psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002255{
Steven Cooremane6804192021-03-19 18:28:56 +01002256 /* Aborting a non-active operation is allowed */
2257 if( operation->id == 0 )
2258 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002259
Steven Cooremane6804192021-03-19 18:28:56 +01002260 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002261 operation->mac_size = 0;
2262 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002263 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002264
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002265 return( status );
2266}
2267
Ronald Cron2dff3b22021-06-17 16:33:22 +02002268static psa_status_t psa_mac_finalize_alg_and_key_validation(
2269 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002270 const psa_key_attributes_t *attributes,
2271 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002272{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002273 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002274 psa_key_type_t key_type = psa_get_key_type( attributes );
2275 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002276
Ronald Cron28ea0502021-06-17 16:10:24 +02002277 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002278 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002279
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002280 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002281 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002282 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002283 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002284
Steven Cooremand1a68f12021-05-10 11:13:41 +02002285 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002286 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002287
Ronald Cron79bdd822021-06-17 16:46:44 +02002288 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002289 {
2290 /* A very short MAC is too short for security since it can be
2291 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2292 * so we make this our minimum, even though 32 bits is still
2293 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002294 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002295 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002296
Ronald Cron79bdd822021-06-17 16:46:44 +02002297 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2298 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002299 {
2300 /* It's impossible to "truncate" to a larger length than the full length
2301 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002302 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002303 }
2304
Ronald Cron79bdd822021-06-17 16:46:44 +02002305 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002306}
2307
Gilles Peskinee59236f2018-01-27 23:32:46 +01002308static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2309 mbedtls_svc_key_id_t key,
2310 psa_algorithm_t alg,
2311 int is_sign )
2312{
2313 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2314 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002315 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002316
2317 /* A context must be freshly initialized before it can be set up. */
2318 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002319 {
Dave Rodgman54648242021-06-24 11:49:45 +01002320 status = PSA_ERROR_BAD_STATE;
2321 goto exit;
2322 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002323
Gilles Peskine8c9def32018-02-08 10:02:12 +01002324 status = psa_get_and_lock_key_slot_with_policy(
2325 key,
2326 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002327 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328 alg );
2329 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002330 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002331
2332 psa_key_attributes_t attributes = {
2333 .core = slot->attr
2334 };
2335
Ronald Cron79bdd822021-06-17 16:46:44 +02002336 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2337 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002338 if( status != PSA_SUCCESS )
2339 goto exit;
2340
2341 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002342 /* Dispatch the MAC setup call with validated input */
2343 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002344 {
Steven Cooremane6804192021-03-19 18:28:56 +01002345 status = psa_driver_wrapper_mac_sign_setup( operation,
2346 &attributes,
2347 slot->key.data,
2348 slot->key.bytes,
2349 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002350 }
2351 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002352 {
Steven Cooremane6804192021-03-19 18:28:56 +01002353 status = psa_driver_wrapper_mac_verify_setup( operation,
2354 &attributes,
2355 slot->key.data,
2356 slot->key.bytes,
2357 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002359
Gilles Peskinefbfac682018-07-08 20:51:54 +02002360exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002361 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002362 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002363
Ronald Cron5c522922020-11-14 16:35:34 +01002364 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002365
Ronald Cron5c522922020-11-14 16:35:34 +01002366 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002367}
2368
Gilles Peskine89167cb2018-07-08 20:12:23 +02002369psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002370 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002371 psa_algorithm_t alg )
2372{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002373 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002374}
2375
2376psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002377 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002378 psa_algorithm_t alg )
2379{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002380 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002381}
2382
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002383psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002384 const uint8_t *input,
2385 size_t input_length )
2386{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002387 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002388 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002389
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002390 /* Don't require hash implementations to behave correctly on a
2391 * zero-length input, which may have an invalid pointer. */
2392 if( input_length == 0 )
2393 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002394
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002395 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2396 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002397 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002398 psa_mac_abort( operation );
2399
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002400 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002401}
2402
Steven Cooremana5b860a2021-03-19 19:04:39 +01002403psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002404 uint8_t *mac,
2405 size_t mac_size,
2406 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002407{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2409 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002410
Steven Cooremana5b860a2021-03-19 19:04:39 +01002411 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002412 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002413 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002414 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002415 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002416
Steven Cooreman72f736a2021-05-07 14:14:37 +02002417 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002418 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002419 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002420 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002421 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002422
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002423 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2424 * once all the error checks are done. */
2425 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002426 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002427 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002428 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002429 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002430
2431 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002432 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002433 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002434 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002435 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002436
Steven Cooremana5b860a2021-03-19 19:04:39 +01002437 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002438 mac, operation->mac_size,
2439 mac_length );
2440
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002441exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002442 /* In case of success, set the potential excess room in the output buffer
2443 * to an invalid value, to avoid potentially leaking a longer MAC.
2444 * In case of error, set the output length and content to a safe default,
2445 * such that in case the caller misses an error check, the output would be
2446 * an unachievable MAC.
2447 */
2448 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002449 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002450 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002451 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002452 }
mohammad16036df908f2018-04-02 08:34:15 -07002453
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002454 if( mac_size > operation->mac_size )
2455 memset( &mac[operation->mac_size], '!',
2456 mac_size - operation->mac_size );
2457
Steven Cooremana5b860a2021-03-19 19:04:39 +01002458 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002459
Steven Cooremana5b860a2021-03-19 19:04:39 +01002460 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002461}
2462
Steven Cooremana5b860a2021-03-19 19:04:39 +01002463psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002464 const uint8_t *mac,
2465 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002466{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002467 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2468 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002469
Steven Cooremana5b860a2021-03-19 19:04:39 +01002470 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002471 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002472 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002473 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002474 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002475
Steven Cooreman72f736a2021-05-07 14:14:37 +02002476 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002477 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002478 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002479 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002480 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002481
2482 if( operation->mac_size != mac_length )
2483 {
2484 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002485 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002486 }
2487
Steven Cooremana5b860a2021-03-19 19:04:39 +01002488 status = psa_driver_wrapper_mac_verify_finish( operation,
2489 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002490
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002491exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002492 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002493
Steven Cooremana5b860a2021-03-19 19:04:39 +01002494 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495}
2496
Ronald Croncd989b52021-06-18 14:23:33 +02002497static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2498 psa_algorithm_t alg,
2499 const uint8_t *input,
2500 size_t input_length,
2501 uint8_t *mac,
2502 size_t mac_size,
2503 size_t *mac_length,
2504 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002505{
2506 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002507 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2508 psa_key_slot_t *slot;
2509 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002510
Ronald Cron51131b52021-06-17 17:17:20 +02002511 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002512 key,
2513 &slot,
2514 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002515 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002516 if( status != PSA_SUCCESS )
2517 goto exit;
2518
Ronald Cron51131b52021-06-17 17:17:20 +02002519 psa_key_attributes_t attributes = {
2520 .core = slot->attr
2521 };
2522
2523 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2524 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002525 if( status != PSA_SUCCESS )
2526 goto exit;
2527
Ronald Cron51131b52021-06-17 17:17:20 +02002528 if( mac_size < operation_mac_size )
2529 {
2530 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002531 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002532 }
2533
2534 status = psa_driver_wrapper_mac_compute(
2535 &attributes,
2536 slot->key.data, slot->key.bytes,
2537 alg,
2538 input, input_length,
2539 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002540
2541exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002542 /* In case of success, set the potential excess room in the output buffer
2543 * to an invalid value, to avoid potentially leaking a longer MAC.
2544 * In case of error, set the output length and content to a safe default,
2545 * such that in case the caller misses an error check, the output would be
2546 * an unachievable MAC.
2547 */
2548 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002549 {
Ronald Cron51131b52021-06-17 17:17:20 +02002550 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002551 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002552 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002553 if( mac_size > operation_mac_size )
2554 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002555
Ronald Cron51131b52021-06-17 17:17:20 +02002556 unlock_status = psa_unlock_key_slot( slot );
2557
2558 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002559}
2560
Ronald Croncd989b52021-06-18 14:23:33 +02002561psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2562 psa_algorithm_t alg,
2563 const uint8_t *input,
2564 size_t input_length,
2565 uint8_t *mac,
2566 size_t mac_size,
2567 size_t *mac_length)
2568{
2569 return( psa_mac_compute_internal( key, alg,
2570 input, input_length,
2571 mac, mac_size, mac_length, 1 ) );
2572}
2573
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002574psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2575 psa_algorithm_t alg,
2576 const uint8_t *input,
2577 size_t input_length,
2578 const uint8_t *mac,
2579 size_t mac_length)
2580{
2581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002582 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2583 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002584
Ronald Crona587cbc2021-06-18 14:51:29 +02002585 status = psa_mac_compute_internal( key, alg,
2586 input, input_length,
2587 actual_mac, sizeof( actual_mac ),
2588 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002589 if( status != PSA_SUCCESS )
2590 goto exit;
2591
Ronald Crona587cbc2021-06-18 14:51:29 +02002592 if( mac_length != actual_mac_length )
2593 {
2594 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002595 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002596 }
2597 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2598 {
2599 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002600 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002601 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602
2603exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002604 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002605
2606 return ( status );
2607}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002608
Gilles Peskinee59236f2018-01-27 23:32:46 +01002609/****************************************************************/
2610/* Asymmetric cryptography */
2611/****************************************************************/
2612
gabor-mezei-armf0486182021-05-12 11:03:09 +02002613static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002614 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002615{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002616 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002617 {
2618 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2619 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002620
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002621 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2622 {
2623 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2624 return( PSA_ERROR_INVALID_ARGUMENT );
2625 }
2626 }
2627 else
2628 {
2629 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2630 return( PSA_ERROR_INVALID_ARGUMENT );
2631 }
2632
2633 return( PSA_SUCCESS );
2634}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002635
2636static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002637 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002638 psa_algorithm_t alg,
2639 const uint8_t * input,
2640 size_t input_length,
2641 uint8_t * signature,
2642 size_t signature_size,
2643 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002644{
2645 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2646 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2647 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002648
2649 *signature_length = 0;
2650
gabor-mezei-armf0486182021-05-12 11:03:09 +02002651 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002652 if( status != PSA_SUCCESS )
2653 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002654
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002655 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002656 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002657 * buffer can in principle be empty since it doesn't actually have
2658 * to be a hash.) */
2659 if( signature_size == 0 )
2660 return( PSA_ERROR_BUFFER_TOO_SMALL );
2661
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002662 status = psa_get_and_lock_key_slot_with_policy(
2663 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002664 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2665 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002666 alg );
2667
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002668 if( status != PSA_SUCCESS )
2669 goto exit;
2670
2671 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2672 {
2673 status = PSA_ERROR_INVALID_ARGUMENT;
2674 goto exit;
2675 }
2676
2677 psa_key_attributes_t attributes = {
2678 .core = slot->attr
2679 };
2680
gabor-mezei-armf0486182021-05-12 11:03:09 +02002681 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002682 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002683 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002684 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002685 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002686 signature, signature_size, signature_length );
2687 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002688 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002689 {
2690
2691 status = psa_driver_wrapper_sign_hash(
2692 &attributes, slot->key.data, slot->key.bytes,
2693 alg, input, input_length,
2694 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002695 }
2696
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002697
2698exit:
2699 /* Fill the unused part of the output buffer (the whole buffer on error,
2700 * the trailing part on success) with something that isn't a valid signature
2701 * (barring an attack on the signature and deliberately-crafted input),
2702 * in case the caller doesn't check the return status properly. */
2703 if( status == PSA_SUCCESS )
2704 memset( signature + *signature_length, '!',
2705 signature_size - *signature_length );
2706 else
2707 memset( signature, '!', signature_size );
2708 /* If signature_size is 0 then we have nothing to do. We must not call
2709 * memset because signature may be NULL in this case. */
2710
2711 unlock_status = psa_unlock_key_slot( slot );
2712
2713 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2714}
2715
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002716static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002717 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002718 psa_algorithm_t alg,
2719 const uint8_t * input,
2720 size_t input_length,
2721 const uint8_t * signature,
2722 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002723{
2724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2725 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2726 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002727
gabor-mezei-armf0486182021-05-12 11:03:09 +02002728 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002729 if( status != PSA_SUCCESS )
2730 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002731
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002732 status = psa_get_and_lock_key_slot_with_policy(
2733 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002734 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2735 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002736 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002737
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002738 if( status != PSA_SUCCESS )
2739 return( status );
2740
2741 psa_key_attributes_t attributes = {
2742 .core = slot->attr
2743 };
2744
gabor-mezei-armf0486182021-05-12 11:03:09 +02002745 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002746 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002747 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002748 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002749 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002750 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002751 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002752 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002753 {
2754 status = psa_driver_wrapper_verify_hash(
2755 &attributes, slot->key.data, slot->key.bytes,
2756 alg, input, input_length,
2757 signature, signature_length );
2758 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002759
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002760 unlock_status = psa_unlock_key_slot( slot );
2761
2762 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763
2764}
2765
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002766psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002767 const psa_key_attributes_t *attributes,
2768 const uint8_t *key_buffer,
2769 size_t key_buffer_size,
2770 psa_algorithm_t alg,
2771 const uint8_t *input,
2772 size_t input_length,
2773 uint8_t *signature,
2774 size_t signature_size,
2775 size_t *signature_length )
2776{
2777 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002778
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002779 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2780 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002781 size_t hash_length;
2782 uint8_t hash[PSA_HASH_MAX_SIZE];
2783
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002784 status = psa_driver_wrapper_hash_compute(
2785 PSA_ALG_SIGN_GET_HASH( alg ),
2786 input, input_length,
2787 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002788
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002789 if( status != PSA_SUCCESS )
2790 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002791
2792 return psa_driver_wrapper_sign_hash(
2793 attributes, key_buffer, key_buffer_size,
2794 alg, hash, hash_length,
2795 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002796 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002797
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002798 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002799}
2800
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002801psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2802 psa_algorithm_t alg,
2803 const uint8_t * input,
2804 size_t input_length,
2805 uint8_t * signature,
2806 size_t signature_size,
2807 size_t * signature_length )
2808{
2809 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002810 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002811 signature, signature_size, signature_length );
2812}
2813
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002814psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002815 const psa_key_attributes_t *attributes,
2816 const uint8_t *key_buffer,
2817 size_t key_buffer_size,
2818 psa_algorithm_t alg,
2819 const uint8_t *input,
2820 size_t input_length,
2821 const uint8_t *signature,
2822 size_t signature_length )
2823{
2824 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002826 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2827 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002828 size_t hash_length;
2829 uint8_t hash[PSA_HASH_MAX_SIZE];
2830
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002831 status = psa_driver_wrapper_hash_compute(
2832 PSA_ALG_SIGN_GET_HASH( alg ),
2833 input, input_length,
2834 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002835
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002836 if( status != PSA_SUCCESS )
2837 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002838
2839 return psa_driver_wrapper_verify_hash(
2840 attributes, key_buffer, key_buffer_size,
2841 alg, hash, hash_length,
2842 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002843 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002844
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002845 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002846}
2847
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002848psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2849 psa_algorithm_t alg,
2850 const uint8_t * input,
2851 size_t input_length,
2852 const uint8_t * signature,
2853 size_t signature_length )
2854{
2855 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002856 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002857 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002858}
2859
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002860psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002861 const psa_key_attributes_t *attributes,
2862 const uint8_t *key_buffer, size_t key_buffer_size,
2863 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2864 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002865{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002866 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002867 {
Ronald Cron4501c982021-03-19 20:09:32 +01002868 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2869 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002870 {
Ronald Cron4501c982021-03-19 20:09:32 +01002871#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2872 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2873 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002874 attributes,
2875 key_buffer, key_buffer_size,
2876 alg, hash, hash_length,
2877 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002878#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2879 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002880 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002881 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002882 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002883 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002884 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002885 }
2886 else
Ronald Cron4501c982021-03-19 20:09:32 +01002887 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2888 {
2889 if( PSA_ALG_IS_ECDSA( alg ) )
2890 {
2891#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2892 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2893 return( mbedtls_psa_ecdsa_sign_hash(
2894 attributes,
2895 key_buffer, key_buffer_size,
2896 alg, hash, hash_length,
2897 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002898#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2899 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002900 }
2901 else
2902 {
2903 return( PSA_ERROR_INVALID_ARGUMENT );
2904 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002905 }
Ronald Cron4501c982021-03-19 20:09:32 +01002906
2907 (void)key_buffer;
2908 (void)key_buffer_size;
2909 (void)hash;
2910 (void)hash_length;
2911 (void)signature;
2912 (void)signature_size;
2913 (void)signature_length;
2914
2915 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002916}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002917
2918psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2919 psa_algorithm_t alg,
2920 const uint8_t *hash,
2921 size_t hash_length,
2922 uint8_t *signature,
2923 size_t signature_size,
2924 size_t *signature_length )
2925{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002926 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002927 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002928 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002929}
2930
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002931psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002932 const psa_key_attributes_t *attributes,
2933 const uint8_t *key_buffer, size_t key_buffer_size,
2934 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2935 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002936{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002937 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002938 {
Ronald Cron4501c982021-03-19 20:09:32 +01002939 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2940 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002941 {
Ronald Cron4501c982021-03-19 20:09:32 +01002942#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2943 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2944 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002945 attributes,
2946 key_buffer, key_buffer_size,
2947 alg, hash, hash_length,
2948 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002949#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2950 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002951 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002952 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002953 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002954 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002955 }
itayzafrir5c753392018-05-08 11:18:38 +03002956 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002957 else
Ronald Cron4501c982021-03-19 20:09:32 +01002958 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002959 {
Ronald Cron4501c982021-03-19 20:09:32 +01002960 if( PSA_ALG_IS_ECDSA( alg ) )
2961 {
2962#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2963 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2964 return( mbedtls_psa_ecdsa_verify_hash(
2965 attributes,
2966 key_buffer, key_buffer_size,
2967 alg, hash, hash_length,
2968 signature, signature_length ) );
2969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2970 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2971 }
2972 else
2973 {
2974 return( PSA_ERROR_INVALID_ARGUMENT );
2975 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002976 }
Ronald Cron4501c982021-03-19 20:09:32 +01002977
2978 (void)key_buffer;
2979 (void)key_buffer_size;
2980 (void)hash;
2981 (void)hash_length;
2982 (void)signature;
2983 (void)signature_length;
2984
2985 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002986}
2987
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002988psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2989 psa_algorithm_t alg,
2990 const uint8_t *hash,
2991 size_t hash_length,
2992 const uint8_t *signature,
2993 size_t signature_length )
2994{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002995 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002996 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002997 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002998}
2999
John Durkop0e005192020-10-31 22:06:54 -07003000#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003001static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3002 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003003{
3004 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3005 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3006 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003007
3008 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003009}
John Durkop0e005192020-10-31 22:06:54 -07003010#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003011
Ronald Croncf56a0a2020-08-04 09:51:30 +02003012psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003013 psa_algorithm_t alg,
3014 const uint8_t *input,
3015 size_t input_length,
3016 const uint8_t *salt,
3017 size_t salt_length,
3018 uint8_t *output,
3019 size_t output_size,
3020 size_t *output_length )
3021{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003022 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003023 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003024 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003025
Darryl Green5cc689a2018-07-24 15:34:10 +01003026 (void) input;
3027 (void) input_length;
3028 (void) salt;
3029 (void) output;
3030 (void) output_size;
3031
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003032 *output_length = 0;
3033
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003034 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3035 return( PSA_ERROR_INVALID_ARGUMENT );
3036
Ronald Cron5c522922020-11-14 16:35:34 +01003037 status = psa_get_and_lock_transparent_key_slot_with_policy(
3038 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003039 if( status != PSA_SUCCESS )
3040 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003041 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3042 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003043 {
3044 status = PSA_ERROR_INVALID_ARGUMENT;
3045 goto exit;
3046 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003047
John Durkop6ba40d12020-11-10 08:50:04 -08003048#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3049 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003050 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003051 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003052 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003053 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3054 slot->key.data,
3055 slot->key.bytes,
3056 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003057 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003058 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003059
3060 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003061 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003062 status = PSA_ERROR_BUFFER_TOO_SMALL;
3063 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003064 }
John Durkop0e005192020-10-31 22:06:54 -07003065#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003066 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3067 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003068 status = mbedtls_to_psa_error(
3069 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003070 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003071 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003072 input_length,
3073 input,
3074 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075 }
3076 else
John Durkop0e005192020-10-31 22:06:54 -07003077#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3078#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003079 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3080 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003081 status = mbedtls_to_psa_error(
3082 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3083 if( status != PSA_SUCCESS )
3084 goto rsa_exit;
3085
Steven Cooreman4fed4552020-08-03 14:46:03 +02003086 status = mbedtls_to_psa_error(
3087 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003088 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003089 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003090 salt, salt_length,
3091 input_length,
3092 input,
3093 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003094 }
3095 else
John Durkop0e005192020-10-31 22:06:54 -07003096#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003098 status = PSA_ERROR_INVALID_ARGUMENT;
3099 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003101rsa_exit:
3102 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003103 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003104
Steven Cooremana2371e52020-07-28 14:30:39 +02003105 mbedtls_rsa_free( rsa );
3106 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003107 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108 else
John Durkop9814fa22020-11-04 12:28:15 -08003109#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003110 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003111 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003113 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003114
3115exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003116 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003117
Ronald Cron5c522922020-11-14 16:35:34 +01003118 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003119}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120
Ronald Croncf56a0a2020-08-04 09:51:30 +02003121psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003122 psa_algorithm_t alg,
3123 const uint8_t *input,
3124 size_t input_length,
3125 const uint8_t *salt,
3126 size_t salt_length,
3127 uint8_t *output,
3128 size_t output_size,
3129 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003130{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003131 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003132 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003133 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003134
Darryl Green5cc689a2018-07-24 15:34:10 +01003135 (void) input;
3136 (void) input_length;
3137 (void) salt;
3138 (void) output;
3139 (void) output_size;
3140
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003141 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003142
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003143 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3144 return( PSA_ERROR_INVALID_ARGUMENT );
3145
Ronald Cron5c522922020-11-14 16:35:34 +01003146 status = psa_get_and_lock_transparent_key_slot_with_policy(
3147 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003148 if( status != PSA_SUCCESS )
3149 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003150 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003151 {
3152 status = PSA_ERROR_INVALID_ARGUMENT;
3153 goto exit;
3154 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003155
John Durkop6ba40d12020-11-10 08:50:04 -08003156#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3157 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003158 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003159 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003160 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003161 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3162 slot->key.data,
3163 slot->key.bytes,
3164 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003165 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003166 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167
Steven Cooremana2371e52020-07-28 14:30:39 +02003168 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003169 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003170 status = PSA_ERROR_INVALID_ARGUMENT;
3171 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003172 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003173
John Durkop0e005192020-10-31 22:06:54 -07003174#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003175 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003176 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003177 status = mbedtls_to_psa_error(
3178 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003179 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003180 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003181 output_length,
3182 input,
3183 output,
3184 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003185 }
3186 else
John Durkop0e005192020-10-31 22:06:54 -07003187#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3188#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003189 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003190 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003191 status = mbedtls_to_psa_error(
3192 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3193 if( status != PSA_SUCCESS )
3194 goto rsa_exit;
3195
Steven Cooreman4fed4552020-08-03 14:46:03 +02003196 status = mbedtls_to_psa_error(
3197 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003198 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003199 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003200 salt, salt_length,
3201 output_length,
3202 input,
3203 output,
3204 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 }
3206 else
John Durkop0e005192020-10-31 22:06:54 -07003207#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003208 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003209 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003211
Steven Cooreman4fed4552020-08-03 14:46:03 +02003212rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003213 mbedtls_rsa_free( rsa );
3214 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003215 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003216 else
John Durkop6ba40d12020-11-10 08:50:04 -08003217#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3218 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003220 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003221 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003222
3223exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003224 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003225
Ronald Cron5c522922020-11-14 16:35:34 +01003226 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003227}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003228
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003229
3230
mohammad1603503973b2018-03-12 15:59:30 +02003231/****************************************************************/
3232/* Symmetric cryptography */
3233/****************************************************************/
3234
Ronald Cronab99ac22020-10-01 16:38:28 +02003235static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3236 mbedtls_svc_key_id_t key,
3237 psa_algorithm_t alg,
3238 mbedtls_operation_t cipher_operation )
3239{
3240 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3241 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003242 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003243 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3244 PSA_KEY_USAGE_ENCRYPT :
3245 PSA_KEY_USAGE_DECRYPT );
3246
3247 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003248 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003249 {
Dave Rodgman54648242021-06-24 11:49:45 +01003250 status = PSA_ERROR_BAD_STATE;
3251 goto exit;
3252 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003253
Ronald Cronab99ac22020-10-01 16:38:28 +02003254 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003255 {
Dave Rodgman54648242021-06-24 11:49:45 +01003256 status = PSA_ERROR_INVALID_ARGUMENT;
3257 goto exit;
3258 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003259
Ronald Cronab99ac22020-10-01 16:38:28 +02003260 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3261 if( status != PSA_SUCCESS )
3262 goto exit;
3263
Ronald Cron49fafa92021-03-10 08:34:23 +01003264 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003265 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003266 * so we only set it (in the driver wrapper) after resources have been
3267 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003268 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003269 if( alg == PSA_ALG_ECB_NO_PADDING )
3270 operation->iv_required = 0;
3271 else
3272 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003273 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003274
Ronald Crona4af55f2020-12-14 14:36:06 +01003275 psa_key_attributes_t attributes = {
3276 .core = slot->attr
3277 };
3278
Ronald Cronab99ac22020-10-01 16:38:28 +02003279 /* Try doing the operation through a driver before using software fallback. */
3280 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003281 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3282 &attributes,
3283 slot->key.data,
3284 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003285 alg );
3286 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003287 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3288 &attributes,
3289 slot->key.data,
3290 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003291 alg );
3292
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003293exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003294 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003295 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003296
Ronald Cron5c522922020-11-14 16:35:34 +01003297 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003298
Ronald Cron5c522922020-11-14 16:35:34 +01003299 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003300}
3301
Gilles Peskinefe119512018-07-08 21:39:34 +02003302psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003303 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003304 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003305{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003306 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003307}
3308
Gilles Peskinefe119512018-07-08 21:39:34 +02003309psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003310 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003311 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003312{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003313 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003314}
3315
Gilles Peskinefe119512018-07-08 21:39:34 +02003316psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003317 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003318 size_t iv_size,
3319 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003320{
Ronald Cron6d051732020-10-01 14:10:20 +02003321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003322
Ronald Cron5618a392021-03-26 09:52:26 +01003323 *iv_length = 0;
3324
Ronald Cron49fafa92021-03-10 08:34:23 +01003325 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003326 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003327 status = PSA_ERROR_BAD_STATE;
3328 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003329 }
3330
Steven Cooreman7df02922020-09-09 15:28:49 +02003331 if( operation->iv_set || ! operation->iv_required )
3332 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003333 status = PSA_ERROR_BAD_STATE;
3334 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003335 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003336
Ronald Cron5618a392021-03-26 09:52:26 +01003337 if( iv_size < operation->default_iv_length )
3338 {
3339 status = PSA_ERROR_BUFFER_TOO_SMALL;
3340 goto exit;
3341 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003342
Ronald Cron5618a392021-03-26 09:52:26 +01003343 status = psa_generate_random( iv, operation->default_iv_length );
3344 if( status != PSA_SUCCESS )
3345 goto exit;
3346
3347 status = psa_driver_wrapper_cipher_set_iv( operation,
3348 iv,
3349 operation->default_iv_length );
3350
3351exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003352 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003353 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003354 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003355 *iv_length = operation->default_iv_length;
3356 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003357 else
Moran Peker395db872018-05-31 14:07:14 +03003358 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003359
itayzafrir534bd7c2018-08-02 13:56:32 +03003360 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003361}
3362
Gilles Peskinefe119512018-07-08 21:39:34 +02003363psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003364 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003365 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003366{
Ronald Cron6d051732020-10-01 14:10:20 +02003367 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003368
Ronald Cron49fafa92021-03-10 08:34:23 +01003369 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003370 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003371 status = PSA_ERROR_BAD_STATE;
3372 goto exit;
3373 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003374
Steven Cooreman7df02922020-09-09 15:28:49 +02003375 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003376 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003377 status = PSA_ERROR_BAD_STATE;
3378 goto exit;
3379 }
Ronald Crona0d68172021-03-26 10:15:08 +01003380
3381 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003382 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003383 status = PSA_ERROR_INVALID_ARGUMENT;
3384 goto exit;
3385 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003386
Ronald Crondd24c9b2020-12-15 14:10:01 +01003387 status = psa_driver_wrapper_cipher_set_iv( operation,
3388 iv,
3389 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003390
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003391exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003392 if( status == PSA_SUCCESS )
3393 operation->iv_set = 1;
3394 else
mohammad1603503973b2018-03-12 15:59:30 +02003395 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003396 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003397}
3398
Gilles Peskinee553c652018-06-04 16:22:46 +02003399psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3400 const uint8_t *input,
3401 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003402 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003403 size_t output_size,
3404 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003405{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003407
Ronald Cron49fafa92021-03-10 08:34:23 +01003408 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003409 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003410 status = PSA_ERROR_BAD_STATE;
3411 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003412 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003413
Steven Cooreman7df02922020-09-09 15:28:49 +02003414 if( operation->iv_required && ! operation->iv_set )
3415 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003416 status = PSA_ERROR_BAD_STATE;
3417 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003418 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003419
Ronald Crondd24c9b2020-12-15 14:10:01 +01003420 status = psa_driver_wrapper_cipher_update( operation,
3421 input,
3422 input_length,
3423 output,
3424 output_size,
3425 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003426
3427exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003428 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003429 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003430
itayzafrir534bd7c2018-08-02 13:56:32 +03003431 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003432}
3433
Gilles Peskinee553c652018-06-04 16:22:46 +02003434psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3435 uint8_t *output,
3436 size_t output_size,
3437 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003438{
David Saadab4ecc272019-02-14 13:48:10 +02003439 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003440
Ronald Cron49fafa92021-03-10 08:34:23 +01003441 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003442 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003443 status = PSA_ERROR_BAD_STATE;
3444 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003445 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003446
Steven Cooreman7df02922020-09-09 15:28:49 +02003447 if( operation->iv_required && ! operation->iv_set )
3448 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003449 status = PSA_ERROR_BAD_STATE;
3450 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003451 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003452
Ronald Crondd24c9b2020-12-15 14:10:01 +01003453 status = psa_driver_wrapper_cipher_finish( operation,
3454 output,
3455 output_size,
3456 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003457
3458exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003459 if( status == PSA_SUCCESS )
3460 return( psa_cipher_abort( operation ) );
3461 else
3462 {
3463 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003464 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003465
Steven Cooremanef8575e2020-09-11 11:44:50 +02003466 return( status );
3467 }
mohammad1603503973b2018-03-12 15:59:30 +02003468}
3469
Gilles Peskinee553c652018-06-04 16:22:46 +02003470psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3471{
Ronald Cron49fafa92021-03-10 08:34:23 +01003472 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003473 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003474 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003475 * in use. It's ok to call abort on such an object, and there's
3476 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003477 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003478 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003479
Ronald Crondd24c9b2020-12-15 14:10:01 +01003480 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003481
Ronald Cron49fafa92021-03-10 08:34:23 +01003482 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003483 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003484 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003485
Moran Peker395db872018-05-31 14:07:14 +03003486 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003487}
3488
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003489psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3490 psa_algorithm_t alg,
3491 const uint8_t *input,
3492 size_t input_length,
3493 uint8_t *output,
3494 size_t output_size,
3495 size_t *output_length )
3496{
3497 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003498 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3499 psa_key_slot_t *slot;
3500 psa_key_type_t key_type;
3501 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003502
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003503 *output_length = 0;
3504
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003505 if( ! PSA_ALG_IS_CIPHER( alg ) )
3506 return( PSA_ERROR_INVALID_ARGUMENT );
3507
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003508 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3509 PSA_KEY_USAGE_ENCRYPT,
3510 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003511 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003512 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003513
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003514 psa_key_attributes_t attributes = {
3515 .core = slot->attr
3516 };
3517
3518 key_type = slot->attr.type;
3519 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3520
3521 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003522 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003523 if( output_size < iv_length )
3524 {
3525 status = PSA_ERROR_BUFFER_TOO_SMALL;
3526 goto exit;
3527 }
3528
3529 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003530 if( status != PSA_SUCCESS )
3531 goto exit;
3532 }
3533
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003534 status = psa_driver_wrapper_cipher_encrypt(
3535 &attributes, slot->key.data, slot->key.bytes,
3536 alg, input, input_length,
3537 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003538
3539exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003540 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003541
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003542 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003543}
3544
3545psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3546 psa_algorithm_t alg,
3547 const uint8_t *input,
3548 size_t input_length,
3549 uint8_t *output,
3550 size_t output_size,
3551 size_t *output_length )
3552{
3553 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003554 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3555 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003556
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003557 *output_length = 0;
3558
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003559 if( ! PSA_ALG_IS_CIPHER( alg ) )
3560 return( PSA_ERROR_INVALID_ARGUMENT );
3561
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003562 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3563 PSA_KEY_USAGE_DECRYPT,
3564 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003565 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003566 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003567
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003568 psa_key_attributes_t attributes = {
3569 .core = slot->attr
3570 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003571
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003572 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3573 {
3574 status = PSA_ERROR_INVALID_ARGUMENT;
3575 goto exit;
3576 }
3577
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003578 status = psa_driver_wrapper_cipher_decrypt(
3579 &attributes, slot->key.data, slot->key.bytes,
3580 alg, input, input_length,
3581 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003582
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003583exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003584 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003585
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003586 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003587}
3588
3589
mohammad16035955c982018-04-26 00:53:03 +03003590/****************************************************************/
3591/* AEAD */
3592/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003593
Ronald Croncf56a0a2020-08-04 09:51:30 +02003594psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003595 psa_algorithm_t alg,
3596 const uint8_t *nonce,
3597 size_t nonce_length,
3598 const uint8_t *additional_data,
3599 size_t additional_data_length,
3600 const uint8_t *plaintext,
3601 size_t plaintext_length,
3602 uint8_t *ciphertext,
3603 size_t ciphertext_size,
3604 size_t *ciphertext_length )
3605{
Ronald Cron215633c2021-03-16 17:15:37 +01003606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3607 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003608
mohammad1603f08a5502018-06-03 15:05:47 +03003609 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003610
Steven Cooremanea7ab132021-03-17 16:28:00 +01003611 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3612 return( PSA_ERROR_NOT_SUPPORTED );
3613
Ronald Cron9a986162021-03-26 12:40:07 +01003614 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003615 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003616 if( status != PSA_SUCCESS )
3617 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003618
Ronald Cron215633c2021-03-16 17:15:37 +01003619 psa_key_attributes_t attributes = {
3620 .core = slot->attr
3621 };
mohammad16035955c982018-04-26 00:53:03 +03003622
Ronald Cronde822812021-03-17 16:08:20 +01003623 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003624 &attributes, slot->key.data, slot->key.bytes,
3625 alg,
3626 nonce, nonce_length,
3627 additional_data, additional_data_length,
3628 plaintext, plaintext_length,
3629 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003630
Gilles Peskineedf9a652018-08-17 18:11:56 +02003631 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3632 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003633
Ronald Cron9f310172021-03-16 16:36:37 +01003634 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003635
mohammad16035955c982018-04-26 00:53:03 +03003636 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003637}
3638
Ronald Croncf56a0a2020-08-04 09:51:30 +02003639psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003640 psa_algorithm_t alg,
3641 const uint8_t *nonce,
3642 size_t nonce_length,
3643 const uint8_t *additional_data,
3644 size_t additional_data_length,
3645 const uint8_t *ciphertext,
3646 size_t ciphertext_length,
3647 uint8_t *plaintext,
3648 size_t plaintext_size,
3649 size_t *plaintext_length )
3650{
Ronald Cron215633c2021-03-16 17:15:37 +01003651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3652 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003653
Gilles Peskineee652a32018-06-01 19:23:52 +02003654 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003655
Steven Cooremanea7ab132021-03-17 16:28:00 +01003656 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3657 return( PSA_ERROR_NOT_SUPPORTED );
3658
Ronald Cron9a986162021-03-26 12:40:07 +01003659 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003660 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003661 if( status != PSA_SUCCESS )
3662 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003663
Ronald Cron215633c2021-03-16 17:15:37 +01003664 psa_key_attributes_t attributes = {
3665 .core = slot->attr
3666 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003667
Ronald Cronde822812021-03-17 16:08:20 +01003668 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003669 &attributes, slot->key.data, slot->key.bytes,
3670 alg,
3671 nonce, nonce_length,
3672 additional_data, additional_data_length,
3673 ciphertext, ciphertext_length,
3674 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003675
Gilles Peskineedf9a652018-08-17 18:11:56 +02003676 if( status != PSA_SUCCESS && plaintext_size != 0 )
3677 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003678
Ronald Cron215633c2021-03-16 17:15:37 +01003679 psa_unlock_key_slot( slot );
3680
Gilles Peskineedf9a652018-08-17 18:11:56 +02003681 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003682}
3683
Gilles Peskinee59236f2018-01-27 23:32:46 +01003684/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003685/* Generators */
3686/****************************************************************/
3687
John Durkop07cc04a2020-11-16 22:08:34 -08003688#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3689 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3690 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3691#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003692#endif /* At least one builtin KDF */
3693
3694#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3695 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3696 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3697static psa_status_t psa_key_derivation_start_hmac(
3698 psa_mac_operation_t *operation,
3699 psa_algorithm_t hash_alg,
3700 const uint8_t *hmac_key,
3701 size_t hmac_key_length )
3702{
3703 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3704 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3705 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3706 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3707 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3708
Steven Cooreman72f736a2021-05-07 14:14:37 +02003709 operation->is_sign = 1;
3710 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3711
Steven Cooreman094a77e2021-05-06 17:58:36 +02003712 status = psa_driver_wrapper_mac_sign_setup( operation,
3713 &attributes,
3714 hmac_key, hmac_key_length,
3715 PSA_ALG_HMAC( hash_alg ) );
3716
3717 psa_reset_key_attributes( &attributes );
3718 return( status );
3719}
3720#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003721
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003722#define HKDF_STATE_INIT 0 /* no input yet */
3723#define HKDF_STATE_STARTED 1 /* got salt */
3724#define HKDF_STATE_KEYED 2 /* got key */
3725#define HKDF_STATE_OUTPUT 3 /* output started */
3726
Gilles Peskinecbe66502019-05-16 16:59:18 +02003727static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003728 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003729{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003730 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3731 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003732 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003733 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003734}
3735
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003736psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003737{
3738 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003739 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003740 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003741 {
3742 /* The object has (apparently) been initialized but it is not
3743 * in use. It's ok to call abort on such an object, and there's
3744 * nothing to do. */
3745 }
3746 else
John Durkopd0321952020-10-29 21:37:36 -07003747#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003748 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003749 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003750 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003751 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003752 }
John Durkop07cc04a2020-11-16 22:08:34 -08003753 else
3754#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3755#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3756 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3757 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003758 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003759 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003760 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003761 if( operation->ctx.tls12_prf.secret != NULL )
3762 {
3763 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3764 operation->ctx.tls12_prf.secret_length );
3765 mbedtls_free( operation->ctx.tls12_prf.secret );
3766 }
3767
Janos Follath6a1d2622019-06-11 10:37:28 +01003768 if( operation->ctx.tls12_prf.seed != NULL )
3769 {
3770 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3771 operation->ctx.tls12_prf.seed_length );
3772 mbedtls_free( operation->ctx.tls12_prf.seed );
3773 }
3774
3775 if( operation->ctx.tls12_prf.label != NULL )
3776 {
3777 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3778 operation->ctx.tls12_prf.label_length );
3779 mbedtls_free( operation->ctx.tls12_prf.label );
3780 }
3781
Steven Cooremana6df6042021-04-29 19:32:25 +02003782 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003783
3784 /* We leave the fields Ai and output_block to be erased safely by the
3785 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003786 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003787 else
John Durkop07cc04a2020-11-16 22:08:34 -08003788#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3789 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003790 {
3791 status = PSA_ERROR_BAD_STATE;
3792 }
Janos Follath083036a2019-06-11 10:22:26 +01003793 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003794 return( status );
3795}
3796
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003797psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003798 size_t *capacity)
3799{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003800 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003801 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003802 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003803 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003804 }
3805
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003806 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003807 return( PSA_SUCCESS );
3808}
3809
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003810psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003811 size_t capacity )
3812{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003813 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003814 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003815 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003816 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003817 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003818 return( PSA_SUCCESS );
3819}
3820
John Durkopd0321952020-10-29 21:37:36 -07003821#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003822/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003823 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003824static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003825 psa_algorithm_t hash_alg,
3826 uint8_t *output,
3827 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003828{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003829 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003830 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003831 psa_status_t status;
3832
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003833 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3834 return( PSA_ERROR_BAD_STATE );
3835 hkdf->state = HKDF_STATE_OUTPUT;
3836
Gilles Peskinebef7f142018-07-12 17:22:21 +02003837 while( output_length != 0 )
3838 {
3839 /* Copy what remains of the current block */
3840 uint8_t n = hash_length - hkdf->offset_in_block;
3841 if( n > output_length )
3842 n = (uint8_t) output_length;
3843 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3844 output += n;
3845 output_length -= n;
3846 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003847 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003848 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003849 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003850 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003851 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003852 * object was corrupted or if this function is called directly
3853 * inside the library. */
3854 if( hkdf->block_number == 0xff )
3855 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003856
3857 /* We need a new block */
3858 ++hkdf->block_number;
3859 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003860
Steven Cooreman094a77e2021-05-06 17:58:36 +02003861 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3862 hash_alg,
3863 hkdf->prk,
3864 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003865 if( status != PSA_SUCCESS )
3866 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003867
Gilles Peskinebef7f142018-07-12 17:22:21 +02003868 if( hkdf->block_number != 1 )
3869 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003870 status = psa_mac_update( &hkdf->hmac,
3871 hkdf->output_block,
3872 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003873 if( status != PSA_SUCCESS )
3874 return( status );
3875 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003876 status = psa_mac_update( &hkdf->hmac,
3877 hkdf->info,
3878 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003879 if( status != PSA_SUCCESS )
3880 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003881 status = psa_mac_update( &hkdf->hmac,
3882 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003883 if( status != PSA_SUCCESS )
3884 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003885 status = psa_mac_sign_finish( &hkdf->hmac,
3886 hkdf->output_block,
3887 sizeof( hkdf->output_block ),
3888 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003889 if( status != PSA_SUCCESS )
3890 return( status );
3891 }
3892
3893 return( PSA_SUCCESS );
3894}
John Durkop07cc04a2020-11-16 22:08:34 -08003895#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003896
John Durkop07cc04a2020-11-16 22:08:34 -08003897#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3898 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003899static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3900 psa_tls12_prf_key_derivation_t *tls12_prf,
3901 psa_algorithm_t alg )
3902{
3903 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003904 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003905 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3906 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003907 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003908
Janos Follath7742fee2019-06-17 12:58:10 +01003909 /* We can't be wanting more output after block 0xff, otherwise
3910 * the capacity check in psa_key_derivation_output_bytes() would have
3911 * prevented this call. It could happen only if the operation
3912 * object was corrupted or if this function is called directly
3913 * inside the library. */
3914 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003915 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003916
3917 /* We need a new block */
3918 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003919 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003920
3921 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3922 *
3923 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3924 *
3925 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3926 * HMAC_hash(secret, A(2) + seed) +
3927 * HMAC_hash(secret, A(3) + seed) + ...
3928 *
3929 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003930 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003931 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003932 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003933 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003934 * is currently extracted as `output_block` and where i is
3935 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003936 */
3937
Steven Cooreman094a77e2021-05-06 17:58:36 +02003938 status = psa_key_derivation_start_hmac( &hmac,
3939 hash_alg,
3940 tls12_prf->secret,
3941 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003942 if( status != PSA_SUCCESS )
3943 goto cleanup;
3944
3945 /* Calculate A(i) where i = tls12_prf->block_number. */
3946 if( tls12_prf->block_number == 1 )
3947 {
3948 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3949 * the variable seed and in this instance means it in the context of the
3950 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003951 status = psa_mac_update( &hmac,
3952 tls12_prf->label,
3953 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003954 if( status != PSA_SUCCESS )
3955 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003956 status = psa_mac_update( &hmac,
3957 tls12_prf->seed,
3958 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003959 if( status != PSA_SUCCESS )
3960 goto cleanup;
3961 }
3962 else
3963 {
3964 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003965 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003966 if( status != PSA_SUCCESS )
3967 goto cleanup;
3968 }
3969
Steven Cooremana6df6042021-04-29 19:32:25 +02003970 status = psa_mac_sign_finish( &hmac,
3971 tls12_prf->Ai, hash_length,
3972 &hmac_output_length );
3973 if( hmac_output_length != hash_length )
3974 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003975 if( status != PSA_SUCCESS )
3976 goto cleanup;
3977
3978 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003979 status = psa_key_derivation_start_hmac( &hmac,
3980 hash_alg,
3981 tls12_prf->secret,
3982 tls12_prf->secret_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->Ai, hash_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->label, tls12_prf->label_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_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003992 if( status != PSA_SUCCESS )
3993 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003994 status = psa_mac_sign_finish( &hmac,
3995 tls12_prf->output_block, hash_length,
3996 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003997 if( status != PSA_SUCCESS )
3998 goto cleanup;
3999
Janos Follath7742fee2019-06-17 12:58:10 +01004000
4001cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004002 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004003 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4004 status = cleanup_status;
4005
4006 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004007}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004008
Janos Follath844eb0e2019-06-19 12:10:49 +01004009static psa_status_t psa_key_derivation_tls12_prf_read(
4010 psa_tls12_prf_key_derivation_t *tls12_prf,
4011 psa_algorithm_t alg,
4012 uint8_t *output,
4013 size_t output_length )
4014{
4015 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004016 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004017 psa_status_t status;
4018 uint8_t offset, length;
4019
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004020 switch( tls12_prf->state )
4021 {
4022 case PSA_TLS12_PRF_STATE_LABEL_SET:
4023 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4024 break;
4025 case PSA_TLS12_PRF_STATE_OUTPUT:
4026 break;
4027 default:
4028 return( PSA_ERROR_BAD_STATE );
4029 }
4030
Janos Follath844eb0e2019-06-19 12:10:49 +01004031 while( output_length != 0 )
4032 {
4033 /* Check if we have fully processed the current block. */
4034 if( tls12_prf->left_in_block == 0 )
4035 {
4036 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4037 alg );
4038 if( status != PSA_SUCCESS )
4039 return( status );
4040
4041 continue;
4042 }
4043
4044 if( tls12_prf->left_in_block > output_length )
4045 length = (uint8_t) output_length;
4046 else
4047 length = tls12_prf->left_in_block;
4048
4049 offset = hash_length - tls12_prf->left_in_block;
4050 memcpy( output, tls12_prf->output_block + offset, length );
4051 output += length;
4052 output_length -= length;
4053 tls12_prf->left_in_block -= length;
4054 }
4055
4056 return( PSA_SUCCESS );
4057}
John Durkop07cc04a2020-11-16 22:08:34 -08004058#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4059 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004060
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004061psa_status_t psa_key_derivation_output_bytes(
4062 psa_key_derivation_operation_t *operation,
4063 uint8_t *output,
4064 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004065{
4066 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004067 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004068
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004069 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004070 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004071 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004072 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004073 }
4074
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004075 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004076 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004077 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004078 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004079 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004080 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004081 goto exit;
4082 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004083 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004084 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004085 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004086 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004087 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4088 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004089 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004090 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004091 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004092 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004093 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004094
John Durkopd0321952020-10-29 21:37:36 -07004095#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004096 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004097 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004098 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004099 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004100 output, output_length );
4101 }
Janos Follathadbec812019-06-14 11:05:39 +01004102 else
John Durkop07cc04a2020-11-16 22:08:34 -08004103#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4104#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4105 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004106 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004107 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004108 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004109 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004110 kdf_alg, output,
4111 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004112 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004113 else
John Durkop07cc04a2020-11-16 22:08:34 -08004114#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4115 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004116 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004117 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004118 return( PSA_ERROR_BAD_STATE );
4119 }
4120
4121exit:
4122 if( status != PSA_SUCCESS )
4123 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004124 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004125 * This allows us to differentiate between exhausted operations and
4126 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4127 * operations. */
4128 psa_algorithm_t alg = operation->alg;
4129 psa_key_derivation_abort( operation );
4130 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004131 memset( output, '!', output_length );
4132 }
4133 return( status );
4134}
4135
David Brown7807bf72021-02-09 16:28:23 -07004136#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004137static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4138{
4139 if( data_size >= 8 )
4140 mbedtls_des_key_set_parity( data );
4141 if( data_size >= 16 )
4142 mbedtls_des_key_set_parity( data + 8 );
4143 if( data_size >= 24 )
4144 mbedtls_des_key_set_parity( data + 16 );
4145}
David Brown7807bf72021-02-09 16:28:23 -07004146#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004147
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004148static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004149 psa_key_slot_t *slot,
4150 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004151 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004152{
4153 uint8_t *data = NULL;
4154 size_t bytes = PSA_BITS_TO_BYTES( bits );
4155 psa_status_t status;
4156
Gilles Peskine8e338702019-07-30 20:06:31 +02004157 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004158 return( PSA_ERROR_INVALID_ARGUMENT );
4159 if( bits % 8 != 0 )
4160 return( PSA_ERROR_INVALID_ARGUMENT );
4161 data = mbedtls_calloc( 1, bytes );
4162 if( data == NULL )
4163 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4164
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004165 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004166 if( status != PSA_SUCCESS )
4167 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004168#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004169 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004170 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004171#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004172
4173 status = psa_allocate_buffer_to_slot( slot, bytes );
4174 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004175 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004176
Ronald Cronbf33c932020-11-28 18:06:53 +01004177 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004178 psa_key_attributes_t attributes = {
4179 .core = slot->attr
4180 };
4181
Ronald Cronbf33c932020-11-28 18:06:53 +01004182 status = psa_driver_wrapper_import_key( &attributes,
4183 data, bytes,
4184 slot->key.data,
4185 slot->key.bytes,
4186 &slot->key.bytes, &bits );
4187 if( bits != slot->attr.bits )
4188 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004189
4190exit:
4191 mbedtls_free( data );
4192 return( status );
4193}
4194
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004195psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004196 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004197 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004198{
4199 psa_status_t status;
4200 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004201 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004202
Ronald Cron81709fc2020-11-14 12:10:32 +01004203 *key = MBEDTLS_SVC_KEY_ID_INIT;
4204
Gilles Peskine0f84d622019-09-12 19:03:13 +02004205 /* Reject any attempt to create a zero-length key so that we don't
4206 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4207 if( psa_get_key_bits( attributes ) == 0 )
4208 return( PSA_ERROR_INVALID_ARGUMENT );
4209
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004210 if( ! operation->can_output_key )
4211 return( PSA_ERROR_NOT_PERMITTED );
4212
Ronald Cron81709fc2020-11-14 12:10:32 +01004213 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4214 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004215#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4216 if( driver != NULL )
4217 {
4218 /* Deriving a key in a secure element is not implemented yet. */
4219 status = PSA_ERROR_NOT_SUPPORTED;
4220 }
4221#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004222 if( status == PSA_SUCCESS )
4223 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004224 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004225 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004226 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004227 }
4228 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004229 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004230 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004231 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004232
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004233 return( status );
4234}
4235
Gilles Peskineeab56e42018-07-12 17:12:33 +02004236
4237
4238/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004239/* Key derivation */
4240/****************************************************************/
4241
Steven Cooreman932ffb72021-02-15 12:14:32 +01004242#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004243static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004244 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004245 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004246{
John Durkop07cc04a2020-11-16 22:08:34 -08004247 int is_kdf_alg_supported;
4248
Janos Follath5fe19732019-06-20 15:09:30 +01004249 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4250 * initialisers for this union leave some bytes unspecified.) */
4251 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4252
Gilles Peskine969c5d62019-01-16 15:53:06 +01004253 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004254#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004255 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4256 is_kdf_alg_supported = 1;
4257 else
4258#endif
4259#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4260 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4261 is_kdf_alg_supported = 1;
4262 else
4263#endif
4264#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4265 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4266 is_kdf_alg_supported = 1;
4267 else
4268#endif
4269 is_kdf_alg_supported = 0;
4270
4271 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004272 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004273 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004274 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004275 if( hash_size == 0 )
4276 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004277 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4278 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004279 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004280 {
4281 return( PSA_ERROR_NOT_SUPPORTED );
4282 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004283 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004284 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004285 }
John Durkop07cc04a2020-11-16 22:08:34 -08004286
4287 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004288}
John Durkop07cc04a2020-11-16 22:08:34 -08004289#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004290
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004291psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004292 psa_algorithm_t alg )
4293{
4294 psa_status_t status;
4295
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004296 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004297 return( PSA_ERROR_BAD_STATE );
4298
Gilles Peskine6843c292019-01-18 16:44:49 +01004299 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4300 return( PSA_ERROR_INVALID_ARGUMENT );
4301 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004302 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004303#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004304 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004305 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004306#else
4307 return( PSA_ERROR_NOT_SUPPORTED );
4308#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004309 }
4310 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4311 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004312#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004313 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004314#else
4315 return( PSA_ERROR_NOT_SUPPORTED );
4316#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004317 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004318 else
4319 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004320
4321 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004322 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004323 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004324}
4325
John Durkopd0321952020-10-29 21:37:36 -07004326#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004327static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004328 psa_algorithm_t hash_alg,
4329 psa_key_derivation_step_t step,
4330 const uint8_t *data,
4331 size_t data_length )
4332{
4333 psa_status_t status;
4334 switch( step )
4335 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004336 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004337 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004338 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004339 else
4340 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004341 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4342 hash_alg,
4343 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004344 if( status != PSA_SUCCESS )
4345 return( status );
4346 hkdf->state = HKDF_STATE_STARTED;
4347 return( PSA_SUCCESS );
4348 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004349 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004350 /* If no salt was provided, use an empty salt. */
4351 if( hkdf->state == HKDF_STATE_INIT )
4352 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004353 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4354 hash_alg,
4355 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004356 if( status != PSA_SUCCESS )
4357 return( status );
4358 hkdf->state = HKDF_STATE_STARTED;
4359 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004360 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004361 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004362 status = psa_mac_update( &hkdf->hmac,
4363 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004364 if( status != PSA_SUCCESS )
4365 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004366 status = psa_mac_sign_finish( &hkdf->hmac,
4367 hkdf->prk,
4368 sizeof( hkdf->prk ),
4369 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004370 if( status != PSA_SUCCESS )
4371 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004372 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004373 hkdf->block_number = 0;
4374 hkdf->state = HKDF_STATE_KEYED;
4375 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004376 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004377 if( hkdf->state == HKDF_STATE_OUTPUT )
4378 return( PSA_ERROR_BAD_STATE );
4379 if( hkdf->info_set )
4380 return( PSA_ERROR_BAD_STATE );
4381 hkdf->info_length = data_length;
4382 if( data_length != 0 )
4383 {
4384 hkdf->info = mbedtls_calloc( 1, data_length );
4385 if( hkdf->info == NULL )
4386 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4387 memcpy( hkdf->info, data, data_length );
4388 }
4389 hkdf->info_set = 1;
4390 return( PSA_SUCCESS );
4391 default:
4392 return( PSA_ERROR_INVALID_ARGUMENT );
4393 }
4394}
John Durkop07cc04a2020-11-16 22:08:34 -08004395#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004396
John Durkop07cc04a2020-11-16 22:08:34 -08004397#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4398 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004399static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4400 const uint8_t *data,
4401 size_t data_length )
4402{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004403 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004404 return( PSA_ERROR_BAD_STATE );
4405
Janos Follathd6dce9f2019-07-04 09:11:38 +01004406 if( data_length != 0 )
4407 {
4408 prf->seed = mbedtls_calloc( 1, data_length );
4409 if( prf->seed == NULL )
4410 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004411
Janos Follathd6dce9f2019-07-04 09:11:38 +01004412 memcpy( prf->seed, data, data_length );
4413 prf->seed_length = data_length;
4414 }
Janos Follathf08e2652019-06-13 09:05:41 +01004415
Gilles Peskine43f958b2020-12-13 14:55:14 +01004416 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004417
4418 return( PSA_SUCCESS );
4419}
4420
Janos Follath81550542019-06-13 14:26:34 +01004421static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004422 const uint8_t *data,
4423 size_t data_length )
4424{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004425 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004426 return( PSA_ERROR_BAD_STATE );
4427
Steven Cooremana6df6042021-04-29 19:32:25 +02004428 if( data_length != 0 )
4429 {
4430 prf->secret = mbedtls_calloc( 1, data_length );
4431 if( prf->secret == NULL )
4432 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4433
4434 memcpy( prf->secret, data, data_length );
4435 prf->secret_length = data_length;
4436 }
Janos Follath81550542019-06-13 14:26:34 +01004437
Gilles Peskine43f958b2020-12-13 14:55:14 +01004438 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004439
4440 return( PSA_SUCCESS );
4441}
4442
Janos Follath63028dd2019-06-13 09:15:47 +01004443static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4444 const uint8_t *data,
4445 size_t data_length )
4446{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004447 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004448 return( PSA_ERROR_BAD_STATE );
4449
Janos Follathd6dce9f2019-07-04 09:11:38 +01004450 if( data_length != 0 )
4451 {
4452 prf->label = mbedtls_calloc( 1, data_length );
4453 if( prf->label == NULL )
4454 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004455
Janos Follathd6dce9f2019-07-04 09:11:38 +01004456 memcpy( prf->label, data, data_length );
4457 prf->label_length = data_length;
4458 }
Janos Follath63028dd2019-06-13 09:15:47 +01004459
Gilles Peskine43f958b2020-12-13 14:55:14 +01004460 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004461
4462 return( PSA_SUCCESS );
4463}
4464
Janos Follathb03233e2019-06-11 15:30:30 +01004465static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004466 psa_key_derivation_step_t step,
4467 const uint8_t *data,
4468 size_t data_length )
4469{
Janos Follathb03233e2019-06-11 15:30:30 +01004470 switch( step )
4471 {
Janos Follathf08e2652019-06-13 09:05:41 +01004472 case PSA_KEY_DERIVATION_INPUT_SEED:
4473 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004474 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004475 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004476 case PSA_KEY_DERIVATION_INPUT_LABEL:
4477 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004478 default:
4479 return( PSA_ERROR_INVALID_ARGUMENT );
4480 }
4481}
John Durkop07cc04a2020-11-16 22:08:34 -08004482#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4483 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4484
4485#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4486static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4487 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004488 const uint8_t *data,
4489 size_t data_length )
4490{
4491 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004492 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004493 uint8_t *cur = pms;
4494
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004495 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004496 return( PSA_ERROR_INVALID_ARGUMENT );
4497
4498 /* Quoting RFC 4279, Section 2:
4499 *
4500 * The premaster secret is formed as follows: if the PSK is N octets
4501 * long, concatenate a uint16 with the value N, N zero octets, a second
4502 * uint16 with the value N, and the PSK itself.
4503 */
4504
Joe Subbiani5ecac212021-06-24 13:00:03 +01004505 *cur++ = MBEDTLS_BYTE_1( data_length );
4506 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004507 memset( cur, 0, data_length );
4508 cur += data_length;
4509 *cur++ = pms[0];
4510 *cur++ = pms[1];
4511 memcpy( cur, data, data_length );
4512 cur += data_length;
4513
Steven Cooremana6df6042021-04-29 19:32:25 +02004514 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004515
4516 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4517 return( status );
4518}
Janos Follath6660f0e2019-06-17 08:44:03 +01004519
4520static psa_status_t psa_tls12_prf_psk_to_ms_input(
4521 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004522 psa_key_derivation_step_t step,
4523 const uint8_t *data,
4524 size_t data_length )
4525{
4526 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004527 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004528 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004529 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004530 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004531
Steven Cooremana6df6042021-04-29 19:32:25 +02004532 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004533}
John Durkop07cc04a2020-11-16 22:08:34 -08004534#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004535
Gilles Peskineb8965192019-09-24 16:21:10 +02004536/** Check whether the given key type is acceptable for the given
4537 * input step of a key derivation.
4538 *
4539 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4540 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4541 * Both secret and non-secret inputs can alternatively have the type
4542 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4543 * that the input was passed as a buffer rather than via a key object.
4544 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004545static int psa_key_derivation_check_input_type(
4546 psa_key_derivation_step_t step,
4547 psa_key_type_t key_type )
4548{
4549 switch( step )
4550 {
4551 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004552 if( key_type == PSA_KEY_TYPE_DERIVE )
4553 return( PSA_SUCCESS );
4554 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004555 return( PSA_SUCCESS );
4556 break;
4557 case PSA_KEY_DERIVATION_INPUT_LABEL:
4558 case PSA_KEY_DERIVATION_INPUT_SALT:
4559 case PSA_KEY_DERIVATION_INPUT_INFO:
4560 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004561 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4562 return( PSA_SUCCESS );
4563 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004564 return( PSA_SUCCESS );
4565 break;
4566 }
4567 return( PSA_ERROR_INVALID_ARGUMENT );
4568}
4569
Janos Follathb80a94e2019-06-12 15:54:46 +01004570static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004571 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004572 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004573 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004574 const uint8_t *data,
4575 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004576{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004577 psa_status_t status;
4578 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4579
4580 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004581 if( status != PSA_SUCCESS )
4582 goto exit;
4583
John Durkopd0321952020-10-29 21:37:36 -07004584#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004585 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004586 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004587 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004588 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004589 step, data, data_length );
4590 }
John Durkop07cc04a2020-11-16 22:08:34 -08004591 else
4592#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4593#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4594 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004595 {
Janos Follathb03233e2019-06-11 15:30:30 +01004596 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004597 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004598 }
John Durkop07cc04a2020-11-16 22:08:34 -08004599 else
4600#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4601#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4602 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004603 {
4604 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004605 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004606 }
4607 else
John Durkop07cc04a2020-11-16 22:08:34 -08004608#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004609 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004610 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004611 (void) data;
4612 (void) data_length;
4613 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004614 return( PSA_ERROR_BAD_STATE );
4615 }
4616
Gilles Peskine224b0d62019-09-23 18:13:17 +02004617exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004618 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004619 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004620 return( status );
4621}
4622
Janos Follath51f4a0f2019-06-14 11:35:55 +01004623psa_status_t psa_key_derivation_input_bytes(
4624 psa_key_derivation_operation_t *operation,
4625 psa_key_derivation_step_t step,
4626 const uint8_t *data,
4627 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004628{
Gilles Peskineb8965192019-09-24 16:21:10 +02004629 return( psa_key_derivation_input_internal( operation, step,
4630 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004631 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004632}
4633
Janos Follath51f4a0f2019-06-14 11:35:55 +01004634psa_status_t psa_key_derivation_input_key(
4635 psa_key_derivation_operation_t *operation,
4636 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004637 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004638{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004639 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004640 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004641 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004642
Ronald Cron5c522922020-11-14 16:35:34 +01004643 status = psa_get_and_lock_transparent_key_slot_with_policy(
4644 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004645 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004646 {
4647 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004648 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004649 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004650
4651 /* Passing a key object as a SECRET input unlocks the permission
4652 * to output to a key object. */
4653 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4654 operation->can_output_key = 1;
4655
Ronald Cronf95a2b12020-10-22 15:24:49 +02004656 status = psa_key_derivation_input_internal( operation,
4657 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004658 slot->key.data,
4659 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004660
Ronald Cron5c522922020-11-14 16:35:34 +01004661 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004662
Ronald Cron5c522922020-11-14 16:35:34 +01004663 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004664}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004665
4666
4667
4668/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004669/* Key agreement */
4670/****************************************************************/
4671
John Durkop6ba40d12020-11-10 08:50:04 -08004672#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004673static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4674 size_t peer_key_length,
4675 const mbedtls_ecp_keypair *our_key,
4676 uint8_t *shared_secret,
4677 size_t shared_secret_size,
4678 size_t *shared_secret_length )
4679{
Steven Cooremand4867872020-08-05 16:31:39 +02004680 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004681 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004682 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004683 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004684 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004685 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004686
Ronald Cron90857082020-11-25 14:58:33 +01004687 status = mbedtls_psa_ecp_load_representation(
4688 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004689 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004690 peer_key,
4691 peer_key_length,
4692 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004693 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004694 goto exit;
4695
Jaeden Amero97271b32019-01-10 19:38:51 +00004696 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004697 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004698 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004699 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004700 status = mbedtls_to_psa_error(
4701 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4702 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004703 goto exit;
4704
Jaeden Amero97271b32019-01-10 19:38:51 +00004705 status = mbedtls_to_psa_error(
4706 mbedtls_ecdh_calc_secret( &ecdh,
4707 shared_secret_length,
4708 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004709 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004710 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004711 if( status != PSA_SUCCESS )
4712 goto exit;
4713 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4714 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004715
4716exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004717 if( status != PSA_SUCCESS )
4718 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004719 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004720 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004721 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004722
Jaeden Amero97271b32019-01-10 19:38:51 +00004723 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004724}
John Durkop6ba40d12020-11-10 08:50:04 -08004725#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004726
Gilles Peskine01d718c2018-09-18 12:01:02 +02004727#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4728
Gilles Peskine0216fe12019-04-11 21:23:21 +02004729static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4730 psa_key_slot_t *private_key,
4731 const uint8_t *peer_key,
4732 size_t peer_key_length,
4733 uint8_t *shared_secret,
4734 size_t shared_secret_size,
4735 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004736{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004737 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004738 {
John Durkop6ba40d12020-11-10 08:50:04 -08004739#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004740 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004741 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004742 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004743 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004744 psa_status_t status = mbedtls_psa_ecp_load_representation(
4745 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004746 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004747 private_key->key.data,
4748 private_key->key.bytes,
4749 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004750 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004751 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004752 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004753 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004754 shared_secret, shared_secret_size,
4755 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004756 mbedtls_ecp_keypair_free( ecp );
4757 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004758 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004759#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004760 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004761 (void) private_key;
4762 (void) peer_key;
4763 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004764 (void) shared_secret;
4765 (void) shared_secret_size;
4766 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004767 return( PSA_ERROR_NOT_SUPPORTED );
4768 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004769}
4770
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004771/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004772 * to potentially free embedded data structures and wipe confidential data.
4773 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004774static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004775 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004776 psa_key_slot_t *private_key,
4777 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004778 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004779{
4780 psa_status_t status;
4781 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4782 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004783 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004784
4785 /* Step 1: run the secret agreement algorithm to generate the shared
4786 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004787 status = psa_key_agreement_raw_internal( ka_alg,
4788 private_key,
4789 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004790 shared_secret,
4791 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004792 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004793 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004794 goto exit;
4795
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004796 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004797 * the shared secret. A shared secret is permitted wherever a key
4798 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004799 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004800 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004801 shared_secret,
4802 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004803exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004804 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004805 return( status );
4806}
4807
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004808psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004809 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004810 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004811 const uint8_t *peer_key,
4812 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004813{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004814 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004815 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004816 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004817
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004818 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004819 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004820 status = psa_get_and_lock_transparent_key_slot_with_policy(
4821 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004822 if( status != PSA_SUCCESS )
4823 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004824 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004825 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004826 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004827 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004828 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004829 else
4830 {
4831 /* If a private key has been added as SECRET, we allow the derived
4832 * key material to be used as a key in PSA Crypto. */
4833 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4834 operation->can_output_key = 1;
4835 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004836
Ronald Cron5c522922020-11-14 16:35:34 +01004837 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004838
Ronald Cron5c522922020-11-14 16:35:34 +01004839 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004840}
4841
Gilles Peskinebe697d82019-05-16 18:00:41 +02004842psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004843 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004844 const uint8_t *peer_key,
4845 size_t peer_key_length,
4846 uint8_t *output,
4847 size_t output_size,
4848 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004849{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004850 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004851 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004852 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004853
4854 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4855 {
4856 status = PSA_ERROR_INVALID_ARGUMENT;
4857 goto exit;
4858 }
Ronald Cron5c522922020-11-14 16:35:34 +01004859 status = psa_get_and_lock_transparent_key_slot_with_policy(
4860 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004861 if( status != PSA_SUCCESS )
4862 goto exit;
4863
4864 status = psa_key_agreement_raw_internal( alg, slot,
4865 peer_key, peer_key_length,
4866 output, output_size,
4867 output_length );
4868
4869exit:
4870 if( status != PSA_SUCCESS )
4871 {
4872 /* If an error happens and is not handled properly, the output
4873 * may be used as a key to protect sensitive data. Arrange for such
4874 * a key to be random, which is likely to result in decryption or
4875 * verification errors. This is better than filling the buffer with
4876 * some constant data such as zeros, which would result in the data
4877 * being protected with a reproducible, easily knowable key.
4878 */
4879 psa_generate_random( output, output_size );
4880 *output_length = output_size;
4881 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004882
Ronald Cron5c522922020-11-14 16:35:34 +01004883 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004884
Ronald Cron5c522922020-11-14 16:35:34 +01004885 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004886}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004887
4888
Gilles Peskine30524eb2020-11-13 17:02:26 +01004889
Gilles Peskine86a440b2018-11-12 18:39:40 +01004890/****************************************************************/
4891/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004892/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004893
Gilles Peskine30524eb2020-11-13 17:02:26 +01004894/** Initialize the PSA random generator.
4895 */
4896static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4897{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004898#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4899 memset( rng, 0, sizeof( *rng ) );
4900#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4901
Gilles Peskine30524eb2020-11-13 17:02:26 +01004902 /* Set default configuration if
4903 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4904 if( rng->entropy_init == NULL )
4905 rng->entropy_init = mbedtls_entropy_init;
4906 if( rng->entropy_free == NULL )
4907 rng->entropy_free = mbedtls_entropy_free;
4908
4909 rng->entropy_init( &rng->entropy );
4910#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4911 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4912 /* The PSA entropy injection feature depends on using NV seed as an entropy
4913 * source. Add NV seed as an entropy source for PSA entropy injection. */
4914 mbedtls_entropy_add_source( &rng->entropy,
4915 mbedtls_nv_seed_poll, NULL,
4916 MBEDTLS_ENTROPY_BLOCK_SIZE,
4917 MBEDTLS_ENTROPY_SOURCE_STRONG );
4918#endif
4919
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004920 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004921#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004922}
4923
4924/** Deinitialize the PSA random generator.
4925 */
4926static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4927{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004928#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4929 memset( rng, 0, sizeof( *rng ) );
4930#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004931 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004932 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004933#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004934}
4935
4936/** Seed the PSA random generator.
4937 */
4938static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4939{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004940#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4941 /* Do nothing: the external RNG seeds itself. */
4942 (void) rng;
4943 return( PSA_SUCCESS );
4944#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004945 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004946 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4947 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004948 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004949#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004950}
4951
Gilles Peskinee59236f2018-01-27 23:32:46 +01004952psa_status_t psa_generate_random( uint8_t *output,
4953 size_t output_size )
4954{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004955 GUARD_MODULE_INITIALIZED;
4956
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004957#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4958
4959 size_t output_length = 0;
4960 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4961 output, output_size,
4962 &output_length );
4963 if( status != PSA_SUCCESS )
4964 return( status );
4965 /* Breaking up a request into smaller chunks is currently not supported
4966 * for the extrernal RNG interface. */
4967 if( output_length != output_size )
4968 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4969 return( PSA_SUCCESS );
4970
4971#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4972
Gilles Peskine71ddab92021-01-04 21:01:07 +01004973 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004974 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004975 size_t request_size =
4976 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4977 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4978 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004979 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4980 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004981 if( ret != 0 )
4982 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004983 output_size -= request_size;
4984 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004985 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004986 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004987#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004988}
4989
Gilles Peskine8814fc42020-12-14 15:33:44 +01004990/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004991 *
4992 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4993 * `psa_generate_random(...)`. The state parameter is ignored since the
4994 * PSA API doesn't support passing an explicit state.
4995 *
4996 * In the non-external case, psa_generate_random() calls an
4997 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4998 * and semantics as mbedtls_psa_get_random(). As an optimization,
4999 * instead of doing this back-and-forth between the PSA API and the
5000 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5001 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005002 */
5003#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5004int mbedtls_psa_get_random( void *p_rng,
5005 unsigned char *output,
5006 size_t output_size )
5007{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005008 /* This function takes a pointer to the RNG state because that's what
5009 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5010 * its own state internally and doesn't let the caller access that state.
5011 * So we just ignore the state parameter, and in practice we'll pass
5012 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005013 (void) p_rng;
5014 psa_status_t status = psa_generate_random( output, output_size );
5015 if( status == PSA_SUCCESS )
5016 return( 0 );
5017 else
5018 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5019}
5020#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5021
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005022#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005023#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005024
Gilles Peskine7228da22019-07-15 11:06:15 +02005025psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005026 size_t seed_size )
5027{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005028 if( global_data.initialized )
5029 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005030
5031 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5032 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5033 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5034 return( PSA_ERROR_INVALID_ARGUMENT );
5035
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005036 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005037}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005038#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005039
Ronald Cron3772afe2021-02-08 16:10:05 +01005040/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005041 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005042 * \param type The key type
5043 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005044 *
5045 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005046 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005047 * \retval #PSA_ERROR_INVALID_ARGUMENT
5048 * The size in bits of the key is not valid.
5049 * \retval #PSA_ERROR_NOT_SUPPORTED
5050 * The type and/or the size in bits of the key or the combination of
5051 * the two is not supported.
5052 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005053static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5054 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005055{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005056 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005057
Gilles Peskinee59236f2018-01-27 23:32:46 +01005058 if( key_type_is_raw_bytes( type ) )
5059 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005060 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005061 if( status != PSA_SUCCESS )
5062 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005063 }
5064 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005065#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005066 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5067 {
5068 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5069 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005070
Ronald Cron01b2aba2020-10-05 09:42:02 +02005071 /* Accept only byte-aligned keys, for the same reasons as
5072 * in psa_import_rsa_key(). */
5073 if( bits % 8 != 0 )
5074 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005075 }
5076 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005077#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005078
Ronald Cron5c4d3862020-12-07 11:07:24 +01005079#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005080 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5081 {
Ronald Crond81ab562021-02-16 09:01:16 +01005082 /* To avoid empty block, return successfully here. */
5083 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005084 }
5085 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005086#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005087 {
5088 return( PSA_ERROR_NOT_SUPPORTED );
5089 }
5090
5091 return( PSA_SUCCESS );
5092}
5093
Ronald Cron55ed0592020-10-05 10:30:40 +02005094psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005095 const psa_key_attributes_t *attributes,
5096 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005097{
5098 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005099 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005100
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005101 if( ( attributes->domain_parameters == NULL ) &&
5102 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005103 return( PSA_ERROR_INVALID_ARGUMENT );
5104
Ronald Cron01b2aba2020-10-05 09:42:02 +02005105 if( key_type_is_raw_bytes( type ) )
5106 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005107 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005108 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005109 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005110
David Brown12ca5032021-02-11 11:02:00 -07005111#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005112 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005113 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005114#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005115 }
5116 else
5117
Jaeden Amero424fa932021-05-14 08:34:32 +01005118#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5119 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005120 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005121 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005122 return( mbedtls_psa_rsa_generate_key( attributes,
5123 key_buffer,
5124 key_buffer_size,
5125 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005126 }
5127 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005128#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5129 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005130
John Durkop9814fa22020-11-04 12:28:15 -08005131#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005132 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005133 {
Ronald Cron7023db52020-11-20 18:17:42 +01005134 return( mbedtls_psa_ecp_generate_key( attributes,
5135 key_buffer,
5136 key_buffer_size,
5137 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005138 }
5139 else
John Durkop9814fa22020-11-04 12:28:15 -08005140#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005141 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005142 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005143 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005144 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005145
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005146 return( PSA_SUCCESS );
5147}
Darryl Green0c6575a2018-11-07 16:05:30 +00005148
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005149psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005150 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005151{
5152 psa_status_t status;
5153 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005154 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005155 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005156
Ronald Cron81709fc2020-11-14 12:10:32 +01005157 *key = MBEDTLS_SVC_KEY_ID_INIT;
5158
Gilles Peskine0f84d622019-09-12 19:03:13 +02005159 /* Reject any attempt to create a zero-length key so that we don't
5160 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5161 if( psa_get_key_bits( attributes ) == 0 )
5162 return( PSA_ERROR_INVALID_ARGUMENT );
5163
Ronald Cron81709fc2020-11-14 12:10:32 +01005164 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5165 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005166 if( status != PSA_SUCCESS )
5167 goto exit;
5168
Ronald Cron977c2472020-10-13 08:32:21 +02005169 /* In the case of a transparent key or an opaque key stored in local
5170 * storage (thus not in the case of generating a key in a secure element
5171 * or cryptoprocessor with storage), we have to allocate a buffer to
5172 * hold the generated key material. */
5173 if( slot->key.data == NULL )
5174 {
5175 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5176 PSA_KEY_LOCATION_LOCAL_STORAGE )
5177 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005178 status = psa_validate_key_type_and_size_for_key_generation(
5179 attributes->core.type, attributes->core.bits );
5180 if( status != PSA_SUCCESS )
5181 goto exit;
5182
5183 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5184 attributes->core.type,
5185 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005186 }
5187 else
5188 {
5189 status = psa_driver_wrapper_get_key_buffer_size(
5190 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005191 if( status != PSA_SUCCESS )
5192 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005193 }
Ronald Cron977c2472020-10-13 08:32:21 +02005194
5195 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5196 if( status != PSA_SUCCESS )
5197 goto exit;
5198 }
5199
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005200 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005201 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005202
Ronald Cron2b56bc82020-10-05 10:02:26 +02005203 if( status != PSA_SUCCESS )
5204 psa_remove_key_data_from_memory( slot );
5205
Gilles Peskine11792082019-08-06 18:36:36 +02005206exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005207 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005208 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005209 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005210 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005211
Darryl Green0c6575a2018-11-07 16:05:30 +00005212 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005213}
5214
Gilles Peskinee59236f2018-01-27 23:32:46 +01005215/****************************************************************/
5216/* Module setup */
5217/****************************************************************/
5218
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005219#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005220psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5221 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5222 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5223{
5224 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5225 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005226 global_data.rng.entropy_init = entropy_init;
5227 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005228 return( PSA_SUCCESS );
5229}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005230#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005231
Gilles Peskinee59236f2018-01-27 23:32:46 +01005232void mbedtls_psa_crypto_free( void )
5233{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005234 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005235 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5236 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005237 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005238 }
5239 /* Wipe all remaining data, including configuration.
5240 * In particular, this sets all state indicator to the value
5241 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005242 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005243#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005244 /* Unregister all secure element drivers, so that we restart from
5245 * a pristine state. */
5246 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005247#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005248}
5249
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005250#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5251/** Recover a transaction that was interrupted by a power failure.
5252 *
5253 * This function is called during initialization, before psa_crypto_init()
5254 * returns. If this function returns a failure status, the initialization
5255 * fails.
5256 */
5257static psa_status_t psa_crypto_recover_transaction(
5258 const psa_crypto_transaction_t *transaction )
5259{
5260 switch( transaction->unknown.type )
5261 {
5262 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5263 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005264 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005265 * is implemented.
5266 * https://github.com/ARMmbed/mbed-crypto/issues/218
5267 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005268 default:
5269 /* We found an unsupported transaction in the storage.
5270 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005271 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005272 }
5273}
5274#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5275
Gilles Peskinee59236f2018-01-27 23:32:46 +01005276psa_status_t psa_crypto_init( void )
5277{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005278 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005279
Gilles Peskinec6b69072018-11-20 21:42:52 +01005280 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005281 if( global_data.initialized != 0 )
5282 return( PSA_SUCCESS );
5283
Gilles Peskine30524eb2020-11-13 17:02:26 +01005284 /* Initialize and seed the random generator. */
5285 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005286 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005287 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005288 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005289 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005290 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005291
Gilles Peskine66fb1262018-12-10 16:29:04 +01005292 status = psa_initialize_key_slots( );
5293 if( status != PSA_SUCCESS )
5294 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005295
Gilles Peskined9348f22019-10-01 15:22:29 +02005296#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5297 status = psa_init_all_se_drivers( );
5298 if( status != PSA_SUCCESS )
5299 goto exit;
5300#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5301
Gilles Peskine4b734222019-07-24 15:56:31 +02005302#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005303 status = psa_crypto_load_transaction( );
5304 if( status == PSA_SUCCESS )
5305 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005306 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5307 if( status != PSA_SUCCESS )
5308 goto exit;
5309 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005310 }
5311 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5312 {
5313 /* There's no transaction to complete. It's all good. */
5314 status = PSA_SUCCESS;
5315 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005316#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005317
Gilles Peskinec6b69072018-11-20 21:42:52 +01005318 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005319 global_data.initialized = 1;
5320
5321exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005322 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005323 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005324 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005325}
5326
5327#endif /* MBEDTLS_PSA_CRYPTO_C */