blob: 95a94278ef8dabfcc19e80f8ea15fd55dc663716 [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
John Durkop07cc04a2020-11-16 22:08:34 -0800325/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
326 * current test driver in key_management.c is using this function
327 * when accelerators are used for ECC key pair and public key.
328 * Once that dependency is resolved these guards can be removed.
329 */
John Durkop9814fa22020-11-04 12:28:15 -0800330#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800331 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
332 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
333 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100334mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100335 size_t bits,
336 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200337{
338 switch( curve )
339 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100340 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100341 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100342 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100343#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100344 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100345 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100346#endif
347#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#endif
351#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100352 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100353 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100354#endif
355#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100356 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100357 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100358#endif
359#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100361 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 528:
363 if( bits_is_sloppy )
364 return( MBEDTLS_ECP_DP_SECP521R1 );
365 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100367 }
368 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100369
Paul Elliott8ff510a2020-06-02 17:19:28 +0100370 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100371 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100372 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100374 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100375 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100376#endif
377#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#endif
381#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 }
386 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100387
Paul Elliott8ff510a2020-06-02 17:19:28 +0100388 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100393 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
395 if( bits_is_sloppy )
396 return( MBEDTLS_ECP_DP_CURVE25519 );
397 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#endif
399#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100402#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 }
404 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100405
Paul Elliott8ff510a2020-06-02 17:19:28 +0100406 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100410 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100411 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100412#endif
413#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 }
422 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200423 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100425 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200427}
John Durkop9814fa22020-11-04 12:28:15 -0800428#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800429 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
430 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
431 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432
Archana4d7ae1d2021-07-07 02:50:22 +0530433psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530434 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
442 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_AES:
445 if( bits != 128 && bits != 192 && bits != 256 )
446 return( PSA_ERROR_INVALID_ARGUMENT );
447 break;
448#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200449#if defined(PSA_WANT_KEY_TYPE_ARIA)
450 case PSA_KEY_TYPE_ARIA:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_CAMELLIA:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200462 case PSA_KEY_TYPE_DES:
463 if( bits != 64 && bits != 128 && bits != 192 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100467#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200468 case PSA_KEY_TYPE_CHACHA20:
469 if( bits != 256 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 default:
474 return( PSA_ERROR_NOT_SUPPORTED );
475 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200476 if( bits % 8 != 0 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200479 return( PSA_SUCCESS );
480}
481
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100482/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100483 *
Steven Cooremancd640932021-03-08 12:00:27 +0100484 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
485 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 *
487 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100488 * \param[in] key_type The key type of the key to be used with the
489 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100490 *
491 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100497 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100499{
Steven Cooremancd640932021-03-08 12:00:27 +0100500 if( PSA_ALG_IS_HMAC( algorithm ) )
501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 if( key_type == PSA_KEY_TYPE_HMAC )
503 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100504 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100505
506 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
509 * key. */
510 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
511 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
512 {
513 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
514 * the block length (larger than 1) for block ciphers. */
515 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
516 return( PSA_SUCCESS );
517 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100518 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100519
520 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100521}
522
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200523psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
524 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200525{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100526 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200527 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200528
Ronald Cronea0f8a62020-11-25 17:52:23 +0100529 slot->key.data = mbedtls_calloc( 1, buffer_length );
530 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200531 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200532
Ronald Cronea0f8a62020-11-25 17:52:23 +0100533 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200534 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200535}
536
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200537psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
538 const uint8_t* data,
539 size_t data_length )
540{
541 psa_status_t status = psa_allocate_buffer_to_slot( slot,
542 data_length );
543 if( status != PSA_SUCCESS )
544 return( status );
545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200547 return( PSA_SUCCESS );
548}
549
Ronald Crona0fe59f2020-11-29 11:14:53 +0100550psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100551 const psa_key_attributes_t *attributes,
552 const uint8_t *data, size_t data_length,
553 uint8_t *key_buffer, size_t key_buffer_size,
554 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100555{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
557 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559 /* zero-length keys are never supported. */
560 if( data_length == 0 )
561 return( PSA_ERROR_NOT_SUPPORTED );
562
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100563 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100564 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200566
Archana449608b2021-09-08 15:36:05 +0530567 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
568 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200569 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200570 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200571
Ronald Crondd04d422020-11-28 15:14:42 +0100572 /* Copy the key material. */
573 memcpy( key_buffer, data, data_length );
574 *key_buffer_length = data_length;
575 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200576
Steven Cooreman40120f62020-10-29 11:42:22 +0100577 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100578 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100579 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200580 {
John Durkop9814fa22020-11-04 12:28:15 -0800581#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
582 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100583 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200584 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 return( mbedtls_psa_ecp_import_key( attributes,
586 data, data_length,
587 key_buffer, key_buffer_size,
588 key_buffer_length,
589 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100590 }
John Durkop9814fa22020-11-04 12:28:15 -0800591#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
592 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700593#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100595 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200596 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 return( mbedtls_psa_rsa_import_key( attributes,
598 data, data_length,
599 key_buffer, key_buffer_size,
600 key_buffer_length,
601 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200602 }
John Durkop9814fa22020-11-04 12:28:15 -0800603#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
604 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100606
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100608}
609
Gilles Peskinef603c712019-01-19 13:40:11 +0100610/** Calculate the intersection of two algorithm usage policies.
611 *
612 * Return 0 (which allows no operation) on incompatibility.
613 */
614static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100615 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 psa_algorithm_t alg1,
617 psa_algorithm_t alg2 )
618{
Gilles Peskine549ea862019-05-22 11:45:59 +0200619 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100620 if( alg1 == alg2 )
621 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100622 /* If the policies are from the same hash-and-sign family, check
623 * if one is a wildcard. If so the other has the specific algorithm. */
624 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
625 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
626 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100627 {
Steven Cooreman03488022021-02-18 12:07:20 +0100628 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
629 return( alg2 );
630 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
631 return( alg1 );
632 }
633 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100634 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100635 * restrictive tag length. */
636 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
637 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
638 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
639 {
640 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
641 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100642 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100643
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100644 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100645 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
646 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100647 {
Steven Cooremancd640932021-03-08 12:00:27 +0100648 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
649 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100650 }
651 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100652 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100653 ( alg1_len <= alg2_len ) )
654 {
655 return( alg2 );
656 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100657 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100658 ( alg2_len <= alg1_len ) )
659 {
660 return( alg1 );
661 }
662 }
663 /* If the policies are from the same MAC family, check whether one
664 * of them is a minimum-MAC-length policy. Calculate the most
665 * restrictive tag length. */
666 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
667 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
668 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
669 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100670 /* Validate the combination of key type and algorithm. Since the base
671 * algorithm of alg1 and alg2 are the same, we only need this once. */
672 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100673 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100674
Steven Cooreman31a876d2021-03-03 20:47:40 +0100675 /* Get the (exact or at-least) output lengths for both sides of the
676 * requested intersection. None of the currently supported algorithms
677 * have an output length dependent on the actual key size, so setting it
678 * to a bogus value of 0 is currently OK.
679 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100680 * Note that for at-least-this-length wildcard algorithms, the output
681 * length is set to the shortest allowed length, which allows us to
682 * calculate the most restrictive tag length for the intersection. */
683 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
684 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100685 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100686
Steven Cooremana1d83222021-02-25 10:20:29 +0100687 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100688 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
689 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100690 {
Steven Cooremancd640932021-03-08 12:00:27 +0100691 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100692 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100693
694 /* If only one is an at-least-this-length policy, the intersection would
695 * be the other (fixed-length) policy as long as said fixed length is
696 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100697 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100698 {
Steven Cooremancd640932021-03-08 12:00:27 +0100699 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100700 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100702 {
Steven Cooremancd640932021-03-08 12:00:27 +0100703 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100704 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100705
Steven Cooremancd640932021-03-08 12:00:27 +0100706 /* If none of them are wildcards, check whether they define the same tag
707 * length. This is still possible here when one is default-length and
708 * the other specific-length. Ensure to always return the
709 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100710 if( alg1_len == alg2_len )
711 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100712 }
713 /* If the policies are incompatible, allow nothing. */
714 return( 0 );
715}
716
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100717static int psa_key_algorithm_permits( psa_key_type_t key_type,
718 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200719 psa_algorithm_t requested_alg )
720{
Gilles Peskine549ea862019-05-22 11:45:59 +0200721 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200722 if( requested_alg == policy_alg )
723 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100724 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
725 * and requested_alg is the same hash-and-sign family with any hash,
726 * then requested_alg is compliant with policy_alg. */
727 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
728 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200729 {
Steven Cooreman03488022021-02-18 12:07:20 +0100730 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
731 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
732 }
733 /* If policy_alg is a wildcard AEAD algorithm of the same base as
734 * the requested algorithm, check the requested tag length to be
735 * equal-length or longer than the wildcard-specified length. */
736 if( PSA_ALG_IS_AEAD( policy_alg ) &&
737 PSA_ALG_IS_AEAD( requested_alg ) &&
738 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
739 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100740 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100741 {
742 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
743 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
744 }
Steven Cooremancd640932021-03-08 12:00:27 +0100745 /* If policy_alg is a MAC algorithm of the same base as the requested
746 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100747 if( PSA_ALG_IS_MAC( policy_alg ) &&
748 PSA_ALG_IS_MAC( requested_alg ) &&
749 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100750 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100751 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100752 /* Validate the combination of key type and algorithm. Since the policy
753 * and requested algorithms are the same, we only need this once. */
754 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100755 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100756
Steven Cooreman31a876d2021-03-03 20:47:40 +0100757 /* Get both the requested output length for the algorithm which is to be
758 * verified, and the default output length for the base algorithm.
759 * Note that none of the currently supported algorithms have an output
760 * length dependent on actual key size, so setting it to a bogus value
761 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100762 size_t requested_output_length = PSA_MAC_LENGTH(
763 key_type, 0, requested_alg );
764 size_t default_output_length = PSA_MAC_LENGTH(
765 key_type, 0,
766 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100767
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768 /* If the policy is default-length, only allow an algorithm with
769 * a declared exact-length matching the default. */
770 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100772
773 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100774 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100775 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
776 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
777 {
778 return( 1 );
779 }
780
Steven Cooremancd640932021-03-08 12:00:27 +0100781 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
782 * check for the requested MAC length to be equal to or longer than the
783 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
785 {
786 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100787 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100788 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200789 }
Steven Cooremance48e852020-10-05 16:02:45 +0200790 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200791 * a key derivation with that key agreement should also be allowed. This
792 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200793 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
794 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
795 {
796 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
797 policy_alg );
798 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100799 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200800 return( 0 );
801}
802
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100803/** Test whether a policy permits an algorithm.
804 *
805 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100806 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100807 * \note This function requires providing the key type for which the policy is
808 * being validated, since some algorithm policy definitions (e.g. MAC)
809 * have different properties depending on what kind of cipher it is
810 * combined with.
811 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100812 * \retval PSA_SUCCESS When \p alg is a specific algorithm
813 * allowed by the \p policy.
814 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
815 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
816 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100817 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100818static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100819 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100821{
Steven Cooremand788fab2021-02-25 11:29:17 +0100822 /* '0' is not a valid algorithm */
823 if( alg == 0 )
824 return( PSA_ERROR_INVALID_ARGUMENT );
825
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 /* A requested algorithm cannot be a wildcard. */
827 if( PSA_ALG_IS_WILDCARD( alg ) )
828 return( PSA_ERROR_INVALID_ARGUMENT );
829
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100830 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
831 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 return( PSA_SUCCESS );
833 else
834 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100835}
836
Gilles Peskinef603c712019-01-19 13:40:11 +0100837/** Restrict a key policy based on a constraint.
838 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100839 * \note This function requires providing the key type for which the policy is
840 * being restricted, since some algorithm policy definitions (e.g. MAC)
841 * have different properties depending on what kind of cipher it is
842 * combined with.
843 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100844 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100845 * \param[in,out] policy The policy to restrict.
846 * \param[in] constraint The policy constraint to apply.
847 *
848 * \retval #PSA_SUCCESS
849 * \c *policy contains the intersection of the original value of
850 * \c *policy and \c *constraint.
851 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 * \c *policy is unchanged.
854 */
855static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100856 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100857 psa_key_policy_t *policy,
858 const psa_key_policy_t *constraint )
859{
860 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100861 psa_key_policy_algorithm_intersection( key_type, policy->alg,
862 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200863 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100864 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
865 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
867 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200868 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100870 policy->usage &= constraint->usage;
871 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100873 return( PSA_SUCCESS );
874}
875
Ronald Cron5c522922020-11-14 16:35:34 +0100876/** Get the description of a key given its identifier and policy constraints
877 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200878 *
Ronald Cron5c522922020-11-14 16:35:34 +0100879 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100880 * nonzero, the key must allow operations with this algorithm. If \p alg is
881 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100882 *
Ronald Cron5c522922020-11-14 16:35:34 +0100883 * In case of a persistent key, the function loads the description of the key
884 * into a key slot if not already done.
885 *
886 * On success, the returned key slot is locked. It is the responsibility of
887 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200888 */
Ronald Cron5c522922020-11-14 16:35:34 +0100889static psa_status_t psa_get_and_lock_key_slot_with_policy(
890 mbedtls_svc_key_id_t key,
891 psa_key_slot_t **p_slot,
892 psa_key_usage_t usage,
893 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100894{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
896 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100897
Ronald Cron5c522922020-11-14 16:35:34 +0100898 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100899 if( status != PSA_SUCCESS )
900 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200901 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100902
903 /* Enforce that usage policy for the key slot contains all the flags
904 * required by the usage parameter. There is one exception: public
905 * keys can always be exported, so we treat public key objects as
906 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200907 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100911 {
912 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200913 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100914 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100915
916 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100917 if( alg != 0 )
918 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100919 status = psa_key_policy_permits( &slot->attr.policy,
920 slot->attr.type,
921 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922 if( status != PSA_SUCCESS )
923 goto error;
924 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Darryl Green06fd18d2018-07-16 11:21:11 +0100926 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927
928error:
929 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100930 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200931
932 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100933}
Darryl Green940d72c2018-07-13 13:18:51 +0100934
Ronald Cron5c522922020-11-14 16:35:34 +0100935/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200936 *
937 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200938 * available, as opposed to a key in a secure element and/or to be used
939 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200941 * This is a temporary function that may be used instead of
942 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
943 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200944 *
Ronald Cron5c522922020-11-14 16:35:34 +0100945 * On success, the returned key slot is locked. It is the responsibility of the
946 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200947 */
Ronald Cron5c522922020-11-14 16:35:34 +0100948static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
949 mbedtls_svc_key_id_t key,
950 psa_key_slot_t **p_slot,
951 psa_key_usage_t usage,
952 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200953{
Ronald Cron5c522922020-11-14 16:35:34 +0100954 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
955 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 if( status != PSA_SUCCESS )
957 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Ronald Cronddae0f52021-08-24 15:39:44 +0200959 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200960 {
Ronald Cron5c522922020-11-14 16:35:34 +0100961 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 *p_slot = NULL;
963 return( PSA_ERROR_NOT_SUPPORTED );
964 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200965
Gilles Peskine28f8f302019-07-24 13:30:31 +0200966 return( PSA_SUCCESS );
967}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200969psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000970{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100971 /* Data pointer will always be either a valid pointer or NULL in an
972 * initialized slot, so we can just free it. */
973 if( slot->key.data != NULL )
974 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
975
976 mbedtls_free( slot->key.data );
977 slot->key.data = NULL;
978 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000979
980 return( PSA_SUCCESS );
981}
982
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100983/** Completely wipe a slot in memory, including its policy.
984 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100985psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100986{
987 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100988
TRodziewicz18cddc02021-07-13 12:19:15 +0200989 /*
990 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200991 * do our best to report an unexpected lock counter. Assert with
992 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
993 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
994 * function is called as part of the execution of a test suite, the
995 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200996 */
Ronald Cron5c522922020-11-14 16:35:34 +0100997 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100998 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200999 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001000 status = PSA_ERROR_CORRUPTION_DETECTED;
1001 }
1002
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001003 /* Multipart operations may still be using the key. This is safe
1004 * because all multipart operation objects are independent from
1005 * the key slot: if they need to access the key after the setup
1006 * phase, they have a copy of the key. Note that this means that
1007 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001008 /* At this point, key material and other type-specific content has
1009 * been wiped. Clear remaining metadata. We can call memset and not
1010 * zeroize because the metadata is not particularly sensitive. */
1011 memset( slot, 0, sizeof( *slot ) );
1012 return( status );
1013}
1014
Ronald Croncf56a0a2020-08-04 09:51:30 +02001015psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001016{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001017 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001018 psa_status_t status; /* status of the last operation */
1019 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001020#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1021 psa_se_drv_table_entry_t *driver;
1022#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001023
Ronald Croncf56a0a2020-08-04 09:51:30 +02001024 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001025 return( PSA_SUCCESS );
1026
Ronald Cronf2911112020-10-29 17:51:10 +01001027 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001028 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001029 * key, this will load the key description from persistent memory if not
1030 * done yet. We cannot avoid this loading as without it we don't know if
1031 * the key is operated by an SE or not and this information is needed by
1032 * the current implementation.
1033 */
Ronald Cron5c522922020-11-14 16:35:34 +01001034 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001035 if( status != PSA_SUCCESS )
1036 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001037
Ronald Cronf2911112020-10-29 17:51:10 +01001038 /*
1039 * If the key slot containing the key description is under access by the
1040 * library (apart from the present access), the key cannot be destroyed
1041 * yet. For the time being, just return in error. Eventually (to be
1042 * implemented), the key should be destroyed when all accesses have
1043 * stopped.
1044 */
Ronald Cron5c522922020-11-14 16:35:34 +01001045 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001046 {
Ronald Cron5c522922020-11-14 16:35:34 +01001047 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001048 return( PSA_ERROR_GENERIC_ERROR );
1049 }
1050
Gilles Peskine6687cd02021-04-21 22:32:05 +02001051 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1052 {
1053 /* Refuse the destruction of a read-only key (which may or may not work
1054 * if we attempt it, depending on whether the key is merely read-only
1055 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001056 * Just do the best we can, which is to wipe the copy in memory
1057 * (done in this function's cleanup code). */
1058 overall_status = PSA_ERROR_NOT_PERMITTED;
1059 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001060 }
1061
Gilles Peskine354f7672019-07-12 23:46:38 +02001062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001063 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001064 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001065 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001066 /* For a key in a secure element, we need to do three things:
1067 * remove the key file in internal storage, destroy the
1068 * key inside the secure element, and update the driver's
1069 * persistent data. Start a transaction that will encompass these
1070 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001071 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001072 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001073 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001074 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001075 status = psa_crypto_save_transaction( );
1076 if( status != PSA_SUCCESS )
1077 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001078 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 /* We should still try to destroy the key in the secure
1080 * element and the key metadata in storage. This is especially
1081 * important if the error is that the storage is full.
1082 * But how to do it exactly without risking an inconsistent
1083 * state after a reset?
1084 * https://github.com/ARMmbed/mbed-crypto/issues/215
1085 */
1086 overall_status = status;
1087 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 }
1089
Ronald Cronea0f8a62020-11-25 17:52:23 +01001090 status = psa_destroy_se_key( driver,
1091 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 if( overall_status == PSA_SUCCESS )
1093 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001094 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001095#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1096
Darryl Greend49a4992018-06-18 17:27:26 +01001097#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001098 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001099 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001100 status = psa_destroy_persistent_key( slot->attr.id );
1101 if( overall_status == PSA_SUCCESS )
1102 overall_status = status;
1103
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001104 /* TODO: other slots may have a copy of the same key. We should
1105 * invalidate them.
1106 * https://github.com/ARMmbed/mbed-crypto/issues/214
1107 */
Darryl Greend49a4992018-06-18 17:27:26 +01001108 }
1109#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001110
Gilles Peskinefc762652019-07-22 19:30:34 +02001111#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1112 if( driver != NULL )
1113 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001114 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001115 if( overall_status == PSA_SUCCESS )
1116 overall_status = status;
1117 status = psa_crypto_stop_transaction( );
1118 if( overall_status == PSA_SUCCESS )
1119 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001120 }
1121#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1122
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001124 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001126 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 overall_status = status;
1128 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001129}
1130
John Durkop07cc04a2020-11-16 22:08:34 -08001131#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001132 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001133static psa_status_t psa_get_rsa_public_exponent(
1134 const mbedtls_rsa_context *rsa,
1135 psa_key_attributes_t *attributes )
1136{
1137 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001139 uint8_t *buffer = NULL;
1140 size_t buflen;
1141 mbedtls_mpi_init( &mpi );
1142
1143 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1144 if( ret != 0 )
1145 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001146 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1147 {
1148 /* It's the default value, which is reported as an empty string,
1149 * so there's nothing to do. */
1150 goto exit;
1151 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001152
1153 buflen = mbedtls_mpi_size( &mpi );
1154 buffer = mbedtls_calloc( 1, buflen );
1155 if( buffer == NULL )
1156 {
1157 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1158 goto exit;
1159 }
1160 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1161 if( ret != 0 )
1162 goto exit;
1163 attributes->domain_parameters = buffer;
1164 attributes->domain_parameters_size = buflen;
1165
1166exit:
1167 mbedtls_mpi_free( &mpi );
1168 if( ret != 0 )
1169 mbedtls_free( buffer );
1170 return( mbedtls_to_psa_error( ret ) );
1171}
John Durkop07cc04a2020-11-16 22:08:34 -08001172#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001173 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001174
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001175/** Retrieve all the publicly-accessible attributes of a key.
1176 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001177psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001178 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001179{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001180 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001181 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001182 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001183
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001184 psa_reset_key_attributes( attributes );
1185
Ronald Cron5c522922020-11-14 16:35:34 +01001186 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001187 if( status != PSA_SUCCESS )
1188 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001189
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001190 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001191 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1192 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1193
1194#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001195 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001196 psa_set_key_slot_number( attributes,
1197 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001198#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001199
Gilles Peskine8e338702019-07-30 20:06:31 +02001200 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001201 {
John Durkop07cc04a2020-11-16 22:08:34 -08001202#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001203 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001204 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001205 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001206 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001207 * is not yet implemented.
1208 * https://github.com/ARMmbed/mbed-crypto/issues/216
1209 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001210 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001211 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001212 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001213
Ronald Cron90857082020-11-25 14:58:33 +01001214 status = mbedtls_psa_rsa_load_representation(
1215 slot->attr.type,
1216 slot->key.data,
1217 slot->key.bytes,
1218 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 if( status != PSA_SUCCESS )
1220 break;
1221
Steven Cooremana2371e52020-07-28 14:30:39 +02001222 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001223 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001224 mbedtls_rsa_free( rsa );
1225 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001226 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001227 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001228#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001229 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001230 default:
1231 /* Nothing else to do. */
1232 break;
1233 }
1234
1235 if( status != PSA_SUCCESS )
1236 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001237
Ronald Cron5c522922020-11-14 16:35:34 +01001238 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001239
Ronald Cron5c522922020-11-14 16:35:34 +01001240 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001241}
1242
Gilles Peskinec8000c02019-08-02 20:15:51 +02001243#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1244psa_status_t psa_get_key_slot_number(
1245 const psa_key_attributes_t *attributes,
1246 psa_key_slot_number_t *slot_number )
1247{
1248 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1249 {
1250 *slot_number = attributes->slot_number;
1251 return( PSA_SUCCESS );
1252 }
1253 else
1254 return( PSA_ERROR_INVALID_ARGUMENT );
1255}
1256#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1257
Ronald Crond18b5f82020-11-25 16:46:05 +01001258static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1259 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001260 uint8_t *data,
1261 size_t data_size,
1262 size_t *data_length )
1263{
Ronald Crond18b5f82020-11-25 16:46:05 +01001264 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001265 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001266 memcpy( data, key_buffer, key_buffer_size );
1267 memset( data + key_buffer_size, 0,
1268 data_size - key_buffer_size );
1269 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001270 return( PSA_SUCCESS );
1271}
1272
Ronald Cron7285cda2020-11-26 14:46:37 +01001273psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 const psa_key_attributes_t *attributes,
1275 const uint8_t *key_buffer, size_t key_buffer_size,
1276 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001277{
Ronald Crond18b5f82020-11-25 16:46:05 +01001278 psa_key_type_t type = attributes->core.type;
1279
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 if( key_type_is_raw_bytes( type ) ||
1281 PSA_KEY_TYPE_IS_RSA( type ) ||
1282 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001283 {
1284 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001285 key_buffer, key_buffer_size,
1286 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001287 }
1288 else
1289 {
1290 /* This shouldn't happen in the reference implementation, but
1291 it is valid for a special-purpose implementation to omit
1292 support for exporting certain key types. */
1293 return( PSA_ERROR_NOT_SUPPORTED );
1294 }
1295}
1296
1297psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1298 uint8_t *data,
1299 size_t data_size,
1300 size_t *data_length )
1301{
1302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1303 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1304 psa_key_slot_t *slot;
1305
Ronald Crone907e552021-01-18 13:22:38 +01001306 /* Reject a zero-length output buffer now, since this can never be a
1307 * valid key representation. This way we know that data must be a valid
1308 * pointer and we can do things like memset(data, ..., data_size). */
1309 if( data_size == 0 )
1310 return( PSA_ERROR_BUFFER_TOO_SMALL );
1311
Ronald Cron9486f9d2020-11-26 13:36:23 +01001312 /* Set the key to empty now, so that even when there are errors, we always
1313 * set data_length to a value between 0 and data_size. On error, setting
1314 * the key to empty is a good choice because an empty key representation is
1315 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001316 *data_length = 0;
1317
Ronald Cron9486f9d2020-11-26 13:36:23 +01001318 /* Export requires the EXPORT flag. There is an exception for public keys,
1319 * which don't require any flag, but
1320 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1321 */
1322 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1323 PSA_KEY_USAGE_EXPORT, 0 );
1324 if( status != PSA_SUCCESS )
1325 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001326
Ronald Crond18b5f82020-11-25 16:46:05 +01001327 psa_key_attributes_t attributes = {
1328 .core = slot->attr
1329 };
Ronald Cron67227982020-11-26 15:16:05 +01001330 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001331 slot->key.data, slot->key.bytes,
1332 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333
Ronald Cron9486f9d2020-11-26 13:36:23 +01001334 unlock_status = psa_unlock_key_slot( slot );
1335
1336 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1337}
1338
Ronald Cron7285cda2020-11-26 14:46:37 +01001339psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 const psa_key_attributes_t *attributes,
1341 const uint8_t *key_buffer,
1342 size_t key_buffer_size,
1343 uint8_t *data,
1344 size_t data_size,
1345 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001346{
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001348
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001350 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001352 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001353 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 key_buffer, key_buffer_size,
1356 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001357 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001358
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001360 {
John Durkop0e005192020-10-31 22:06:54 -07001361#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1362 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001363 return( mbedtls_psa_rsa_export_public_key( attributes,
1364 key_buffer,
1365 key_buffer_size,
1366 data,
1367 data_size,
1368 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001369#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001370 /* We don't know how to convert a private RSA key to public. */
1371 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001372#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1373 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001374 }
1375 else
Moran Pekera998bc62018-04-16 18:16:20 +03001376 {
John Durkop6ba40d12020-11-10 08:50:04 -08001377#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1378 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001379 return( mbedtls_psa_ecp_export_public_key( attributes,
1380 key_buffer,
1381 key_buffer_size,
1382 data,
1383 data_size,
1384 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001385#else
1386 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001387 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001388#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1389 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001390 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001391 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001392 else
1393 {
1394 /* This shouldn't happen in the reference implementation, but
1395 it is valid for a special-purpose implementation to omit
1396 support for exporting certain key types. */
1397 return( PSA_ERROR_NOT_SUPPORTED );
1398 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399}
Ronald Crond18b5f82020-11-25 16:46:05 +01001400
Ronald Croncf56a0a2020-08-04 09:51:30 +02001401psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001402 uint8_t *data,
1403 size_t data_size,
1404 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001405{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001407 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001408 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001409
Ronald Crone907e552021-01-18 13:22:38 +01001410 /* Reject a zero-length output buffer now, since this can never be a
1411 * valid key representation. This way we know that data must be a valid
1412 * pointer and we can do things like memset(data, ..., data_size). */
1413 if( data_size == 0 )
1414 return( PSA_ERROR_BUFFER_TOO_SMALL );
1415
Darryl Greendd8fb772018-11-07 16:00:44 +00001416 /* Set the key to empty now, so that even when there are errors, we always
1417 * set data_length to a value between 0 and data_size. On error, setting
1418 * the key to empty is a good choice because an empty key representation is
1419 * unlikely to be accepted anywhere. */
1420 *data_length = 0;
1421
1422 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001423 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001424 if( status != PSA_SUCCESS )
1425 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001426
Ronald Cron9486f9d2020-11-26 13:36:23 +01001427 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1428 {
1429 status = PSA_ERROR_INVALID_ARGUMENT;
1430 goto exit;
1431 }
1432
Ronald Crond18b5f82020-11-25 16:46:05 +01001433 psa_key_attributes_t attributes = {
1434 .core = slot->attr
1435 };
Ronald Cron67227982020-11-26 15:16:05 +01001436 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001437 &attributes, slot->key.data, slot->key.bytes,
1438 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001439
1440exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001441 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001442
Ronald Cron5c522922020-11-14 16:35:34 +01001443 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001444}
1445
Gilles Peskine91e8c332019-08-02 19:19:39 +02001446#if defined(static_assert)
1447static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1448 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001449static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001450 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001452 "One or more key attribute flag is listed as both internal-only and external-only" );
1453#endif
1454
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001455/** Validate that a key policy is internally well-formed.
1456 *
1457 * This function only rejects invalid policies. It does not validate the
1458 * consistency of the policy with respect to other attributes of the key
1459 * such as the key type.
1460 */
1461static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001462{
1463 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001464 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001465 PSA_KEY_USAGE_ENCRYPT |
1466 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001467 PSA_KEY_USAGE_SIGN_MESSAGE |
1468 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001469 PSA_KEY_USAGE_SIGN_HASH |
1470 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001471 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001472 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1473 return( PSA_ERROR_INVALID_ARGUMENT );
1474
Gilles Peskine4747d192019-04-17 15:05:45 +02001475 return( PSA_SUCCESS );
1476}
1477
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001478/** Validate the internal consistency of key attributes.
1479 *
1480 * This function only rejects invalid attribute values. If does not
1481 * validate the consistency of the attributes with any key data that may
1482 * be involved in the creation of the key.
1483 *
1484 * Call this function early in the key creation process.
1485 *
1486 * \param[in] attributes Key attributes for the new key.
1487 * \param[out] p_drv On any return, the driver for the key, if any.
1488 * NULL for a transparent key.
1489 *
1490 */
1491static psa_status_t psa_validate_key_attributes(
1492 const psa_key_attributes_t *attributes,
1493 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001494{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001495 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001496 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001497 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001498
Ronald Cron54b90082020-10-29 15:26:43 +01001499 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001500 if( status != PSA_SUCCESS )
1501 return( status );
1502
Ronald Crond2ed4812020-07-17 16:11:30 +02001503 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001504 if( status != PSA_SUCCESS )
1505 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506
Ronald Cron65f38a32020-10-23 17:11:13 +02001507 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1508 {
1509 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1510 return( PSA_ERROR_INVALID_ARGUMENT );
1511 }
1512 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001513 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001514 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1515 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001516 }
1517
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001518 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001519 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001520 return( status );
1521
1522 /* Refuse to create overly large keys.
1523 * Note that this doesn't trigger on import if the attributes don't
1524 * explicitly specify a size (so psa_get_key_bits returns 0), so
1525 * psa_import_key() needs its own checks. */
1526 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1527 return( PSA_ERROR_NOT_SUPPORTED );
1528
Gilles Peskine91e8c332019-08-02 19:19:39 +02001529 /* Reject invalid flags. These should not be reachable through the API. */
1530 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1531 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1532 return( PSA_ERROR_INVALID_ARGUMENT );
1533
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534 return( PSA_SUCCESS );
1535}
1536
Gilles Peskine4747d192019-04-17 15:05:45 +02001537/** Prepare a key slot to receive key material.
1538 *
1539 * This function allocates a key slot and sets its metadata.
1540 *
1541 * If this function fails, call psa_fail_key_creation().
1542 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001543 * This function is intended to be used as follows:
1544 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001545 * it with the specified attributes, and in case of a volatile key assign it
1546 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001547 * -# Populate the slot with the key material.
1548 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1549 * In case of failure at any step, stop the sequence and call
1550 * psa_fail_key_creation().
1551 *
Ronald Cron5c522922020-11-14 16:35:34 +01001552 * On success, the key slot is locked. It is the responsibility of the caller
1553 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001554 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001555 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001556 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001557 * \param[out] p_slot On success, a pointer to the prepared slot.
1558 * \param[out] p_drv On any return, the driver for the key, if any.
1559 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001560 *
1561 * \retval #PSA_SUCCESS
1562 * The key slot is ready to receive key material.
1563 * \return If this function fails, the key slot is an invalid state.
1564 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001565 */
1566static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001567 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001569 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001570 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001571{
1572 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001573 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 psa_key_slot_t *slot;
1575
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001577 *p_drv = NULL;
1578
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001579 status = psa_validate_key_attributes( attributes, p_drv );
1580 if( status != PSA_SUCCESS )
1581 return( status );
1582
Ronald Cronc4d1b512020-07-31 11:26:37 +02001583 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001584 if( status != PSA_SUCCESS )
1585 return( status );
1586 slot = *p_slot;
1587
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001588 /* We're storing the declared bit-size of the key. It's up to each
1589 * creation mechanism to verify that this information is correct.
1590 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001591 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001592 * is optional (import, copy). In case of a volatile key, assign it the
1593 * volatile key identifier associated to the slot returned to contain its
1594 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001595
1596 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001597 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1598 {
1599#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1600 slot->attr.id = volatile_key_id;
1601#else
1602 slot->attr.id.key_id = volatile_key_id;
1603#endif
1604 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001605
Gilles Peskine91e8c332019-08-02 19:19:39 +02001606 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001607 * external-only flags, query `attributes`. Thanks to the check
1608 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001609 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001610 * may have set. */
1611 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001612
Gilles Peskinecbaff462019-07-12 23:46:04 +02001613#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001614 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001615 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001616 * create the key file in internal storage, create the
1617 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001618 * persistent data. This is done by starting a transaction that will
1619 * encompass these three actions.
1620 * For registering a volatile key, we just need to find an appropriate
1621 * slot number inside the SE. Since the key is designated volatile, creating
1622 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001623 /* The first thing to do is to find a slot number for the new key.
1624 * We save the slot number in persistent storage as part of the
1625 * transaction data. It will be needed to recover if the power
1626 * fails during the key creation process, to clean up on the secure
1627 * element side after restarting. Obtaining a slot number from the
1628 * secure element driver updates its persistent state, but we do not yet
1629 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001630 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001631 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001632 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001633 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001634 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001635 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001636 if( status != PSA_SUCCESS )
1637 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001638
1639 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001640 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001641 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1642 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001643 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001644 psa_crypto_transaction.key.id = slot->attr.id;
1645 status = psa_crypto_save_transaction( );
1646 if( status != PSA_SUCCESS )
1647 {
1648 (void) psa_crypto_stop_transaction( );
1649 return( status );
1650 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001651 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652
1653 status = psa_copy_key_material_into_slot(
1654 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001655 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001656
1657 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1658 {
1659 /* Key registration only makes sense with a secure element. */
1660 return( PSA_ERROR_INVALID_ARGUMENT );
1661 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001662#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1663
Ronald Cronc4d1b512020-07-31 11:26:37 +02001664 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001665}
Gilles Peskine4747d192019-04-17 15:05:45 +02001666
1667/** Finalize the creation of a key once its key material has been set.
1668 *
1669 * This entails writing the key to persistent storage.
1670 *
1671 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001672 * See the documentation of psa_start_key_creation() for the intended use
1673 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001674 *
Ronald Cron5c522922020-11-14 16:35:34 +01001675 * If the finalization succeeds, the function unlocks the key slot (it was
1676 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1677 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001678 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001679 * \param[in,out] slot Pointer to the slot with key material.
1680 * \param[in] driver The secure element driver for the key,
1681 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001682 * \param[out] key On success, identifier of the key. Note that the
1683 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001684 *
1685 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001686 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001687 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1688 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1689 * \retval #PSA_ERROR_ALREADY_EXISTS
1690 * \retval #PSA_ERROR_DATA_INVALID
1691 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001692 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001693 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001694 * \return If this function fails, the key slot is an invalid state.
1695 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001696 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001697static psa_status_t psa_finish_key_creation(
1698 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001699 psa_se_drv_table_entry_t *driver,
1700 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001701{
1702 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001703 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001704 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001705
1706#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001707 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001708 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001709#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1710 if( driver != NULL )
1711 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001712 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001713 psa_key_slot_number_t slot_number =
1714 psa_key_slot_get_slot_number( slot ) ;
1715
Gilles Peskineb46bef22019-07-30 21:32:04 +02001716#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001717 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718 sizeof( data.slot_number ),
1719 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001722 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001723 (uint8_t*) &data,
1724 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001725 }
1726 else
1727#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1728 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001729 /* Key material is saved in export representation in the slot, so
1730 * just pass the slot buffer for storage. */
1731 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001732 slot->key.data,
1733 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001734 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001735 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001736#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1737
Gilles Peskinecbaff462019-07-12 23:46:04 +02001738#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001739 /* Finish the transaction for a key creation. This does not
1740 * happen when registering an existing key. Detect this case
1741 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001742 * creation of a persistent key in a secure element requires a transaction,
1743 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001744 if( driver != NULL &&
1745 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001746 {
1747 status = psa_save_se_persistent_data( driver );
1748 if( status != PSA_SUCCESS )
1749 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001750 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001751 return( status );
1752 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001753 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001754 }
1755#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1756
Ronald Cron50972942020-11-14 11:28:25 +01001757 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001758 {
1759 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001760 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001761 if( status != PSA_SUCCESS )
1762 *key = MBEDTLS_SVC_KEY_ID_INIT;
1763 }
Ronald Cron50972942020-11-14 11:28:25 +01001764
Gilles Peskine4747d192019-04-17 15:05:45 +02001765 return( status );
1766}
1767
1768/** Abort the creation of a key.
1769 *
1770 * You may call this function after calling psa_start_key_creation(),
1771 * or after psa_finish_key_creation() fails. In other circumstances, this
1772 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001773 * See the documentation of psa_start_key_creation() for the intended use
1774 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001775 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001776 * \param[in,out] slot Pointer to the slot with key material.
1777 * \param[in] driver The secure element driver for the key,
1778 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001780static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001781 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001782{
Gilles Peskine011e4282019-06-26 18:34:38 +02001783 (void) driver;
1784
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 if( slot == NULL )
1786 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001787
1788#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001789 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 * element, and the failure happened later (when saving metadata
1791 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001792 * element.
1793 * https://github.com/ARMmbed/mbed-crypto/issues/217
1794 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001795
Gilles Peskined7729582019-08-05 15:55:54 +02001796 /* Abort the ongoing transaction if any (there may not be one if
1797 * the creation process failed before starting one, or if the
1798 * key creation is a registration of a key in a secure element).
1799 * Earlier functions must already have done what it takes to undo any
1800 * partial creation. All that's left is to update the transaction data
1801 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001802 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001803#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1804
Gilles Peskine4747d192019-04-17 15:05:45 +02001805 psa_wipe_key_slot( slot );
1806}
1807
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001808/** Validate optional attributes during key creation.
1809 *
1810 * Some key attributes are optional during key creation. If they are
1811 * specified in the attributes structure, check that they are consistent
1812 * with the data in the slot.
1813 *
1814 * This function should be called near the end of key creation, after
1815 * the slot in memory is fully populated but before saving persistent data.
1816 */
1817static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001818 const psa_key_slot_t *slot,
1819 const psa_key_attributes_t *attributes )
1820{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001821 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001822 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001823 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001824 return( PSA_ERROR_INVALID_ARGUMENT );
1825 }
1826
1827 if( attributes->domain_parameters_size != 0 )
1828 {
John Durkop0e005192020-10-31 22:06:54 -07001829#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1830 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001831 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001832 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001833 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001834 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001836
Ronald Cron90857082020-11-25 14:58:33 +01001837 psa_status_t status = mbedtls_psa_rsa_load_representation(
1838 slot->attr.type,
1839 slot->key.data,
1840 slot->key.bytes,
1841 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001842 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001843 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001844
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001845 mbedtls_mpi_init( &actual );
1846 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001847 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001849 mbedtls_rsa_free( rsa );
1850 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001851 if( ret != 0 )
1852 goto rsa_exit;
1853 ret = mbedtls_mpi_read_binary( &required,
1854 attributes->domain_parameters,
1855 attributes->domain_parameters_size );
1856 if( ret != 0 )
1857 goto rsa_exit;
1858 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1859 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1860 rsa_exit:
1861 mbedtls_mpi_free( &actual );
1862 mbedtls_mpi_free( &required );
1863 if( ret != 0)
1864 return( mbedtls_to_psa_error( ret ) );
1865 }
1866 else
John Durkop9814fa22020-11-04 12:28:15 -08001867#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1868 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 {
1870 return( PSA_ERROR_INVALID_ARGUMENT );
1871 }
1872 }
1873
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001874 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001876 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 return( PSA_ERROR_INVALID_ARGUMENT );
1878 }
1879
1880 return( PSA_SUCCESS );
1881}
1882
Gilles Peskine4747d192019-04-17 15:05:45 +02001883psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001885 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001886 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001887{
1888 psa_status_t status;
1889 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001890 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001891 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301892 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893
Ronald Cron81709fc2020-11-14 12:10:32 +01001894 *key = MBEDTLS_SVC_KEY_ID_INIT;
1895
Gilles Peskine0f84d622019-09-12 19:03:13 +02001896 /* Reject zero-length symmetric keys (including raw data key objects).
1897 * This also rejects any key which might be encoded as an empty string,
1898 * which is never valid. */
1899 if( data_length == 0 )
1900 return( PSA_ERROR_INVALID_ARGUMENT );
1901
Archana449608b2021-09-08 15:36:05 +05301902 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301903 if( data_length > SIZE_MAX / 8 )
1904 return( PSA_ERROR_NOT_SUPPORTED );
1905
Gilles Peskinedf179142019-07-15 22:02:14 +02001906 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001907 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908 if( status != PSA_SUCCESS )
1909 goto exit;
1910
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001911 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301912 * storage ( thus not in the case of importing a key in a secure element
1913 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1914 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001915 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001916 {
Archanad8a83dc2021-06-14 10:04:16 +05301917 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1918 {
Archana449608b2021-09-08 15:36:05 +05301919 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1920 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301921 if( status != PSA_SUCCESS )
1922 goto exit;
1923 }
1924 status = psa_allocate_buffer_to_slot( slot, storage_size );
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
Archana6ed4bda2021-08-04 10:47:15 +05301946 /* Enforce a size limit, and in particular ensure that the bit
1947 * size fits in its representation type.*/
1948 if( bits > PSA_MAX_KEY_BITS )
1949 {
1950 status = PSA_ERROR_NOT_SUPPORTED;
1951 goto exit;
1952 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001953 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001954 if( status != PSA_SUCCESS )
1955 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001956
Ronald Cron81709fc2020-11-14 12:10:32 +01001957 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001959 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001960 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001961
Gilles Peskine4747d192019-04-17 15:05:45 +02001962 return( status );
1963}
1964
Gilles Peskined7729582019-08-05 15:55:54 +02001965#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1966psa_status_t mbedtls_psa_register_se_key(
1967 const psa_key_attributes_t *attributes )
1968{
1969 psa_status_t status;
1970 psa_key_slot_t *slot = NULL;
1971 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001972 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001973
1974 /* Leaving attributes unspecified is not currently supported.
1975 * It could make sense to query the key type and size from the
1976 * secure element, but not all secure elements support this
1977 * and the driver HAL doesn't currently support it. */
1978 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1979 return( PSA_ERROR_NOT_SUPPORTED );
1980 if( psa_get_key_bits( attributes ) == 0 )
1981 return( PSA_ERROR_NOT_SUPPORTED );
1982
1983 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001984 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001985 if( status != PSA_SUCCESS )
1986 goto exit;
1987
Ronald Cron81709fc2020-11-14 12:10:32 +01001988 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001989
1990exit:
1991 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001992 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001993
Gilles Peskined7729582019-08-05 15:55:54 +02001994 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001995 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001996 return( status );
1997}
1998#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1999
Ronald Croncf56a0a2020-08-04 09:51:30 +02002000psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002001 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002003{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002004 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002005 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002006 psa_key_slot_t *source_slot = NULL;
2007 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002008 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002009 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302010 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002011
Ronald Cron81709fc2020-11-14 12:10:32 +01002012 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2013
Archana8a180362021-07-05 02:18:48 +05302014 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002015 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002016 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002017 goto exit;
2018
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002019 status = psa_validate_optional_attributes( source_slot,
2020 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002021 if( status != PSA_SUCCESS )
2022 goto exit;
2023
Archana9d17bf42021-09-10 06:22:44 +05302024 /* The target key type and number of bits have been validated by
2025 * psa_validate_optional_attributes() to be either equal to zero or
2026 * equal to the ones of the source key. So it is safe to inherit
2027 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302028 * */
Archana9d17bf42021-09-10 06:22:44 +05302029 actual_attributes.core.bits = source_slot->attr.bits;
2030 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302031
2032
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002033 status = psa_restrict_key_policy( source_slot->attr.type,
2034 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002035 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 if( status != PSA_SUCCESS )
2037 goto exit;
2038
Ronald Cron81709fc2020-11-14 12:10:32 +01002039 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2040 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002041 if( status != PSA_SUCCESS )
2042 goto exit;
Archana8a180362021-07-05 02:18:48 +05302043 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2044 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002045 {
Archana8a180362021-07-05 02:18:48 +05302046 /*
Archana9d17bf42021-09-10 06:22:44 +05302047 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302048 * the source key would need to be exported as plaintext and re-imported
2049 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302050 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302051 * appropriate API invocations from the application, if needed.
2052 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002053 status = PSA_ERROR_NOT_SUPPORTED;
2054 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002055 }
Archana8a180362021-07-05 02:18:48 +05302056 /*
2057 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302058 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302059 * - For opaque keys this translates to an invocation of the drivers'
2060 * copy_key entry point through the dispatch layer.
2061 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002062 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2063 {
Archana8a180362021-07-05 02:18:48 +05302064 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302065 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302066 if( status != PSA_SUCCESS )
2067 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302068
Archana8a180362021-07-05 02:18:48 +05302069 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2070 if( status != PSA_SUCCESS )
2071 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302072
Archana8a180362021-07-05 02:18:48 +05302073 status = psa_driver_wrapper_copy_key( &actual_attributes,
2074 source_slot->key.data,
2075 source_slot->key.bytes,
2076 target_slot->key.data,
2077 target_slot->key.bytes,
2078 &target_slot->key.bytes );
2079 if( status != PSA_SUCCESS )
2080 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002081 }
Archana8a180362021-07-05 02:18:48 +05302082 else
2083 {
Archana9d17bf42021-09-10 06:22:44 +05302084 status = psa_copy_key_material_into_slot( target_slot,
2085 source_slot->key.data,
2086 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302087 if( status != PSA_SUCCESS )
2088 goto exit;
2089 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002090 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002091exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002092 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002093 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002094
Ronald Cron5c522922020-11-14 16:35:34 +01002095 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002096
Ronald Cron5c522922020-11-14 16:35:34 +01002097 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002098}
2099
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002100
2101
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002102/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002103/* Message digests */
2104/****************************************************************/
2105
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002106psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2107{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002108 /* Aborting a non-active operation is allowed */
2109 if( operation->id == 0 )
2110 return( PSA_SUCCESS );
2111
2112 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2113 operation->id = 0;
2114
2115 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002116}
2117
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002118psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002119 psa_algorithm_t alg )
2120{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002122
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002123 /* A context must be freshly initialized before it can be set up. */
2124 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002125 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126 status = PSA_ERROR_BAD_STATE;
2127 goto exit;
2128 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002129
2130 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002131 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002132 status = PSA_ERROR_INVALID_ARGUMENT;
2133 goto exit;
2134 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002135
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002136 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2137 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002138 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2139
Dave Rodgman685b6a72021-06-24 11:49:14 +01002140 status = psa_driver_wrapper_hash_setup( operation, alg );
2141
2142exit:
2143 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002144 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002145
2146 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147}
2148
2149psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2150 const uint8_t *input,
2151 size_t input_length )
2152{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2154
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002155 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002156 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002157 status = PSA_ERROR_BAD_STATE;
2158 goto exit;
2159 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002160
Steven Cooremanc8288352021-03-04 14:02:19 +01002161 /* Don't require hash implementations to behave correctly on a
2162 * zero-length input, which may have an invalid pointer. */
2163 if( input_length == 0 )
2164 return( PSA_SUCCESS );
2165
Dave Rodgman685b6a72021-06-24 11:49:14 +01002166 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2167
2168exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002169 if( status != PSA_SUCCESS )
2170 psa_hash_abort( operation );
2171
2172 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173}
2174
2175psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2176 uint8_t *hash,
2177 size_t hash_size,
2178 size_t *hash_length )
2179{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002180 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002181 if( operation->id == 0 )
2182 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183
Steven Cooreman1e582352021-02-18 17:24:37 +01002184 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002185 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002186 psa_hash_abort( operation );
2187 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002188}
2189
Gilles Peskine2d277862018-06-18 15:41:12 +02002190psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2191 const uint8_t *hash,
2192 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002193{
2194 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2195 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002196 psa_status_t status = psa_hash_finish(
2197 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002198 actual_hash, sizeof( actual_hash ),
2199 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002200
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002202 goto exit;
2203
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002204 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002205 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002206 status = PSA_ERROR_INVALID_SIGNATURE;
2207 goto exit;
2208 }
2209
Steven Cooreman36876a02021-04-29 16:37:59 +02002210 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002211 status = PSA_ERROR_INVALID_SIGNATURE;
2212
2213exit:
2214 if( status != PSA_SUCCESS )
2215 psa_hash_abort(operation);
2216
2217 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002218}
2219
Gilles Peskine0a749c82019-11-28 19:33:58 +01002220psa_status_t psa_hash_compute( psa_algorithm_t alg,
2221 const uint8_t *input, size_t input_length,
2222 uint8_t *hash, size_t hash_size,
2223 size_t *hash_length )
2224{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002225 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002226 if( !PSA_ALG_IS_HASH( alg ) )
2227 return( PSA_ERROR_INVALID_ARGUMENT );
2228
Steven Cooreman1e582352021-02-18 17:24:37 +01002229 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2230 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002231}
2232
2233psa_status_t psa_hash_compare( psa_algorithm_t alg,
2234 const uint8_t *input, size_t input_length,
2235 const uint8_t *hash, size_t hash_length )
2236{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002237 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2238 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002239
2240 if( !PSA_ALG_IS_HASH( alg ) )
2241 return( PSA_ERROR_INVALID_ARGUMENT );
2242
Steven Cooreman1e582352021-02-18 17:24:37 +01002243 psa_status_t status = psa_driver_wrapper_hash_compute(
2244 alg, input, input_length,
2245 actual_hash, sizeof(actual_hash),
2246 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002247 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002248 return( status );
2249 if( actual_hash_length != hash_length )
2250 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002251 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002252 return( PSA_ERROR_INVALID_SIGNATURE );
2253 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002254}
2255
Gilles Peskineeb35d782019-01-22 17:56:16 +01002256psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2257 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002258{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002259 if( source_operation->id == 0 ||
2260 target_operation->id != 0 )
2261 {
2262 return( PSA_ERROR_BAD_STATE );
2263 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002264
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002265 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2266 target_operation );
2267 if( status != PSA_SUCCESS )
2268 psa_hash_abort( target_operation );
2269
2270 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002271}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002272
2273
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002274/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002275/* MAC */
2276/****************************************************************/
2277
Steven Cooremane6804192021-03-19 18:28:56 +01002278psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002279{
Steven Cooremane6804192021-03-19 18:28:56 +01002280 /* Aborting a non-active operation is allowed */
2281 if( operation->id == 0 )
2282 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002283
Steven Cooremane6804192021-03-19 18:28:56 +01002284 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002285 operation->mac_size = 0;
2286 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002287 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002288
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002289 return( status );
2290}
2291
Ronald Cron2dff3b22021-06-17 16:33:22 +02002292static psa_status_t psa_mac_finalize_alg_and_key_validation(
2293 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002294 const psa_key_attributes_t *attributes,
2295 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002296{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002297 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002298 psa_key_type_t key_type = psa_get_key_type( attributes );
2299 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002300
Ronald Cron28ea0502021-06-17 16:10:24 +02002301 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002302 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002303
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002304 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002305 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002306 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002307 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002308
Steven Cooremand1a68f12021-05-10 11:13:41 +02002309 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002310 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002311
Ronald Cron79bdd822021-06-17 16:46:44 +02002312 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002313 {
2314 /* A very short MAC is too short for security since it can be
2315 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2316 * so we make this our minimum, even though 32 bits is still
2317 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002318 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002319 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002320
Ronald Cron79bdd822021-06-17 16:46:44 +02002321 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2322 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002323 {
2324 /* It's impossible to "truncate" to a larger length than the full length
2325 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002326 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002327 }
2328
Ronald Cron79bdd822021-06-17 16:46:44 +02002329 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002330}
2331
Gilles Peskinee59236f2018-01-27 23:32:46 +01002332static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2333 mbedtls_svc_key_id_t key,
2334 psa_algorithm_t alg,
2335 int is_sign )
2336{
2337 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2338 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002339 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002340
2341 /* A context must be freshly initialized before it can be set up. */
2342 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002343 {
Dave Rodgman54648242021-06-24 11:49:45 +01002344 status = PSA_ERROR_BAD_STATE;
2345 goto exit;
2346 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002347
Gilles Peskine8c9def32018-02-08 10:02:12 +01002348 status = psa_get_and_lock_key_slot_with_policy(
2349 key,
2350 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002351 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002352 alg );
2353 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002354 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355
2356 psa_key_attributes_t attributes = {
2357 .core = slot->attr
2358 };
2359
Ronald Cron79bdd822021-06-17 16:46:44 +02002360 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2361 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002362 if( status != PSA_SUCCESS )
2363 goto exit;
2364
2365 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002366 /* Dispatch the MAC setup call with validated input */
2367 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002368 {
Steven Cooremane6804192021-03-19 18:28:56 +01002369 status = psa_driver_wrapper_mac_sign_setup( operation,
2370 &attributes,
2371 slot->key.data,
2372 slot->key.bytes,
2373 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002374 }
2375 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002376 {
Steven Cooremane6804192021-03-19 18:28:56 +01002377 status = psa_driver_wrapper_mac_verify_setup( operation,
2378 &attributes,
2379 slot->key.data,
2380 slot->key.bytes,
2381 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002382 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002383
Gilles Peskinefbfac682018-07-08 20:51:54 +02002384exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002385 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002386 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002387
Ronald Cron5c522922020-11-14 16:35:34 +01002388 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002389
Ronald Cron5c522922020-11-14 16:35:34 +01002390 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002391}
2392
Gilles Peskine89167cb2018-07-08 20:12:23 +02002393psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002394 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002395 psa_algorithm_t alg )
2396{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002397 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002398}
2399
2400psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002401 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002402 psa_algorithm_t alg )
2403{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002404 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002405}
2406
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002407psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002408 const uint8_t *input,
2409 size_t input_length )
2410{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002411 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002412 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002413
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002414 /* Don't require hash implementations to behave correctly on a
2415 * zero-length input, which may have an invalid pointer. */
2416 if( input_length == 0 )
2417 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002418
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002419 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2420 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002421 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002422 psa_mac_abort( operation );
2423
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002424 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425}
2426
Steven Cooremana5b860a2021-03-19 19:04:39 +01002427psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002428 uint8_t *mac,
2429 size_t mac_size,
2430 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002431{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002432 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2433 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002434
Steven Cooremana5b860a2021-03-19 19:04:39 +01002435 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002436 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002437 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002438 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002439 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002440
Steven Cooreman72f736a2021-05-07 14:14:37 +02002441 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002442 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002443 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002444 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002445 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002446
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002447 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2448 * once all the error checks are done. */
2449 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002450 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002451 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002452 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002453 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002454
2455 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002456 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002457 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002458 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002459 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002460
Steven Cooremana5b860a2021-03-19 19:04:39 +01002461 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002462 mac, operation->mac_size,
2463 mac_length );
2464
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002465exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002466 /* In case of success, set the potential excess room in the output buffer
2467 * to an invalid value, to avoid potentially leaking a longer MAC.
2468 * In case of error, set the output length and content to a safe default,
2469 * such that in case the caller misses an error check, the output would be
2470 * an unachievable MAC.
2471 */
2472 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002473 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002474 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002475 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002476 }
mohammad16036df908f2018-04-02 08:34:15 -07002477
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002478 if( mac_size > operation->mac_size )
2479 memset( &mac[operation->mac_size], '!',
2480 mac_size - operation->mac_size );
2481
Steven Cooremana5b860a2021-03-19 19:04:39 +01002482 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002483
Steven Cooremana5b860a2021-03-19 19:04:39 +01002484 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002485}
2486
Steven Cooremana5b860a2021-03-19 19:04:39 +01002487psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002488 const uint8_t *mac,
2489 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002490{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002491 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2492 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002493
Steven Cooremana5b860a2021-03-19 19:04:39 +01002494 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002495 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002496 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002497 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002498 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002499
Steven Cooreman72f736a2021-05-07 14:14:37 +02002500 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002501 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002502 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002503 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002504 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002505
2506 if( operation->mac_size != mac_length )
2507 {
2508 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002509 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002510 }
2511
Steven Cooremana5b860a2021-03-19 19:04:39 +01002512 status = psa_driver_wrapper_mac_verify_finish( operation,
2513 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002514
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002515exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002516 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002517
Steven Cooremana5b860a2021-03-19 19:04:39 +01002518 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002519}
2520
Ronald Croncd989b52021-06-18 14:23:33 +02002521static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2522 psa_algorithm_t alg,
2523 const uint8_t *input,
2524 size_t input_length,
2525 uint8_t *mac,
2526 size_t mac_size,
2527 size_t *mac_length,
2528 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002529{
2530 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002531 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2532 psa_key_slot_t *slot;
2533 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002534
Ronald Cron51131b52021-06-17 17:17:20 +02002535 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002536 key,
2537 &slot,
2538 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002539 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002540 if( status != PSA_SUCCESS )
2541 goto exit;
2542
Ronald Cron51131b52021-06-17 17:17:20 +02002543 psa_key_attributes_t attributes = {
2544 .core = slot->attr
2545 };
2546
2547 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2548 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002549 if( status != PSA_SUCCESS )
2550 goto exit;
2551
Ronald Cron51131b52021-06-17 17:17:20 +02002552 if( mac_size < operation_mac_size )
2553 {
2554 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002555 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002556 }
2557
2558 status = psa_driver_wrapper_mac_compute(
2559 &attributes,
2560 slot->key.data, slot->key.bytes,
2561 alg,
2562 input, input_length,
2563 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002564
2565exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002566 /* In case of success, set the potential excess room in the output buffer
2567 * to an invalid value, to avoid potentially leaking a longer MAC.
2568 * In case of error, set the output length and content to a safe default,
2569 * such that in case the caller misses an error check, the output would be
2570 * an unachievable MAC.
2571 */
2572 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002573 {
Ronald Cron51131b52021-06-17 17:17:20 +02002574 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002575 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002576 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002577 if( mac_size > operation_mac_size )
2578 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002579
Ronald Cron51131b52021-06-17 17:17:20 +02002580 unlock_status = psa_unlock_key_slot( slot );
2581
2582 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002583}
2584
Ronald Croncd989b52021-06-18 14:23:33 +02002585psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2586 psa_algorithm_t alg,
2587 const uint8_t *input,
2588 size_t input_length,
2589 uint8_t *mac,
2590 size_t mac_size,
2591 size_t *mac_length)
2592{
2593 return( psa_mac_compute_internal( key, alg,
2594 input, input_length,
2595 mac, mac_size, mac_length, 1 ) );
2596}
2597
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002598psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2599 psa_algorithm_t alg,
2600 const uint8_t *input,
2601 size_t input_length,
2602 const uint8_t *mac,
2603 size_t mac_length)
2604{
2605 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002606 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2607 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002608
Ronald Crona587cbc2021-06-18 14:51:29 +02002609 status = psa_mac_compute_internal( key, alg,
2610 input, input_length,
2611 actual_mac, sizeof( actual_mac ),
2612 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002613 if( status != PSA_SUCCESS )
2614 goto exit;
2615
Ronald Crona587cbc2021-06-18 14:51:29 +02002616 if( mac_length != actual_mac_length )
2617 {
2618 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002619 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002620 }
2621 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2622 {
2623 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002624 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002625 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002626
2627exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002628 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002629
2630 return ( status );
2631}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002632
Gilles Peskinee59236f2018-01-27 23:32:46 +01002633/****************************************************************/
2634/* Asymmetric cryptography */
2635/****************************************************************/
2636
gabor-mezei-armf0486182021-05-12 11:03:09 +02002637static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002638 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002639{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002640 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002641 {
2642 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2643 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002644
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002645 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2646 {
2647 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2648 return( PSA_ERROR_INVALID_ARGUMENT );
2649 }
2650 }
2651 else
2652 {
2653 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2654 return( PSA_ERROR_INVALID_ARGUMENT );
2655 }
2656
2657 return( PSA_SUCCESS );
2658}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002659
2660static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002661 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002662 psa_algorithm_t alg,
2663 const uint8_t * input,
2664 size_t input_length,
2665 uint8_t * signature,
2666 size_t signature_size,
2667 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002668{
2669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2670 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2671 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002672
2673 *signature_length = 0;
2674
gabor-mezei-armf0486182021-05-12 11:03:09 +02002675 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002676 if( status != PSA_SUCCESS )
2677 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002678
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002679 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002680 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002681 * buffer can in principle be empty since it doesn't actually have
2682 * to be a hash.) */
2683 if( signature_size == 0 )
2684 return( PSA_ERROR_BUFFER_TOO_SMALL );
2685
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002686 status = psa_get_and_lock_key_slot_with_policy(
2687 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002688 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2689 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002690 alg );
2691
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002692 if( status != PSA_SUCCESS )
2693 goto exit;
2694
2695 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2696 {
2697 status = PSA_ERROR_INVALID_ARGUMENT;
2698 goto exit;
2699 }
2700
2701 psa_key_attributes_t attributes = {
2702 .core = slot->attr
2703 };
2704
gabor-mezei-armf0486182021-05-12 11:03:09 +02002705 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002706 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002707 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002708 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002709 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002710 signature, signature_size, signature_length );
2711 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002712 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002713 {
2714
2715 status = psa_driver_wrapper_sign_hash(
2716 &attributes, slot->key.data, slot->key.bytes,
2717 alg, input, input_length,
2718 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002719 }
2720
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002721
2722exit:
2723 /* Fill the unused part of the output buffer (the whole buffer on error,
2724 * the trailing part on success) with something that isn't a valid signature
2725 * (barring an attack on the signature and deliberately-crafted input),
2726 * in case the caller doesn't check the return status properly. */
2727 if( status == PSA_SUCCESS )
2728 memset( signature + *signature_length, '!',
2729 signature_size - *signature_length );
2730 else
2731 memset( signature, '!', signature_size );
2732 /* If signature_size is 0 then we have nothing to do. We must not call
2733 * memset because signature may be NULL in this case. */
2734
2735 unlock_status = psa_unlock_key_slot( slot );
2736
2737 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2738}
2739
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002740static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002741 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002742 psa_algorithm_t alg,
2743 const uint8_t * input,
2744 size_t input_length,
2745 const uint8_t * signature,
2746 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002747{
2748 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2749 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2750 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002751
gabor-mezei-armf0486182021-05-12 11:03:09 +02002752 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002753 if( status != PSA_SUCCESS )
2754 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002755
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002756 status = psa_get_and_lock_key_slot_with_policy(
2757 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002758 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2759 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002760 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002761
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002762 if( status != PSA_SUCCESS )
2763 return( status );
2764
2765 psa_key_attributes_t attributes = {
2766 .core = slot->attr
2767 };
2768
gabor-mezei-armf0486182021-05-12 11:03:09 +02002769 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002770 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002771 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002772 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002773 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002774 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002775 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002776 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002777 {
2778 status = psa_driver_wrapper_verify_hash(
2779 &attributes, slot->key.data, slot->key.bytes,
2780 alg, input, input_length,
2781 signature, signature_length );
2782 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002783
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002784 unlock_status = psa_unlock_key_slot( slot );
2785
2786 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002787
2788}
2789
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002790psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002791 const psa_key_attributes_t *attributes,
2792 const uint8_t *key_buffer,
2793 size_t key_buffer_size,
2794 psa_algorithm_t alg,
2795 const uint8_t *input,
2796 size_t input_length,
2797 uint8_t *signature,
2798 size_t signature_size,
2799 size_t *signature_length )
2800{
2801 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002802
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002803 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2804 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002805 size_t hash_length;
2806 uint8_t hash[PSA_HASH_MAX_SIZE];
2807
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002808 status = psa_driver_wrapper_hash_compute(
2809 PSA_ALG_SIGN_GET_HASH( alg ),
2810 input, input_length,
2811 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002812
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002813 if( status != PSA_SUCCESS )
2814 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002815
2816 return psa_driver_wrapper_sign_hash(
2817 attributes, key_buffer, key_buffer_size,
2818 alg, hash, hash_length,
2819 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002820 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002821
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002822 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002823}
2824
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002825psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2826 psa_algorithm_t alg,
2827 const uint8_t * input,
2828 size_t input_length,
2829 uint8_t * signature,
2830 size_t signature_size,
2831 size_t * signature_length )
2832{
2833 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002834 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002835 signature, signature_size, signature_length );
2836}
2837
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002838psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002839 const psa_key_attributes_t *attributes,
2840 const uint8_t *key_buffer,
2841 size_t key_buffer_size,
2842 psa_algorithm_t alg,
2843 const uint8_t *input,
2844 size_t input_length,
2845 const uint8_t *signature,
2846 size_t signature_length )
2847{
2848 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002849
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002850 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2851 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002852 size_t hash_length;
2853 uint8_t hash[PSA_HASH_MAX_SIZE];
2854
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002855 status = psa_driver_wrapper_hash_compute(
2856 PSA_ALG_SIGN_GET_HASH( alg ),
2857 input, input_length,
2858 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002859
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002860 if( status != PSA_SUCCESS )
2861 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002862
2863 return psa_driver_wrapper_verify_hash(
2864 attributes, key_buffer, key_buffer_size,
2865 alg, hash, hash_length,
2866 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002867 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002868
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002869 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002870}
2871
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002872psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2873 psa_algorithm_t alg,
2874 const uint8_t * input,
2875 size_t input_length,
2876 const uint8_t * signature,
2877 size_t signature_length )
2878{
2879 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002880 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002881 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002882}
2883
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002884psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002885 const psa_key_attributes_t *attributes,
2886 const uint8_t *key_buffer, size_t key_buffer_size,
2887 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2888 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002889{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002890 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002891 {
Ronald Cron4501c982021-03-19 20:09:32 +01002892 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2893 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002894 {
Ronald Cron4501c982021-03-19 20:09:32 +01002895#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2896 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2897 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002898 attributes,
2899 key_buffer, key_buffer_size,
2900 alg, hash, hash_length,
2901 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002902#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2903 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002904 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002905 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002906 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002907 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002908 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002909 }
2910 else
Ronald Cron4501c982021-03-19 20:09:32 +01002911 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2912 {
2913 if( PSA_ALG_IS_ECDSA( alg ) )
2914 {
2915#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2916 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2917 return( mbedtls_psa_ecdsa_sign_hash(
2918 attributes,
2919 key_buffer, key_buffer_size,
2920 alg, hash, hash_length,
2921 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002922#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2923 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002924 }
2925 else
2926 {
2927 return( PSA_ERROR_INVALID_ARGUMENT );
2928 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002929 }
Ronald Cron4501c982021-03-19 20:09:32 +01002930
2931 (void)key_buffer;
2932 (void)key_buffer_size;
2933 (void)hash;
2934 (void)hash_length;
2935 (void)signature;
2936 (void)signature_size;
2937 (void)signature_length;
2938
2939 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002940}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002941
2942psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2943 psa_algorithm_t alg,
2944 const uint8_t *hash,
2945 size_t hash_length,
2946 uint8_t *signature,
2947 size_t signature_size,
2948 size_t *signature_length )
2949{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002950 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002951 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002952 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002953}
2954
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002955psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002956 const psa_key_attributes_t *attributes,
2957 const uint8_t *key_buffer, size_t key_buffer_size,
2958 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2959 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002960{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002961 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002962 {
Ronald Cron4501c982021-03-19 20:09:32 +01002963 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2964 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002965 {
Ronald Cron4501c982021-03-19 20:09:32 +01002966#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2967 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2968 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002969 attributes,
2970 key_buffer, key_buffer_size,
2971 alg, hash, hash_length,
2972 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002973#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2974 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002975 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002976 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002977 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002978 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002979 }
itayzafrir5c753392018-05-08 11:18:38 +03002980 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002981 else
Ronald Cron4501c982021-03-19 20:09:32 +01002982 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002983 {
Ronald Cron4501c982021-03-19 20:09:32 +01002984 if( PSA_ALG_IS_ECDSA( alg ) )
2985 {
2986#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2987 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2988 return( mbedtls_psa_ecdsa_verify_hash(
2989 attributes,
2990 key_buffer, key_buffer_size,
2991 alg, hash, hash_length,
2992 signature, signature_length ) );
2993#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2994 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2995 }
2996 else
2997 {
2998 return( PSA_ERROR_INVALID_ARGUMENT );
2999 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003000 }
Ronald Cron4501c982021-03-19 20:09:32 +01003001
3002 (void)key_buffer;
3003 (void)key_buffer_size;
3004 (void)hash;
3005 (void)hash_length;
3006 (void)signature;
3007 (void)signature_length;
3008
3009 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003010}
3011
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003012psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3013 psa_algorithm_t alg,
3014 const uint8_t *hash,
3015 size_t hash_length,
3016 const uint8_t *signature,
3017 size_t signature_length )
3018{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003019 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003020 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003021 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003022}
3023
John Durkop0e005192020-10-31 22:06:54 -07003024#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003025static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3026 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003027{
3028 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3029 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3030 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003031
3032 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003033}
John Durkop0e005192020-10-31 22:06:54 -07003034#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003035
Ronald Croncf56a0a2020-08-04 09:51:30 +02003036psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003037 psa_algorithm_t alg,
3038 const uint8_t *input,
3039 size_t input_length,
3040 const uint8_t *salt,
3041 size_t salt_length,
3042 uint8_t *output,
3043 size_t output_size,
3044 size_t *output_length )
3045{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003046 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003047 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003048 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003049
Darryl Green5cc689a2018-07-24 15:34:10 +01003050 (void) input;
3051 (void) input_length;
3052 (void) salt;
3053 (void) output;
3054 (void) output_size;
3055
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003056 *output_length = 0;
3057
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003058 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3059 return( PSA_ERROR_INVALID_ARGUMENT );
3060
Ronald Cron5c522922020-11-14 16:35:34 +01003061 status = psa_get_and_lock_transparent_key_slot_with_policy(
3062 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003063 if( status != PSA_SUCCESS )
3064 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003065 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3066 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003067 {
3068 status = PSA_ERROR_INVALID_ARGUMENT;
3069 goto exit;
3070 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003071
John Durkop6ba40d12020-11-10 08:50:04 -08003072#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3073 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003074 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003076 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003077 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3078 slot->key.data,
3079 slot->key.bytes,
3080 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003081 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003082 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003083
3084 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003085 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003086 status = PSA_ERROR_BUFFER_TOO_SMALL;
3087 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003088 }
John Durkop0e005192020-10-31 22:06:54 -07003089#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003090 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3091 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003092 status = mbedtls_to_psa_error(
3093 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003094 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003095 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003096 input_length,
3097 input,
3098 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003099 }
3100 else
John Durkop0e005192020-10-31 22:06:54 -07003101#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3102#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3104 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003105 status = mbedtls_to_psa_error(
3106 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3107 if( status != PSA_SUCCESS )
3108 goto rsa_exit;
3109
Steven Cooreman4fed4552020-08-03 14:46:03 +02003110 status = mbedtls_to_psa_error(
3111 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003112 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003113 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003114 salt, salt_length,
3115 input_length,
3116 input,
3117 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003118 }
3119 else
John Durkop0e005192020-10-31 22:06:54 -07003120#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003122 status = PSA_ERROR_INVALID_ARGUMENT;
3123 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003125rsa_exit:
3126 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003127 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003128
Steven Cooremana2371e52020-07-28 14:30:39 +02003129 mbedtls_rsa_free( rsa );
3130 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003131 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003132 else
John Durkop9814fa22020-11-04 12:28:15 -08003133#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003134 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003135 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003136 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003137 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003138
3139exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003140 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003141
Ronald Cron5c522922020-11-14 16:35:34 +01003142 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003143}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003144
Ronald Croncf56a0a2020-08-04 09:51:30 +02003145psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003146 psa_algorithm_t alg,
3147 const uint8_t *input,
3148 size_t input_length,
3149 const uint8_t *salt,
3150 size_t salt_length,
3151 uint8_t *output,
3152 size_t output_size,
3153 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003156 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003157 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003158
Darryl Green5cc689a2018-07-24 15:34:10 +01003159 (void) input;
3160 (void) input_length;
3161 (void) salt;
3162 (void) output;
3163 (void) output_size;
3164
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003165 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003167 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3168 return( PSA_ERROR_INVALID_ARGUMENT );
3169
Ronald Cron5c522922020-11-14 16:35:34 +01003170 status = psa_get_and_lock_transparent_key_slot_with_policy(
3171 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003172 if( status != PSA_SUCCESS )
3173 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003174 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003175 {
3176 status = PSA_ERROR_INVALID_ARGUMENT;
3177 goto exit;
3178 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003179
John Durkop6ba40d12020-11-10 08:50:04 -08003180#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3181 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003182 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003183 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003184 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003185 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3186 slot->key.data,
3187 slot->key.bytes,
3188 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003189 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003190 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003191
Steven Cooremana2371e52020-07-28 14:30:39 +02003192 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003193 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003194 status = PSA_ERROR_INVALID_ARGUMENT;
3195 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003196 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003197
John Durkop0e005192020-10-31 22:06:54 -07003198#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003199 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003200 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003201 status = mbedtls_to_psa_error(
3202 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003203 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003204 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003205 output_length,
3206 input,
3207 output,
3208 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003209 }
3210 else
John Durkop0e005192020-10-31 22:06:54 -07003211#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3212#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003213 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003215 status = mbedtls_to_psa_error(
3216 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3217 if( status != PSA_SUCCESS )
3218 goto rsa_exit;
3219
Steven Cooreman4fed4552020-08-03 14:46:03 +02003220 status = mbedtls_to_psa_error(
3221 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003222 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003223 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003224 salt, salt_length,
3225 output_length,
3226 input,
3227 output,
3228 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003229 }
3230 else
John Durkop0e005192020-10-31 22:06:54 -07003231#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003232 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003233 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003234 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003235
Steven Cooreman4fed4552020-08-03 14:46:03 +02003236rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003237 mbedtls_rsa_free( rsa );
3238 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003239 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003240 else
John Durkop6ba40d12020-11-10 08:50:04 -08003241#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3242 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003243 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003244 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003245 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003246
3247exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003248 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003249
Ronald Cron5c522922020-11-14 16:35:34 +01003250 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003251}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003252
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003253
3254
mohammad1603503973b2018-03-12 15:59:30 +02003255/****************************************************************/
3256/* Symmetric cryptography */
3257/****************************************************************/
3258
Ronald Cronab99ac22020-10-01 16:38:28 +02003259static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3260 mbedtls_svc_key_id_t key,
3261 psa_algorithm_t alg,
3262 mbedtls_operation_t cipher_operation )
3263{
3264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3265 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003266 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003267 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3268 PSA_KEY_USAGE_ENCRYPT :
3269 PSA_KEY_USAGE_DECRYPT );
3270
3271 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003272 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003273 {
Dave Rodgman54648242021-06-24 11:49:45 +01003274 status = PSA_ERROR_BAD_STATE;
3275 goto exit;
3276 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003277
Ronald Cronab99ac22020-10-01 16:38:28 +02003278 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003279 {
Dave Rodgman54648242021-06-24 11:49:45 +01003280 status = PSA_ERROR_INVALID_ARGUMENT;
3281 goto exit;
3282 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003283
Ronald Cronab99ac22020-10-01 16:38:28 +02003284 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3285 if( status != PSA_SUCCESS )
3286 goto exit;
3287
Ronald Cron49fafa92021-03-10 08:34:23 +01003288 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003289 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003290 * so we only set it (in the driver wrapper) after resources have been
3291 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003292 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003293 if( alg == PSA_ALG_ECB_NO_PADDING )
3294 operation->iv_required = 0;
3295 else
3296 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003297 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003298
Ronald Crona4af55f2020-12-14 14:36:06 +01003299 psa_key_attributes_t attributes = {
3300 .core = slot->attr
3301 };
3302
Ronald Cronab99ac22020-10-01 16:38:28 +02003303 /* Try doing the operation through a driver before using software fallback. */
3304 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003305 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3306 &attributes,
3307 slot->key.data,
3308 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003309 alg );
3310 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003311 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3312 &attributes,
3313 slot->key.data,
3314 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003315 alg );
3316
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003317exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003318 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003319 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003320
Ronald Cron5c522922020-11-14 16:35:34 +01003321 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003322
Ronald Cron5c522922020-11-14 16:35:34 +01003323 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003324}
3325
Gilles Peskinefe119512018-07-08 21:39:34 +02003326psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003327 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003328 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003329{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003330 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003331}
3332
Gilles Peskinefe119512018-07-08 21:39:34 +02003333psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003334 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003335 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003336{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003337 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003338}
3339
Gilles Peskinefe119512018-07-08 21:39:34 +02003340psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003341 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003342 size_t iv_size,
3343 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003344{
Ronald Cron6d051732020-10-01 14:10:20 +02003345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003346
Ronald Cron5618a392021-03-26 09:52:26 +01003347 *iv_length = 0;
3348
Ronald Cron49fafa92021-03-10 08:34:23 +01003349 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003350 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003351 status = PSA_ERROR_BAD_STATE;
3352 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003353 }
3354
Steven Cooreman7df02922020-09-09 15:28:49 +02003355 if( operation->iv_set || ! operation->iv_required )
3356 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003357 status = PSA_ERROR_BAD_STATE;
3358 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003359 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003360
Ronald Cron5618a392021-03-26 09:52:26 +01003361 if( iv_size < operation->default_iv_length )
3362 {
3363 status = PSA_ERROR_BUFFER_TOO_SMALL;
3364 goto exit;
3365 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003366
Ronald Cron5618a392021-03-26 09:52:26 +01003367 status = psa_generate_random( iv, operation->default_iv_length );
3368 if( status != PSA_SUCCESS )
3369 goto exit;
3370
3371 status = psa_driver_wrapper_cipher_set_iv( operation,
3372 iv,
3373 operation->default_iv_length );
3374
3375exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003376 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003377 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003378 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003379 *iv_length = operation->default_iv_length;
3380 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003381 else
Moran Peker395db872018-05-31 14:07:14 +03003382 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003383
itayzafrir534bd7c2018-08-02 13:56:32 +03003384 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003385}
3386
Gilles Peskinefe119512018-07-08 21:39:34 +02003387psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003388 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003389 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003390{
Ronald Cron6d051732020-10-01 14:10:20 +02003391 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003392
Ronald Cron49fafa92021-03-10 08:34:23 +01003393 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003394 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003395 status = PSA_ERROR_BAD_STATE;
3396 goto exit;
3397 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003398
Steven Cooreman7df02922020-09-09 15:28:49 +02003399 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003400 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003401 status = PSA_ERROR_BAD_STATE;
3402 goto exit;
3403 }
Ronald Crona0d68172021-03-26 10:15:08 +01003404
3405 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003406 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003407 status = PSA_ERROR_INVALID_ARGUMENT;
3408 goto exit;
3409 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003410
Ronald Crondd24c9b2020-12-15 14:10:01 +01003411 status = psa_driver_wrapper_cipher_set_iv( operation,
3412 iv,
3413 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003414
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003415exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003416 if( status == PSA_SUCCESS )
3417 operation->iv_set = 1;
3418 else
mohammad1603503973b2018-03-12 15:59:30 +02003419 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003420 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003421}
3422
Gilles Peskinee553c652018-06-04 16:22:46 +02003423psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3424 const uint8_t *input,
3425 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003426 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003427 size_t output_size,
3428 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003429{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003431
Ronald Cron49fafa92021-03-10 08:34:23 +01003432 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003433 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003434 status = PSA_ERROR_BAD_STATE;
3435 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003436 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003437
Steven Cooreman7df02922020-09-09 15:28:49 +02003438 if( operation->iv_required && ! operation->iv_set )
3439 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003440 status = PSA_ERROR_BAD_STATE;
3441 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003442 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003443
Ronald Crondd24c9b2020-12-15 14:10:01 +01003444 status = psa_driver_wrapper_cipher_update( operation,
3445 input,
3446 input_length,
3447 output,
3448 output_size,
3449 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003450
3451exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003452 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003453 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003454
itayzafrir534bd7c2018-08-02 13:56:32 +03003455 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003456}
3457
Gilles Peskinee553c652018-06-04 16:22:46 +02003458psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3459 uint8_t *output,
3460 size_t output_size,
3461 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003462{
David Saadab4ecc272019-02-14 13:48:10 +02003463 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003464
Ronald Cron49fafa92021-03-10 08:34:23 +01003465 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003466 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003467 status = PSA_ERROR_BAD_STATE;
3468 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003469 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003470
Steven Cooreman7df02922020-09-09 15:28:49 +02003471 if( operation->iv_required && ! operation->iv_set )
3472 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003473 status = PSA_ERROR_BAD_STATE;
3474 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003475 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003476
Ronald Crondd24c9b2020-12-15 14:10:01 +01003477 status = psa_driver_wrapper_cipher_finish( operation,
3478 output,
3479 output_size,
3480 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003481
3482exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003483 if( status == PSA_SUCCESS )
3484 return( psa_cipher_abort( operation ) );
3485 else
3486 {
3487 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003488 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003489
Steven Cooremanef8575e2020-09-11 11:44:50 +02003490 return( status );
3491 }
mohammad1603503973b2018-03-12 15:59:30 +02003492}
3493
Gilles Peskinee553c652018-06-04 16:22:46 +02003494psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3495{
Ronald Cron49fafa92021-03-10 08:34:23 +01003496 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003497 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003498 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003499 * in use. It's ok to call abort on such an object, and there's
3500 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003501 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003502 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003503
Ronald Crondd24c9b2020-12-15 14:10:01 +01003504 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003505
Ronald Cron49fafa92021-03-10 08:34:23 +01003506 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003507 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003508 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003509
Moran Peker395db872018-05-31 14:07:14 +03003510 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003511}
3512
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003513psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3514 psa_algorithm_t alg,
3515 const uint8_t *input,
3516 size_t input_length,
3517 uint8_t *output,
3518 size_t output_size,
3519 size_t *output_length )
3520{
3521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003522 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3523 psa_key_slot_t *slot;
3524 psa_key_type_t key_type;
3525 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003526
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003527 *output_length = 0;
3528
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003529 if( ! PSA_ALG_IS_CIPHER( alg ) )
3530 return( PSA_ERROR_INVALID_ARGUMENT );
3531
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003532 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3533 PSA_KEY_USAGE_ENCRYPT,
3534 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003535 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003536 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003537
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003538 psa_key_attributes_t attributes = {
3539 .core = slot->attr
3540 };
3541
3542 key_type = slot->attr.type;
3543 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3544
3545 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003546 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003547 if( output_size < iv_length )
3548 {
3549 status = PSA_ERROR_BUFFER_TOO_SMALL;
3550 goto exit;
3551 }
3552
3553 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003554 if( status != PSA_SUCCESS )
3555 goto exit;
3556 }
3557
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003558 status = psa_driver_wrapper_cipher_encrypt(
3559 &attributes, slot->key.data, slot->key.bytes,
3560 alg, input, input_length,
3561 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003562
3563exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003564 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003565
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003566 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003567}
3568
3569psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3570 psa_algorithm_t alg,
3571 const uint8_t *input,
3572 size_t input_length,
3573 uint8_t *output,
3574 size_t output_size,
3575 size_t *output_length )
3576{
3577 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003578 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3579 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003580
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003581 *output_length = 0;
3582
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003583 if( ! PSA_ALG_IS_CIPHER( alg ) )
3584 return( PSA_ERROR_INVALID_ARGUMENT );
3585
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003586 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3587 PSA_KEY_USAGE_DECRYPT,
3588 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003589 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003590 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003591
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003592 psa_key_attributes_t attributes = {
3593 .core = slot->attr
3594 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003595
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003596 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3597 {
3598 status = PSA_ERROR_INVALID_ARGUMENT;
3599 goto exit;
3600 }
3601
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003602 status = psa_driver_wrapper_cipher_decrypt(
3603 &attributes, slot->key.data, slot->key.bytes,
3604 alg, input, input_length,
3605 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003606
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003607exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003608 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003609
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003610 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003611}
3612
3613
mohammad16035955c982018-04-26 00:53:03 +03003614/****************************************************************/
3615/* AEAD */
3616/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003617
Ronald Croncf56a0a2020-08-04 09:51:30 +02003618psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003619 psa_algorithm_t alg,
3620 const uint8_t *nonce,
3621 size_t nonce_length,
3622 const uint8_t *additional_data,
3623 size_t additional_data_length,
3624 const uint8_t *plaintext,
3625 size_t plaintext_length,
3626 uint8_t *ciphertext,
3627 size_t ciphertext_size,
3628 size_t *ciphertext_length )
3629{
Ronald Cron215633c2021-03-16 17:15:37 +01003630 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3631 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003632
mohammad1603f08a5502018-06-03 15:05:47 +03003633 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003634
Steven Cooremanea7ab132021-03-17 16:28:00 +01003635 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3636 return( PSA_ERROR_NOT_SUPPORTED );
3637
Ronald Cron9a986162021-03-26 12:40:07 +01003638 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003639 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003640 if( status != PSA_SUCCESS )
3641 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003642
Ronald Cron215633c2021-03-16 17:15:37 +01003643 psa_key_attributes_t attributes = {
3644 .core = slot->attr
3645 };
mohammad16035955c982018-04-26 00:53:03 +03003646
Ronald Cronde822812021-03-17 16:08:20 +01003647 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003648 &attributes, slot->key.data, slot->key.bytes,
3649 alg,
3650 nonce, nonce_length,
3651 additional_data, additional_data_length,
3652 plaintext, plaintext_length,
3653 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003654
Gilles Peskineedf9a652018-08-17 18:11:56 +02003655 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3656 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003657
Ronald Cron9f310172021-03-16 16:36:37 +01003658 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003659
mohammad16035955c982018-04-26 00:53:03 +03003660 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003661}
3662
Ronald Croncf56a0a2020-08-04 09:51:30 +02003663psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003664 psa_algorithm_t alg,
3665 const uint8_t *nonce,
3666 size_t nonce_length,
3667 const uint8_t *additional_data,
3668 size_t additional_data_length,
3669 const uint8_t *ciphertext,
3670 size_t ciphertext_length,
3671 uint8_t *plaintext,
3672 size_t plaintext_size,
3673 size_t *plaintext_length )
3674{
Ronald Cron215633c2021-03-16 17:15:37 +01003675 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3676 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003677
Gilles Peskineee652a32018-06-01 19:23:52 +02003678 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003679
Steven Cooremanea7ab132021-03-17 16:28:00 +01003680 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3681 return( PSA_ERROR_NOT_SUPPORTED );
3682
Ronald Cron9a986162021-03-26 12:40:07 +01003683 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003684 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003685 if( status != PSA_SUCCESS )
3686 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003687
Ronald Cron215633c2021-03-16 17:15:37 +01003688 psa_key_attributes_t attributes = {
3689 .core = slot->attr
3690 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003691
Ronald Cronde822812021-03-17 16:08:20 +01003692 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003693 &attributes, slot->key.data, slot->key.bytes,
3694 alg,
3695 nonce, nonce_length,
3696 additional_data, additional_data_length,
3697 ciphertext, ciphertext_length,
3698 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003699
Gilles Peskineedf9a652018-08-17 18:11:56 +02003700 if( status != PSA_SUCCESS && plaintext_size != 0 )
3701 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003702
Ronald Cron215633c2021-03-16 17:15:37 +01003703 psa_unlock_key_slot( slot );
3704
Gilles Peskineedf9a652018-08-17 18:11:56 +02003705 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003706}
3707
Gilles Peskinee59236f2018-01-27 23:32:46 +01003708/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003709/* Generators */
3710/****************************************************************/
3711
John Durkop07cc04a2020-11-16 22:08:34 -08003712#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3713 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3714 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3715#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003716#endif /* At least one builtin KDF */
3717
3718#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3719 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3720 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3721static psa_status_t psa_key_derivation_start_hmac(
3722 psa_mac_operation_t *operation,
3723 psa_algorithm_t hash_alg,
3724 const uint8_t *hmac_key,
3725 size_t hmac_key_length )
3726{
3727 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3728 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3729 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3730 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3731 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3732
Steven Cooreman72f736a2021-05-07 14:14:37 +02003733 operation->is_sign = 1;
3734 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3735
Steven Cooreman094a77e2021-05-06 17:58:36 +02003736 status = psa_driver_wrapper_mac_sign_setup( operation,
3737 &attributes,
3738 hmac_key, hmac_key_length,
3739 PSA_ALG_HMAC( hash_alg ) );
3740
3741 psa_reset_key_attributes( &attributes );
3742 return( status );
3743}
3744#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003745
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003746#define HKDF_STATE_INIT 0 /* no input yet */
3747#define HKDF_STATE_STARTED 1 /* got salt */
3748#define HKDF_STATE_KEYED 2 /* got key */
3749#define HKDF_STATE_OUTPUT 3 /* output started */
3750
Gilles Peskinecbe66502019-05-16 16:59:18 +02003751static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003752 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003753{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003754 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3755 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003756 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003757 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003758}
3759
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003760psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003761{
3762 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003763 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003764 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003765 {
3766 /* The object has (apparently) been initialized but it is not
3767 * in use. It's ok to call abort on such an object, and there's
3768 * nothing to do. */
3769 }
3770 else
John Durkopd0321952020-10-29 21:37:36 -07003771#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003772 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003773 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003774 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003775 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003776 }
John Durkop07cc04a2020-11-16 22:08:34 -08003777 else
3778#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3779#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3780 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3781 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003782 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003783 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003784 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003785 if( operation->ctx.tls12_prf.secret != NULL )
3786 {
3787 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3788 operation->ctx.tls12_prf.secret_length );
3789 mbedtls_free( operation->ctx.tls12_prf.secret );
3790 }
3791
Janos Follath6a1d2622019-06-11 10:37:28 +01003792 if( operation->ctx.tls12_prf.seed != NULL )
3793 {
3794 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3795 operation->ctx.tls12_prf.seed_length );
3796 mbedtls_free( operation->ctx.tls12_prf.seed );
3797 }
3798
3799 if( operation->ctx.tls12_prf.label != NULL )
3800 {
3801 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3802 operation->ctx.tls12_prf.label_length );
3803 mbedtls_free( operation->ctx.tls12_prf.label );
3804 }
3805
Steven Cooremana6df6042021-04-29 19:32:25 +02003806 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003807
3808 /* We leave the fields Ai and output_block to be erased safely by the
3809 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003810 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003811 else
John Durkop07cc04a2020-11-16 22:08:34 -08003812#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3813 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003814 {
3815 status = PSA_ERROR_BAD_STATE;
3816 }
Janos Follath083036a2019-06-11 10:22:26 +01003817 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003818 return( status );
3819}
3820
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003821psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003822 size_t *capacity)
3823{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003824 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003825 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003826 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003827 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003828 }
3829
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003830 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003831 return( PSA_SUCCESS );
3832}
3833
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003834psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003835 size_t capacity )
3836{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003837 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003838 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003839 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003840 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003841 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003842 return( PSA_SUCCESS );
3843}
3844
John Durkopd0321952020-10-29 21:37:36 -07003845#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003846/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003847 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003848static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003849 psa_algorithm_t hash_alg,
3850 uint8_t *output,
3851 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003852{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003853 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003854 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003855 psa_status_t status;
3856
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003857 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3858 return( PSA_ERROR_BAD_STATE );
3859 hkdf->state = HKDF_STATE_OUTPUT;
3860
Gilles Peskinebef7f142018-07-12 17:22:21 +02003861 while( output_length != 0 )
3862 {
3863 /* Copy what remains of the current block */
3864 uint8_t n = hash_length - hkdf->offset_in_block;
3865 if( n > output_length )
3866 n = (uint8_t) output_length;
3867 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3868 output += n;
3869 output_length -= n;
3870 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003871 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003872 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003873 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003874 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003875 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003876 * object was corrupted or if this function is called directly
3877 * inside the library. */
3878 if( hkdf->block_number == 0xff )
3879 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003880
3881 /* We need a new block */
3882 ++hkdf->block_number;
3883 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003884
Steven Cooreman094a77e2021-05-06 17:58:36 +02003885 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3886 hash_alg,
3887 hkdf->prk,
3888 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003889 if( status != PSA_SUCCESS )
3890 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003891
Gilles Peskinebef7f142018-07-12 17:22:21 +02003892 if( hkdf->block_number != 1 )
3893 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003894 status = psa_mac_update( &hkdf->hmac,
3895 hkdf->output_block,
3896 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003897 if( status != PSA_SUCCESS )
3898 return( status );
3899 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003900 status = psa_mac_update( &hkdf->hmac,
3901 hkdf->info,
3902 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003903 if( status != PSA_SUCCESS )
3904 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003905 status = psa_mac_update( &hkdf->hmac,
3906 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003907 if( status != PSA_SUCCESS )
3908 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003909 status = psa_mac_sign_finish( &hkdf->hmac,
3910 hkdf->output_block,
3911 sizeof( hkdf->output_block ),
3912 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003913 if( status != PSA_SUCCESS )
3914 return( status );
3915 }
3916
3917 return( PSA_SUCCESS );
3918}
John Durkop07cc04a2020-11-16 22:08:34 -08003919#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003920
John Durkop07cc04a2020-11-16 22:08:34 -08003921#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3922 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003923static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3924 psa_tls12_prf_key_derivation_t *tls12_prf,
3925 psa_algorithm_t alg )
3926{
3927 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003928 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003929 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3930 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003931 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003932
Janos Follath7742fee2019-06-17 12:58:10 +01003933 /* We can't be wanting more output after block 0xff, otherwise
3934 * the capacity check in psa_key_derivation_output_bytes() would have
3935 * prevented this call. It could happen only if the operation
3936 * object was corrupted or if this function is called directly
3937 * inside the library. */
3938 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003939 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003940
3941 /* We need a new block */
3942 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003943 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003944
3945 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3946 *
3947 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3948 *
3949 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3950 * HMAC_hash(secret, A(2) + seed) +
3951 * HMAC_hash(secret, A(3) + seed) + ...
3952 *
3953 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003954 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003955 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003956 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003957 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003958 * is currently extracted as `output_block` and where i is
3959 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003960 */
3961
Steven Cooreman094a77e2021-05-06 17:58:36 +02003962 status = psa_key_derivation_start_hmac( &hmac,
3963 hash_alg,
3964 tls12_prf->secret,
3965 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003966 if( status != PSA_SUCCESS )
3967 goto cleanup;
3968
3969 /* Calculate A(i) where i = tls12_prf->block_number. */
3970 if( tls12_prf->block_number == 1 )
3971 {
3972 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3973 * the variable seed and in this instance means it in the context of the
3974 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003975 status = psa_mac_update( &hmac,
3976 tls12_prf->label,
3977 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003978 if( status != PSA_SUCCESS )
3979 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003980 status = psa_mac_update( &hmac,
3981 tls12_prf->seed,
3982 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003983 if( status != PSA_SUCCESS )
3984 goto cleanup;
3985 }
3986 else
3987 {
3988 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003989 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003990 if( status != PSA_SUCCESS )
3991 goto cleanup;
3992 }
3993
Steven Cooremana6df6042021-04-29 19:32:25 +02003994 status = psa_mac_sign_finish( &hmac,
3995 tls12_prf->Ai, hash_length,
3996 &hmac_output_length );
3997 if( hmac_output_length != hash_length )
3998 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003999 if( status != PSA_SUCCESS )
4000 goto cleanup;
4001
4002 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004003 status = psa_key_derivation_start_hmac( &hmac,
4004 hash_alg,
4005 tls12_prf->secret,
4006 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004007 if( status != PSA_SUCCESS )
4008 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004009 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004010 if( status != PSA_SUCCESS )
4011 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004012 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004013 if( status != PSA_SUCCESS )
4014 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004015 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004016 if( status != PSA_SUCCESS )
4017 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004018 status = psa_mac_sign_finish( &hmac,
4019 tls12_prf->output_block, hash_length,
4020 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004021 if( status != PSA_SUCCESS )
4022 goto cleanup;
4023
Janos Follath7742fee2019-06-17 12:58:10 +01004024
4025cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004026 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004027 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4028 status = cleanup_status;
4029
4030 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004031}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004032
Janos Follath844eb0e2019-06-19 12:10:49 +01004033static psa_status_t psa_key_derivation_tls12_prf_read(
4034 psa_tls12_prf_key_derivation_t *tls12_prf,
4035 psa_algorithm_t alg,
4036 uint8_t *output,
4037 size_t output_length )
4038{
4039 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004040 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004041 psa_status_t status;
4042 uint8_t offset, length;
4043
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004044 switch( tls12_prf->state )
4045 {
4046 case PSA_TLS12_PRF_STATE_LABEL_SET:
4047 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4048 break;
4049 case PSA_TLS12_PRF_STATE_OUTPUT:
4050 break;
4051 default:
4052 return( PSA_ERROR_BAD_STATE );
4053 }
4054
Janos Follath844eb0e2019-06-19 12:10:49 +01004055 while( output_length != 0 )
4056 {
4057 /* Check if we have fully processed the current block. */
4058 if( tls12_prf->left_in_block == 0 )
4059 {
4060 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4061 alg );
4062 if( status != PSA_SUCCESS )
4063 return( status );
4064
4065 continue;
4066 }
4067
4068 if( tls12_prf->left_in_block > output_length )
4069 length = (uint8_t) output_length;
4070 else
4071 length = tls12_prf->left_in_block;
4072
4073 offset = hash_length - tls12_prf->left_in_block;
4074 memcpy( output, tls12_prf->output_block + offset, length );
4075 output += length;
4076 output_length -= length;
4077 tls12_prf->left_in_block -= length;
4078 }
4079
4080 return( PSA_SUCCESS );
4081}
John Durkop07cc04a2020-11-16 22:08:34 -08004082#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4083 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004084
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004085psa_status_t psa_key_derivation_output_bytes(
4086 psa_key_derivation_operation_t *operation,
4087 uint8_t *output,
4088 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004089{
4090 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004091 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004092
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004093 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004094 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004095 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004096 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004097 }
4098
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004099 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004100 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004101 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004102 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004103 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004104 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004105 goto exit;
4106 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004107 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004108 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004109 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004110 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004111 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4112 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004113 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004114 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004115 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004116 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004117 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004118
John Durkopd0321952020-10-29 21:37:36 -07004119#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004120 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004121 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004122 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004123 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004124 output, output_length );
4125 }
Janos Follathadbec812019-06-14 11:05:39 +01004126 else
John Durkop07cc04a2020-11-16 22:08:34 -08004127#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4128#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4129 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004130 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004131 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004132 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004133 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004134 kdf_alg, output,
4135 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004136 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004137 else
John Durkop07cc04a2020-11-16 22:08:34 -08004138#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4139 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004140 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004141 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004142 return( PSA_ERROR_BAD_STATE );
4143 }
4144
4145exit:
4146 if( status != PSA_SUCCESS )
4147 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004148 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004149 * This allows us to differentiate between exhausted operations and
4150 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4151 * operations. */
4152 psa_algorithm_t alg = operation->alg;
4153 psa_key_derivation_abort( operation );
4154 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004155 memset( output, '!', output_length );
4156 }
4157 return( status );
4158}
4159
David Brown7807bf72021-02-09 16:28:23 -07004160#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004161static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4162{
4163 if( data_size >= 8 )
4164 mbedtls_des_key_set_parity( data );
4165 if( data_size >= 16 )
4166 mbedtls_des_key_set_parity( data + 8 );
4167 if( data_size >= 24 )
4168 mbedtls_des_key_set_parity( data + 16 );
4169}
David Brown7807bf72021-02-09 16:28:23 -07004170#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004171
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004172static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004173 psa_key_slot_t *slot,
4174 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004175 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004176{
4177 uint8_t *data = NULL;
4178 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304179 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004180 psa_status_t status;
4181
Gilles Peskine8e338702019-07-30 20:06:31 +02004182 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004183 return( PSA_ERROR_INVALID_ARGUMENT );
4184 if( bits % 8 != 0 )
4185 return( PSA_ERROR_INVALID_ARGUMENT );
4186 data = mbedtls_calloc( 1, bytes );
4187 if( data == NULL )
4188 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4189
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004190 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004191 if( status != PSA_SUCCESS )
4192 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004193#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004194 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004195 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004196#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004197
Ronald Cronbf33c932020-11-28 18:06:53 +01004198 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004199 psa_key_attributes_t attributes = {
4200 .core = slot->attr
4201 };
4202
Archanad8a83dc2021-06-14 10:04:16 +05304203 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4204 {
Archana449608b2021-09-08 15:36:05 +05304205 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4206 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304207 if( status != PSA_SUCCESS )
4208 goto exit;
4209 }
4210 status = psa_allocate_buffer_to_slot( slot, storage_size );
4211 if( status != PSA_SUCCESS )
4212 goto exit;
4213
Ronald Cronbf33c932020-11-28 18:06:53 +01004214 status = psa_driver_wrapper_import_key( &attributes,
4215 data, bytes,
4216 slot->key.data,
4217 slot->key.bytes,
4218 &slot->key.bytes, &bits );
4219 if( bits != slot->attr.bits )
4220 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004221
4222exit:
4223 mbedtls_free( data );
4224 return( status );
4225}
4226
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004227psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004228 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004229 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004230{
4231 psa_status_t status;
4232 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004233 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004234
Ronald Cron81709fc2020-11-14 12:10:32 +01004235 *key = MBEDTLS_SVC_KEY_ID_INIT;
4236
Gilles Peskine0f84d622019-09-12 19:03:13 +02004237 /* Reject any attempt to create a zero-length key so that we don't
4238 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4239 if( psa_get_key_bits( attributes ) == 0 )
4240 return( PSA_ERROR_INVALID_ARGUMENT );
4241
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004242 if( ! operation->can_output_key )
4243 return( PSA_ERROR_NOT_PERMITTED );
4244
Ronald Cron81709fc2020-11-14 12:10:32 +01004245 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4246 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004247#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4248 if( driver != NULL )
4249 {
4250 /* Deriving a key in a secure element is not implemented yet. */
4251 status = PSA_ERROR_NOT_SUPPORTED;
4252 }
4253#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004254 if( status == PSA_SUCCESS )
4255 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004256 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004257 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004258 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004259 }
4260 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004261 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004262 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004263 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004264
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004265 return( status );
4266}
4267
Gilles Peskineeab56e42018-07-12 17:12:33 +02004268
4269
4270/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004271/* Key derivation */
4272/****************************************************************/
4273
Steven Cooreman932ffb72021-02-15 12:14:32 +01004274#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004275static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004276 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004277 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004278{
John Durkop07cc04a2020-11-16 22:08:34 -08004279 int is_kdf_alg_supported;
4280
Janos Follath5fe19732019-06-20 15:09:30 +01004281 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4282 * initialisers for this union leave some bytes unspecified.) */
4283 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4284
Gilles Peskine969c5d62019-01-16 15:53:06 +01004285 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004286#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004287 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4288 is_kdf_alg_supported = 1;
4289 else
4290#endif
4291#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4292 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4293 is_kdf_alg_supported = 1;
4294 else
4295#endif
4296#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4297 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4298 is_kdf_alg_supported = 1;
4299 else
4300#endif
4301 is_kdf_alg_supported = 0;
4302
4303 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004304 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004305 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004306 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004307 if( hash_size == 0 )
4308 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004309 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4310 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004311 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004312 {
4313 return( PSA_ERROR_NOT_SUPPORTED );
4314 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004315 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004316 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004317 }
John Durkop07cc04a2020-11-16 22:08:34 -08004318
4319 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004320}
John Durkop07cc04a2020-11-16 22:08:34 -08004321#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004322
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004323psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004324 psa_algorithm_t alg )
4325{
4326 psa_status_t status;
4327
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004328 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004329 return( PSA_ERROR_BAD_STATE );
4330
Gilles Peskine6843c292019-01-18 16:44:49 +01004331 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4332 return( PSA_ERROR_INVALID_ARGUMENT );
4333 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004334 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004335#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004336 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004337 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004338#else
4339 return( PSA_ERROR_NOT_SUPPORTED );
4340#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004341 }
4342 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4343 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004344#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004345 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004346#else
4347 return( PSA_ERROR_NOT_SUPPORTED );
4348#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004349 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004350 else
4351 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004352
4353 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004354 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004355 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004356}
4357
John Durkopd0321952020-10-29 21:37:36 -07004358#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004359static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004360 psa_algorithm_t hash_alg,
4361 psa_key_derivation_step_t step,
4362 const uint8_t *data,
4363 size_t data_length )
4364{
4365 psa_status_t status;
4366 switch( step )
4367 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004368 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004369 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004370 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004371 else
4372 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004373 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4374 hash_alg,
4375 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004376 if( status != PSA_SUCCESS )
4377 return( status );
4378 hkdf->state = HKDF_STATE_STARTED;
4379 return( PSA_SUCCESS );
4380 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004381 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004382 /* If no salt was provided, use an empty salt. */
4383 if( hkdf->state == HKDF_STATE_INIT )
4384 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004385 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4386 hash_alg,
4387 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004388 if( status != PSA_SUCCESS )
4389 return( status );
4390 hkdf->state = HKDF_STATE_STARTED;
4391 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004392 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004393 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004394 status = psa_mac_update( &hkdf->hmac,
4395 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004396 if( status != PSA_SUCCESS )
4397 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004398 status = psa_mac_sign_finish( &hkdf->hmac,
4399 hkdf->prk,
4400 sizeof( hkdf->prk ),
4401 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004402 if( status != PSA_SUCCESS )
4403 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004404 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004405 hkdf->block_number = 0;
4406 hkdf->state = HKDF_STATE_KEYED;
4407 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004408 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004409 if( hkdf->state == HKDF_STATE_OUTPUT )
4410 return( PSA_ERROR_BAD_STATE );
4411 if( hkdf->info_set )
4412 return( PSA_ERROR_BAD_STATE );
4413 hkdf->info_length = data_length;
4414 if( data_length != 0 )
4415 {
4416 hkdf->info = mbedtls_calloc( 1, data_length );
4417 if( hkdf->info == NULL )
4418 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4419 memcpy( hkdf->info, data, data_length );
4420 }
4421 hkdf->info_set = 1;
4422 return( PSA_SUCCESS );
4423 default:
4424 return( PSA_ERROR_INVALID_ARGUMENT );
4425 }
4426}
John Durkop07cc04a2020-11-16 22:08:34 -08004427#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004428
John Durkop07cc04a2020-11-16 22:08:34 -08004429#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4430 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004431static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4432 const uint8_t *data,
4433 size_t data_length )
4434{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004435 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004436 return( PSA_ERROR_BAD_STATE );
4437
Janos Follathd6dce9f2019-07-04 09:11:38 +01004438 if( data_length != 0 )
4439 {
4440 prf->seed = mbedtls_calloc( 1, data_length );
4441 if( prf->seed == NULL )
4442 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004443
Janos Follathd6dce9f2019-07-04 09:11:38 +01004444 memcpy( prf->seed, data, data_length );
4445 prf->seed_length = data_length;
4446 }
Janos Follathf08e2652019-06-13 09:05:41 +01004447
Gilles Peskine43f958b2020-12-13 14:55:14 +01004448 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004449
4450 return( PSA_SUCCESS );
4451}
4452
Janos Follath81550542019-06-13 14:26:34 +01004453static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004454 const uint8_t *data,
4455 size_t data_length )
4456{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004457 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004458 return( PSA_ERROR_BAD_STATE );
4459
Steven Cooremana6df6042021-04-29 19:32:25 +02004460 if( data_length != 0 )
4461 {
4462 prf->secret = mbedtls_calloc( 1, data_length );
4463 if( prf->secret == NULL )
4464 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4465
4466 memcpy( prf->secret, data, data_length );
4467 prf->secret_length = data_length;
4468 }
Janos Follath81550542019-06-13 14:26:34 +01004469
Gilles Peskine43f958b2020-12-13 14:55:14 +01004470 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004471
4472 return( PSA_SUCCESS );
4473}
4474
Janos Follath63028dd2019-06-13 09:15:47 +01004475static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4476 const uint8_t *data,
4477 size_t data_length )
4478{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004479 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004480 return( PSA_ERROR_BAD_STATE );
4481
Janos Follathd6dce9f2019-07-04 09:11:38 +01004482 if( data_length != 0 )
4483 {
4484 prf->label = mbedtls_calloc( 1, data_length );
4485 if( prf->label == NULL )
4486 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004487
Janos Follathd6dce9f2019-07-04 09:11:38 +01004488 memcpy( prf->label, data, data_length );
4489 prf->label_length = data_length;
4490 }
Janos Follath63028dd2019-06-13 09:15:47 +01004491
Gilles Peskine43f958b2020-12-13 14:55:14 +01004492 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004493
4494 return( PSA_SUCCESS );
4495}
4496
Janos Follathb03233e2019-06-11 15:30:30 +01004497static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004498 psa_key_derivation_step_t step,
4499 const uint8_t *data,
4500 size_t data_length )
4501{
Janos Follathb03233e2019-06-11 15:30:30 +01004502 switch( step )
4503 {
Janos Follathf08e2652019-06-13 09:05:41 +01004504 case PSA_KEY_DERIVATION_INPUT_SEED:
4505 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004506 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004507 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004508 case PSA_KEY_DERIVATION_INPUT_LABEL:
4509 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004510 default:
4511 return( PSA_ERROR_INVALID_ARGUMENT );
4512 }
4513}
John Durkop07cc04a2020-11-16 22:08:34 -08004514#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4515 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4516
4517#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4518static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4519 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004520 const uint8_t *data,
4521 size_t data_length )
4522{
4523 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004524 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004525 uint8_t *cur = pms;
4526
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004527 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004528 return( PSA_ERROR_INVALID_ARGUMENT );
4529
4530 /* Quoting RFC 4279, Section 2:
4531 *
4532 * The premaster secret is formed as follows: if the PSK is N octets
4533 * long, concatenate a uint16 with the value N, N zero octets, a second
4534 * uint16 with the value N, and the PSK itself.
4535 */
4536
Joe Subbiani5ecac212021-06-24 13:00:03 +01004537 *cur++ = MBEDTLS_BYTE_1( data_length );
4538 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004539 memset( cur, 0, data_length );
4540 cur += data_length;
4541 *cur++ = pms[0];
4542 *cur++ = pms[1];
4543 memcpy( cur, data, data_length );
4544 cur += data_length;
4545
Steven Cooremana6df6042021-04-29 19:32:25 +02004546 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004547
4548 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4549 return( status );
4550}
Janos Follath6660f0e2019-06-17 08:44:03 +01004551
4552static psa_status_t psa_tls12_prf_psk_to_ms_input(
4553 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004554 psa_key_derivation_step_t step,
4555 const uint8_t *data,
4556 size_t data_length )
4557{
4558 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004559 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004560 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004561 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004562 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004563
Steven Cooremana6df6042021-04-29 19:32:25 +02004564 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004565}
John Durkop07cc04a2020-11-16 22:08:34 -08004566#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004567
Gilles Peskineb8965192019-09-24 16:21:10 +02004568/** Check whether the given key type is acceptable for the given
4569 * input step of a key derivation.
4570 *
4571 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4572 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4573 * Both secret and non-secret inputs can alternatively have the type
4574 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4575 * that the input was passed as a buffer rather than via a key object.
4576 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004577static int psa_key_derivation_check_input_type(
4578 psa_key_derivation_step_t step,
4579 psa_key_type_t key_type )
4580{
4581 switch( step )
4582 {
4583 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004584 if( key_type == PSA_KEY_TYPE_DERIVE )
4585 return( PSA_SUCCESS );
4586 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004587 return( PSA_SUCCESS );
4588 break;
4589 case PSA_KEY_DERIVATION_INPUT_LABEL:
4590 case PSA_KEY_DERIVATION_INPUT_SALT:
4591 case PSA_KEY_DERIVATION_INPUT_INFO:
4592 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004593 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4594 return( PSA_SUCCESS );
4595 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004596 return( PSA_SUCCESS );
4597 break;
4598 }
4599 return( PSA_ERROR_INVALID_ARGUMENT );
4600}
4601
Janos Follathb80a94e2019-06-12 15:54:46 +01004602static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004603 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004604 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004605 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004606 const uint8_t *data,
4607 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004608{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004609 psa_status_t status;
4610 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4611
4612 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004613 if( status != PSA_SUCCESS )
4614 goto exit;
4615
John Durkopd0321952020-10-29 21:37:36 -07004616#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004617 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004618 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004619 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004620 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004621 step, data, data_length );
4622 }
John Durkop07cc04a2020-11-16 22:08:34 -08004623 else
4624#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4625#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4626 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004627 {
Janos Follathb03233e2019-06-11 15:30:30 +01004628 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004629 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004630 }
John Durkop07cc04a2020-11-16 22:08:34 -08004631 else
4632#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4633#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4634 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004635 {
4636 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004637 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004638 }
4639 else
John Durkop07cc04a2020-11-16 22:08:34 -08004640#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004641 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004642 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004643 (void) data;
4644 (void) data_length;
4645 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004646 return( PSA_ERROR_BAD_STATE );
4647 }
4648
Gilles Peskine224b0d62019-09-23 18:13:17 +02004649exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004650 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004651 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004652 return( status );
4653}
4654
Janos Follath51f4a0f2019-06-14 11:35:55 +01004655psa_status_t psa_key_derivation_input_bytes(
4656 psa_key_derivation_operation_t *operation,
4657 psa_key_derivation_step_t step,
4658 const uint8_t *data,
4659 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004660{
Gilles Peskineb8965192019-09-24 16:21:10 +02004661 return( psa_key_derivation_input_internal( operation, step,
4662 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004663 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004664}
4665
Janos Follath51f4a0f2019-06-14 11:35:55 +01004666psa_status_t psa_key_derivation_input_key(
4667 psa_key_derivation_operation_t *operation,
4668 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004669 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004670{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004672 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004673 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004674
Ronald Cron5c522922020-11-14 16:35:34 +01004675 status = psa_get_and_lock_transparent_key_slot_with_policy(
4676 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004677 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004678 {
4679 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004680 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004681 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004682
4683 /* Passing a key object as a SECRET input unlocks the permission
4684 * to output to a key object. */
4685 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4686 operation->can_output_key = 1;
4687
Ronald Cronf95a2b12020-10-22 15:24:49 +02004688 status = psa_key_derivation_input_internal( operation,
4689 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004690 slot->key.data,
4691 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004692
Ronald Cron5c522922020-11-14 16:35:34 +01004693 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004694
Ronald Cron5c522922020-11-14 16:35:34 +01004695 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004696}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004697
4698
4699
4700/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004701/* Key agreement */
4702/****************************************************************/
4703
John Durkop6ba40d12020-11-10 08:50:04 -08004704#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004705static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4706 size_t peer_key_length,
4707 const mbedtls_ecp_keypair *our_key,
4708 uint8_t *shared_secret,
4709 size_t shared_secret_size,
4710 size_t *shared_secret_length )
4711{
Steven Cooremand4867872020-08-05 16:31:39 +02004712 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004713 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004714 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004715 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004716 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004717 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004718
Ronald Cron90857082020-11-25 14:58:33 +01004719 status = mbedtls_psa_ecp_load_representation(
4720 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004721 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004722 peer_key,
4723 peer_key_length,
4724 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004725 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004726 goto exit;
4727
Jaeden Amero97271b32019-01-10 19:38:51 +00004728 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004729 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004730 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004731 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004732 status = mbedtls_to_psa_error(
4733 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4734 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004735 goto exit;
4736
Jaeden Amero97271b32019-01-10 19:38:51 +00004737 status = mbedtls_to_psa_error(
4738 mbedtls_ecdh_calc_secret( &ecdh,
4739 shared_secret_length,
4740 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004741 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004742 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004743 if( status != PSA_SUCCESS )
4744 goto exit;
4745 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4746 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004747
4748exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004749 if( status != PSA_SUCCESS )
4750 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004751 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004752 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004753 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004754
Jaeden Amero97271b32019-01-10 19:38:51 +00004755 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004756}
John Durkop6ba40d12020-11-10 08:50:04 -08004757#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004758
Gilles Peskine01d718c2018-09-18 12:01:02 +02004759#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4760
Gilles Peskine0216fe12019-04-11 21:23:21 +02004761static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4762 psa_key_slot_t *private_key,
4763 const uint8_t *peer_key,
4764 size_t peer_key_length,
4765 uint8_t *shared_secret,
4766 size_t shared_secret_size,
4767 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004768{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004769 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004770 {
John Durkop6ba40d12020-11-10 08:50:04 -08004771#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004772 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004773 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004774 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004775 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004776 psa_status_t status = mbedtls_psa_ecp_load_representation(
4777 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004778 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004779 private_key->key.data,
4780 private_key->key.bytes,
4781 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004782 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004783 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004784 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004785 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004786 shared_secret, shared_secret_size,
4787 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004788 mbedtls_ecp_keypair_free( ecp );
4789 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004790 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004791#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004792 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004793 (void) private_key;
4794 (void) peer_key;
4795 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004796 (void) shared_secret;
4797 (void) shared_secret_size;
4798 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004799 return( PSA_ERROR_NOT_SUPPORTED );
4800 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004801}
4802
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004803/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004804 * to potentially free embedded data structures and wipe confidential data.
4805 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004806static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004807 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004808 psa_key_slot_t *private_key,
4809 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004810 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004811{
4812 psa_status_t status;
4813 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4814 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004815 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004816
4817 /* Step 1: run the secret agreement algorithm to generate the shared
4818 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004819 status = psa_key_agreement_raw_internal( ka_alg,
4820 private_key,
4821 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004822 shared_secret,
4823 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004824 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004825 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004826 goto exit;
4827
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004828 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004829 * the shared secret. A shared secret is permitted wherever a key
4830 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004831 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004832 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004833 shared_secret,
4834 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004835exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004836 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004837 return( status );
4838}
4839
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004840psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004841 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004842 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004843 const uint8_t *peer_key,
4844 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004845{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004847 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004848 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004849
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004850 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004851 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004852 status = psa_get_and_lock_transparent_key_slot_with_policy(
4853 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004854 if( status != PSA_SUCCESS )
4855 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004856 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004857 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004858 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004859 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004860 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004861 else
4862 {
4863 /* If a private key has been added as SECRET, we allow the derived
4864 * key material to be used as a key in PSA Crypto. */
4865 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4866 operation->can_output_key = 1;
4867 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004868
Ronald Cron5c522922020-11-14 16:35:34 +01004869 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004870
Ronald Cron5c522922020-11-14 16:35:34 +01004871 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004872}
4873
Gilles Peskinebe697d82019-05-16 18:00:41 +02004874psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004875 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004876 const uint8_t *peer_key,
4877 size_t peer_key_length,
4878 uint8_t *output,
4879 size_t output_size,
4880 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004881{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004883 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004884 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004885
4886 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4887 {
4888 status = PSA_ERROR_INVALID_ARGUMENT;
4889 goto exit;
4890 }
Ronald Cron5c522922020-11-14 16:35:34 +01004891 status = psa_get_and_lock_transparent_key_slot_with_policy(
4892 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004893 if( status != PSA_SUCCESS )
4894 goto exit;
4895
4896 status = psa_key_agreement_raw_internal( alg, slot,
4897 peer_key, peer_key_length,
4898 output, output_size,
4899 output_length );
4900
4901exit:
4902 if( status != PSA_SUCCESS )
4903 {
4904 /* If an error happens and is not handled properly, the output
4905 * may be used as a key to protect sensitive data. Arrange for such
4906 * a key to be random, which is likely to result in decryption or
4907 * verification errors. This is better than filling the buffer with
4908 * some constant data such as zeros, which would result in the data
4909 * being protected with a reproducible, easily knowable key.
4910 */
4911 psa_generate_random( output, output_size );
4912 *output_length = output_size;
4913 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004914
Ronald Cron5c522922020-11-14 16:35:34 +01004915 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004916
Ronald Cron5c522922020-11-14 16:35:34 +01004917 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004918}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004919
4920
Gilles Peskine30524eb2020-11-13 17:02:26 +01004921
Gilles Peskine86a440b2018-11-12 18:39:40 +01004922/****************************************************************/
4923/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004924/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004925
Gilles Peskine30524eb2020-11-13 17:02:26 +01004926/** Initialize the PSA random generator.
4927 */
4928static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4929{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004930#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4931 memset( rng, 0, sizeof( *rng ) );
4932#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4933
Gilles Peskine30524eb2020-11-13 17:02:26 +01004934 /* Set default configuration if
4935 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4936 if( rng->entropy_init == NULL )
4937 rng->entropy_init = mbedtls_entropy_init;
4938 if( rng->entropy_free == NULL )
4939 rng->entropy_free = mbedtls_entropy_free;
4940
4941 rng->entropy_init( &rng->entropy );
4942#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4943 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4944 /* The PSA entropy injection feature depends on using NV seed as an entropy
4945 * source. Add NV seed as an entropy source for PSA entropy injection. */
4946 mbedtls_entropy_add_source( &rng->entropy,
4947 mbedtls_nv_seed_poll, NULL,
4948 MBEDTLS_ENTROPY_BLOCK_SIZE,
4949 MBEDTLS_ENTROPY_SOURCE_STRONG );
4950#endif
4951
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004952 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004953#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004954}
4955
4956/** Deinitialize the PSA random generator.
4957 */
4958static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4959{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004960#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4961 memset( rng, 0, sizeof( *rng ) );
4962#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004963 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004964 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004965#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004966}
4967
4968/** Seed the PSA random generator.
4969 */
4970static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4971{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004972#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4973 /* Do nothing: the external RNG seeds itself. */
4974 (void) rng;
4975 return( PSA_SUCCESS );
4976#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004977 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004978 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4979 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004980 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004981#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004982}
4983
Gilles Peskinee59236f2018-01-27 23:32:46 +01004984psa_status_t psa_generate_random( uint8_t *output,
4985 size_t output_size )
4986{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004987 GUARD_MODULE_INITIALIZED;
4988
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004989#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4990
4991 size_t output_length = 0;
4992 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4993 output, output_size,
4994 &output_length );
4995 if( status != PSA_SUCCESS )
4996 return( status );
4997 /* Breaking up a request into smaller chunks is currently not supported
4998 * for the extrernal RNG interface. */
4999 if( output_length != output_size )
5000 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5001 return( PSA_SUCCESS );
5002
5003#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5004
Gilles Peskine71ddab92021-01-04 21:01:07 +01005005 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005006 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005007 size_t request_size =
5008 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5009 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5010 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005011 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5012 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005013 if( ret != 0 )
5014 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005015 output_size -= request_size;
5016 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005017 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005018 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005019#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005020}
5021
Gilles Peskine8814fc42020-12-14 15:33:44 +01005022/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005023 *
5024 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5025 * `psa_generate_random(...)`. The state parameter is ignored since the
5026 * PSA API doesn't support passing an explicit state.
5027 *
5028 * In the non-external case, psa_generate_random() calls an
5029 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5030 * and semantics as mbedtls_psa_get_random(). As an optimization,
5031 * instead of doing this back-and-forth between the PSA API and the
5032 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5033 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005034 */
5035#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5036int mbedtls_psa_get_random( void *p_rng,
5037 unsigned char *output,
5038 size_t output_size )
5039{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005040 /* This function takes a pointer to the RNG state because that's what
5041 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5042 * its own state internally and doesn't let the caller access that state.
5043 * So we just ignore the state parameter, and in practice we'll pass
5044 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005045 (void) p_rng;
5046 psa_status_t status = psa_generate_random( output, output_size );
5047 if( status == PSA_SUCCESS )
5048 return( 0 );
5049 else
5050 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5051}
5052#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5053
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005054#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005055#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005056
Gilles Peskine7228da22019-07-15 11:06:15 +02005057psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005058 size_t seed_size )
5059{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005060 if( global_data.initialized )
5061 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005062
5063 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5064 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5065 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5066 return( PSA_ERROR_INVALID_ARGUMENT );
5067
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005068 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005069}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005070#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005071
Ronald Cron3772afe2021-02-08 16:10:05 +01005072/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005073 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005074 * \param type The key type
5075 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005076 *
5077 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005078 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005079 * \retval #PSA_ERROR_INVALID_ARGUMENT
5080 * The size in bits of the key is not valid.
5081 * \retval #PSA_ERROR_NOT_SUPPORTED
5082 * The type and/or the size in bits of the key or the combination of
5083 * the two is not supported.
5084 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005085static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5086 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005087{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005088 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005089
Gilles Peskinee59236f2018-01-27 23:32:46 +01005090 if( key_type_is_raw_bytes( type ) )
5091 {
Archana4d7ae1d2021-07-07 02:50:22 +05305092 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005093 if( status != PSA_SUCCESS )
5094 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005095 }
5096 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005097#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005098 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5099 {
5100 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5101 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005102
Ronald Cron01b2aba2020-10-05 09:42:02 +02005103 /* Accept only byte-aligned keys, for the same reasons as
5104 * in psa_import_rsa_key(). */
5105 if( bits % 8 != 0 )
5106 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005107 }
5108 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005109#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005110
Ronald Cron5c4d3862020-12-07 11:07:24 +01005111#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005112 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5113 {
Ronald Crond81ab562021-02-16 09:01:16 +01005114 /* To avoid empty block, return successfully here. */
5115 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005116 }
5117 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005118#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005119 {
5120 return( PSA_ERROR_NOT_SUPPORTED );
5121 }
5122
5123 return( PSA_SUCCESS );
5124}
5125
Ronald Cron55ed0592020-10-05 10:30:40 +02005126psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005127 const psa_key_attributes_t *attributes,
5128 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005129{
5130 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005131 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005132
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005133 if( ( attributes->domain_parameters == NULL ) &&
5134 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005135 return( PSA_ERROR_INVALID_ARGUMENT );
5136
Ronald Cron01b2aba2020-10-05 09:42:02 +02005137 if( key_type_is_raw_bytes( type ) )
5138 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005139 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005140 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005141 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005142
David Brown12ca5032021-02-11 11:02:00 -07005143#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005144 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005145 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005146#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005147 }
5148 else
5149
Jaeden Amero424fa932021-05-14 08:34:32 +01005150#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5151 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005152 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005153 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005154 return( mbedtls_psa_rsa_generate_key( attributes,
5155 key_buffer,
5156 key_buffer_size,
5157 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005158 }
5159 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005160#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5161 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005162
John Durkop9814fa22020-11-04 12:28:15 -08005163#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005164 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005165 {
Ronald Cron7023db52020-11-20 18:17:42 +01005166 return( mbedtls_psa_ecp_generate_key( attributes,
5167 key_buffer,
5168 key_buffer_size,
5169 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005170 }
5171 else
John Durkop9814fa22020-11-04 12:28:15 -08005172#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005173 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005174 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005175 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005176 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005177
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005178 return( PSA_SUCCESS );
5179}
Darryl Green0c6575a2018-11-07 16:05:30 +00005180
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005181psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005182 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005183{
5184 psa_status_t status;
5185 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005186 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005187 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005188
Ronald Cron81709fc2020-11-14 12:10:32 +01005189 *key = MBEDTLS_SVC_KEY_ID_INIT;
5190
Gilles Peskine0f84d622019-09-12 19:03:13 +02005191 /* Reject any attempt to create a zero-length key so that we don't
5192 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5193 if( psa_get_key_bits( attributes ) == 0 )
5194 return( PSA_ERROR_INVALID_ARGUMENT );
5195
Ronald Cron81709fc2020-11-14 12:10:32 +01005196 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5197 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005198 if( status != PSA_SUCCESS )
5199 goto exit;
5200
Ronald Cron977c2472020-10-13 08:32:21 +02005201 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305202 * storage ( thus not in the case of generating a key in a secure element
5203 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5204 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005205 if( slot->key.data == NULL )
5206 {
5207 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5208 PSA_KEY_LOCATION_LOCAL_STORAGE )
5209 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005210 status = psa_validate_key_type_and_size_for_key_generation(
5211 attributes->core.type, attributes->core.bits );
5212 if( status != PSA_SUCCESS )
5213 goto exit;
5214
5215 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5216 attributes->core.type,
5217 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005218 }
5219 else
5220 {
5221 status = psa_driver_wrapper_get_key_buffer_size(
5222 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005223 if( status != PSA_SUCCESS )
5224 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005225 }
Ronald Cron977c2472020-10-13 08:32:21 +02005226
5227 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5228 if( status != PSA_SUCCESS )
5229 goto exit;
5230 }
5231
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005232 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005233 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005234
Ronald Cron2b56bc82020-10-05 10:02:26 +02005235 if( status != PSA_SUCCESS )
5236 psa_remove_key_data_from_memory( slot );
5237
Gilles Peskine11792082019-08-06 18:36:36 +02005238exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005239 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005240 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005241 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005242 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005243
Darryl Green0c6575a2018-11-07 16:05:30 +00005244 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005245}
5246
Gilles Peskinee59236f2018-01-27 23:32:46 +01005247/****************************************************************/
5248/* Module setup */
5249/****************************************************************/
5250
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005251#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005252psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5253 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5254 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5255{
5256 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5257 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005258 global_data.rng.entropy_init = entropy_init;
5259 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005260 return( PSA_SUCCESS );
5261}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005262#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005263
Gilles Peskinee59236f2018-01-27 23:32:46 +01005264void mbedtls_psa_crypto_free( void )
5265{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005266 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005267 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5268 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005269 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005270 }
5271 /* Wipe all remaining data, including configuration.
5272 * In particular, this sets all state indicator to the value
5273 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005274 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005275#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005276 /* Unregister all secure element drivers, so that we restart from
5277 * a pristine state. */
5278 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005279#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005280}
5281
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005282#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5283/** Recover a transaction that was interrupted by a power failure.
5284 *
5285 * This function is called during initialization, before psa_crypto_init()
5286 * returns. If this function returns a failure status, the initialization
5287 * fails.
5288 */
5289static psa_status_t psa_crypto_recover_transaction(
5290 const psa_crypto_transaction_t *transaction )
5291{
5292 switch( transaction->unknown.type )
5293 {
5294 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5295 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005296 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005297 * is implemented.
5298 * https://github.com/ARMmbed/mbed-crypto/issues/218
5299 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005300 default:
5301 /* We found an unsupported transaction in the storage.
5302 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005303 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005304 }
5305}
5306#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5307
Gilles Peskinee59236f2018-01-27 23:32:46 +01005308psa_status_t psa_crypto_init( void )
5309{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005310 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005311
Gilles Peskinec6b69072018-11-20 21:42:52 +01005312 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005313 if( global_data.initialized != 0 )
5314 return( PSA_SUCCESS );
5315
Gilles Peskine30524eb2020-11-13 17:02:26 +01005316 /* Initialize and seed the random generator. */
5317 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005318 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005319 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005320 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005321 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005322 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005323
Gilles Peskine66fb1262018-12-10 16:29:04 +01005324 status = psa_initialize_key_slots( );
5325 if( status != PSA_SUCCESS )
5326 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005327
Gilles Peskined9348f22019-10-01 15:22:29 +02005328#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5329 status = psa_init_all_se_drivers( );
5330 if( status != PSA_SUCCESS )
5331 goto exit;
5332#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5333
Gilles Peskine4b734222019-07-24 15:56:31 +02005334#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005335 status = psa_crypto_load_transaction( );
5336 if( status == PSA_SUCCESS )
5337 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005338 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5339 if( status != PSA_SUCCESS )
5340 goto exit;
5341 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005342 }
5343 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5344 {
5345 /* There's no transaction to complete. It's all good. */
5346 status = PSA_SUCCESS;
5347 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005348#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005349
Gilles Peskinec6b69072018-11-20 21:42:52 +01005350 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005351 global_data.initialized = 1;
5352
5353exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005354 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005355 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005356 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005357}
5358
5359#endif /* MBEDTLS_PSA_CRYPTO_C */