blob: 845fc74bb1012a0fca1b45e016ec3b5128fd9218 [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 Cooreman32d56942021-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 Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020061#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000062#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020063#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/blowfish.h"
65#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020066#include "mbedtls/chacha20.h"
67#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/cipher.h"
69#include "mbedtls/ccm.h"
70#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020072#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010073#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010074#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/error.h"
76#include "mbedtls/gcm.h"
77#include "mbedtls/md2.h"
78#include "mbedtls/md4.h"
79#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010080#include "mbedtls/md.h"
81#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010082#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010084#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000085#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010086#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010087#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010088#include "mbedtls/sha1.h"
89#include "mbedtls/sha256.h"
90#include "mbedtls/sha512.h"
91#include "mbedtls/xtea.h"
92
Gilles Peskine996deb12018-08-01 15:45:45 +020093#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
94
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010095/****************************************************************/
96/* Global data, support functions and library management */
97/****************************************************************/
98
Gilles Peskine48c0ea12018-06-21 14:15:31 +020099static int key_type_is_raw_bytes( psa_key_type_t type )
100{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200101 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102}
103
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100104/* Values for psa_global_data_t::rng_state */
105#define RNG_NOT_INITIALIZED 0
106#define RNG_INITIALIZED 1
107#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100108
Gilles Peskine2d277862018-06-18 15:41:12 +0200109typedef struct
110{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100111 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100112 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100113 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100114} psa_global_data_t;
115
116static psa_global_data_t global_data;
117
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100118#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
119mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
120 &global_data.rng.drbg;
121#endif
122
itayzafrir0adf0fc2018-09-06 16:24:41 +0300123#define GUARD_MODULE_INITIALIZED \
124 if( global_data.initialized == 0 ) \
125 return( PSA_ERROR_BAD_STATE );
126
Steven Cooreman01164162020-07-20 15:31:37 +0200127psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100128{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100129 /* Mbed TLS error codes can combine a high-level error code and a
130 * low-level error code. The low-level error usually reflects the
131 * root cause better, so dispatch on that preferably. */
132 int low_level_ret = - ( -ret & 0x007f );
133 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100134 {
135 case 0:
136 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100137
138 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
139 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
140 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
141 return( PSA_ERROR_NOT_SUPPORTED );
142 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
143 return( PSA_ERROR_HARDWARE_FAILURE );
144
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200145 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
146 return( PSA_ERROR_HARDWARE_FAILURE );
147
Gilles Peskine9a944802018-06-21 09:35:35 +0200148 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
149 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
150 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
151 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
152 case MBEDTLS_ERR_ASN1_INVALID_DATA:
153 return( PSA_ERROR_INVALID_ARGUMENT );
154 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
155 return( PSA_ERROR_INSUFFICIENT_MEMORY );
156 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
157 return( PSA_ERROR_BUFFER_TOO_SMALL );
158
Jaeden Amero93e21112019-02-20 13:57:28 +0000159#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000160 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
162 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
163#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100164 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
165 return( PSA_ERROR_NOT_SUPPORTED );
166 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
167 return( PSA_ERROR_HARDWARE_FAILURE );
168
Jaeden Amero93e21112019-02-20 13:57:28 +0000169#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000170 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
172 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
173#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
175 return( PSA_ERROR_NOT_SUPPORTED );
176 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
177 return( PSA_ERROR_HARDWARE_FAILURE );
178
179 case MBEDTLS_ERR_CCM_BAD_INPUT:
180 return( PSA_ERROR_INVALID_ARGUMENT );
181 case MBEDTLS_ERR_CCM_AUTH_FAILED:
182 return( PSA_ERROR_INVALID_SIGNATURE );
183 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
184 return( PSA_ERROR_HARDWARE_FAILURE );
185
Gilles Peskine26869f22019-05-06 15:25:00 +0200186 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
187 return( PSA_ERROR_INVALID_ARGUMENT );
188
189 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
190 return( PSA_ERROR_BAD_STATE );
191 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
192 return( PSA_ERROR_INVALID_SIGNATURE );
193
Gilles Peskinea5905292018-02-07 20:59:33 +0100194 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
195 return( PSA_ERROR_NOT_SUPPORTED );
196 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
197 return( PSA_ERROR_INVALID_ARGUMENT );
198 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
199 return( PSA_ERROR_INSUFFICIENT_MEMORY );
200 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
201 return( PSA_ERROR_INVALID_PADDING );
202 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200203 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100204 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
205 return( PSA_ERROR_INVALID_SIGNATURE );
206 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200207 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
209 return( PSA_ERROR_HARDWARE_FAILURE );
210
211 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
Gilles Peskine82e57d12020-11-13 21:31:17 +0100214#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
215 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100216 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
217 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
221 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
224 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100225#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100226
227 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
228 return( PSA_ERROR_NOT_SUPPORTED );
229 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
230 return( PSA_ERROR_HARDWARE_FAILURE );
231
Gilles Peskinee59236f2018-01-27 23:32:46 +0100232 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
233 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
234 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
235 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100236
237 case MBEDTLS_ERR_GCM_AUTH_FAILED:
238 return( PSA_ERROR_INVALID_SIGNATURE );
239 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200240 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100241 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
242 return( PSA_ERROR_HARDWARE_FAILURE );
243
Gilles Peskine82e57d12020-11-13 21:31:17 +0100244#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
245 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100246 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
247 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100248 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
250 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
251 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
252 return( PSA_ERROR_NOT_SUPPORTED );
253 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
254 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
255#endif
256
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200257 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
258 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
259 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
260 return( PSA_ERROR_HARDWARE_FAILURE );
261
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
263 return( PSA_ERROR_NOT_SUPPORTED );
264 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MD_ALLOC_FAILED:
267 return( PSA_ERROR_INSUFFICIENT_MEMORY );
268 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
269 return( PSA_ERROR_STORAGE_FAILURE );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200270 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
271 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100272
Gilles Peskinef76aa772018-10-29 19:24:33 +0100273 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
274 return( PSA_ERROR_STORAGE_FAILURE );
275 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
280 return( PSA_ERROR_BUFFER_TOO_SMALL );
281 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
282 return( PSA_ERROR_INVALID_ARGUMENT );
283 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
286 return( PSA_ERROR_INVALID_ARGUMENT );
287 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
288 return( PSA_ERROR_INSUFFICIENT_MEMORY );
289
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100290 case MBEDTLS_ERR_PK_ALLOC_FAILED:
291 return( PSA_ERROR_INSUFFICIENT_MEMORY );
292 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
293 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
294 return( PSA_ERROR_INVALID_ARGUMENT );
295 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100296 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100297 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
298 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
299 return( PSA_ERROR_INVALID_ARGUMENT );
300 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
303 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
304 return( PSA_ERROR_NOT_PERMITTED );
305 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_PK_INVALID_ALG:
308 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
309 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
310 return( PSA_ERROR_NOT_SUPPORTED );
311 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
312 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100313 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
314 return( PSA_ERROR_HARDWARE_FAILURE );
315
Gilles Peskineff2d2002019-05-06 15:26:23 +0200316 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
317 return( PSA_ERROR_HARDWARE_FAILURE );
318 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
319 return( PSA_ERROR_NOT_SUPPORTED );
320
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200321 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
322 return( PSA_ERROR_HARDWARE_FAILURE );
323
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
325 return( PSA_ERROR_INVALID_ARGUMENT );
326 case MBEDTLS_ERR_RSA_INVALID_PADDING:
327 return( PSA_ERROR_INVALID_PADDING );
328 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
331 return( PSA_ERROR_INVALID_ARGUMENT );
332 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
333 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200334 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100335 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
336 return( PSA_ERROR_INVALID_SIGNATURE );
337 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
338 return( PSA_ERROR_BUFFER_TOO_SMALL );
339 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100340 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100341 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
342 return( PSA_ERROR_NOT_SUPPORTED );
343 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
344 return( PSA_ERROR_HARDWARE_FAILURE );
345
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200346 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
347 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
348 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
349 return( PSA_ERROR_HARDWARE_FAILURE );
350
Gilles Peskinea5905292018-02-07 20:59:33 +0100351 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
352 return( PSA_ERROR_INVALID_ARGUMENT );
353 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
354 return( PSA_ERROR_HARDWARE_FAILURE );
355
itayzafrir5c753392018-05-08 11:18:38 +0300356 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300357 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300358 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300359 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
360 return( PSA_ERROR_BUFFER_TOO_SMALL );
361 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
362 return( PSA_ERROR_NOT_SUPPORTED );
363 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
364 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
365 return( PSA_ERROR_INVALID_SIGNATURE );
366 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
367 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100368 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
369 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300370 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
371 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100372
Janos Follatha13b9052019-11-22 12:48:59 +0000373 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
374 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300375
Gilles Peskinee59236f2018-01-27 23:32:46 +0100376 default:
David Saadab4ecc272019-02-14 13:48:10 +0200377 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100378 }
379}
380
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200381
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200382
383
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100384/****************************************************************/
385/* Key management */
386/****************************************************************/
387
Gilles Peskine73167e12019-07-12 23:44:37 +0200388#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
389static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
390{
Gilles Peskine8e338702019-07-30 20:06:31 +0200391 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200392}
393#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
394
John Durkop07cc04a2020-11-16 22:08:34 -0800395/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
396 * current test driver in key_management.c is using this function
397 * when accelerators are used for ECC key pair and public key.
398 * Once that dependency is resolved these guards can be removed.
399 */
John Durkop9814fa22020-11-04 12:28:15 -0800400#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800401 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
402 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
403 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100404mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 size_t bits,
406 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200407{
408 switch( curve )
409 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100410 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100411 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100413#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
421#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100422 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100424#endif
425#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100427 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100428#endif
429#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100430 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100431 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100432 case 528:
433 if( bits_is_sloppy )
434 return( MBEDTLS_ECP_DP_SECP521R1 );
435 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100437 }
438 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100439
Paul Elliott8ff510a2020-06-02 17:19:28 +0100440 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100441 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100442 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100443#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100445 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100446#endif
447#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100448 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100449 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100450#endif
451#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100452 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100454#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100455 }
456 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100457
Paul Elliott8ff510a2020-06-02 17:19:28 +0100458 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100459 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100460 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100461#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100462 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100463 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100464 case 256:
465 if( bits_is_sloppy )
466 return( MBEDTLS_ECP_DP_CURVE25519 );
467 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100468#endif
469#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100470 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100471 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100472#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100473 }
474 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100475
Paul Elliott8ff510a2020-06-02 17:19:28 +0100476 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100477 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100478 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100479#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100480 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100481 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100482#endif
483#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100484 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100485 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100486#endif
487#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100488 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100489 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100490#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100491 }
492 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200493 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100494
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100495 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100496 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200497}
John Durkop9814fa22020-11-04 12:28:15 -0800498#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800499 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
500 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
501 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200502
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200503static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
504 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200505{
506 /* Check that the bit size is acceptable for the key type */
507 switch( type )
508 {
509 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200510 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200511 case PSA_KEY_TYPE_DERIVE:
512 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100513#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200514 case PSA_KEY_TYPE_AES:
515 if( bits != 128 && bits != 192 && bits != 256 )
516 return( PSA_ERROR_INVALID_ARGUMENT );
517 break;
518#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100519#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200520 case PSA_KEY_TYPE_CAMELLIA:
521 if( bits != 128 && bits != 192 && bits != 256 )
522 return( PSA_ERROR_INVALID_ARGUMENT );
523 break;
524#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100525#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200526 case PSA_KEY_TYPE_DES:
527 if( bits != 64 && bits != 128 && bits != 192 )
528 return( PSA_ERROR_INVALID_ARGUMENT );
529 break;
530#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100531#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200532 case PSA_KEY_TYPE_ARC4:
533 if( bits < 8 || bits > 2048 )
534 return( PSA_ERROR_INVALID_ARGUMENT );
535 break;
536#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100537#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200538 case PSA_KEY_TYPE_CHACHA20:
539 if( bits != 256 )
540 return( PSA_ERROR_INVALID_ARGUMENT );
541 break;
542#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200543 default:
544 return( PSA_ERROR_NOT_SUPPORTED );
545 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200546 if( bits % 8 != 0 )
547 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200548
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200549 return( PSA_SUCCESS );
550}
551
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100552/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100553 *
Steven Cooremancd640932021-03-08 12:00:27 +0100554 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
555 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100556 *
557 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100558 * \param[in] key_type The key type of the key to be used with the
559 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100560 *
561 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100562 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100563 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100564 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100565 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100566MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100567 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100568 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100569{
Steven Cooremancd640932021-03-08 12:00:27 +0100570 if( PSA_ALG_IS_HMAC( algorithm ) )
571 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100572 if( key_type == PSA_KEY_TYPE_HMAC )
573 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100574 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100575
576 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100577 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100578 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
579 * key. */
580 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
581 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
582 {
583 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
584 * the block length (larger than 1) for block ciphers. */
585 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
586 return( PSA_SUCCESS );
587 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100588 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100589
590 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100591}
592
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200593psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
594 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200595{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100596 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200597 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200598
Ronald Cronea0f8a62020-11-25 17:52:23 +0100599 slot->key.data = mbedtls_calloc( 1, buffer_length );
600 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200601 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200602
Ronald Cronea0f8a62020-11-25 17:52:23 +0100603 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200604 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200605}
606
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200607psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
608 const uint8_t* data,
609 size_t data_length )
610{
611 psa_status_t status = psa_allocate_buffer_to_slot( slot,
612 data_length );
613 if( status != PSA_SUCCESS )
614 return( status );
615
Ronald Cronea0f8a62020-11-25 17:52:23 +0100616 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200617 return( PSA_SUCCESS );
618}
619
Ronald Crona0fe59f2020-11-29 11:14:53 +0100620psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100621 const psa_key_attributes_t *attributes,
622 const uint8_t *data, size_t data_length,
623 uint8_t *key_buffer, size_t key_buffer_size,
624 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100625{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100626 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
627 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100628
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200629 /* zero-length keys are never supported. */
630 if( data_length == 0 )
631 return( PSA_ERROR_NOT_SUPPORTED );
632
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100633 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100634 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200636
Steven Cooreman75b74362020-07-28 14:30:13 +0200637 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
638 if( data_length > SIZE_MAX / 8 )
639 return( PSA_ERROR_NOT_SUPPORTED );
640
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200641 /* Enforce a size limit, and in particular ensure that the bit
642 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100643 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200644 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200645
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100646 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200647 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200648 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200649
Ronald Crondd04d422020-11-28 15:14:42 +0100650 /* Copy the key material. */
651 memcpy( key_buffer, data, data_length );
652 *key_buffer_length = data_length;
653 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200654
Steven Cooreman40120f62020-10-29 11:42:22 +0100655 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100656 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100657 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200658 {
John Durkop9814fa22020-11-04 12:28:15 -0800659#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
660 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100661 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200662 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100663 return( mbedtls_psa_ecp_import_key( attributes,
664 data, data_length,
665 key_buffer, key_buffer_size,
666 key_buffer_length,
667 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100668 }
John Durkop9814fa22020-11-04 12:28:15 -0800669#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
670 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700671#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
672 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100673 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200674 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100675 return( mbedtls_psa_rsa_import_key( attributes,
676 data, data_length,
677 key_buffer, key_buffer_size,
678 key_buffer_length,
679 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200680 }
John Durkop9814fa22020-11-04 12:28:15 -0800681#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
682 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100684
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100685 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100686}
687
Gilles Peskinef603c712019-01-19 13:40:11 +0100688/** Calculate the intersection of two algorithm usage policies.
689 *
690 * Return 0 (which allows no operation) on incompatibility.
691 */
692static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100693 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100694 psa_algorithm_t alg1,
695 psa_algorithm_t alg2 )
696{
Gilles Peskine549ea862019-05-22 11:45:59 +0200697 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100698 if( alg1 == alg2 )
699 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100700 /* If the policies are from the same hash-and-sign family, check
701 * if one is a wildcard. If so the other has the specific algorithm. */
702 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
703 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
704 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100705 {
Steven Cooreman03488022021-02-18 12:07:20 +0100706 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
707 return( alg2 );
708 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
709 return( alg1 );
710 }
711 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100712 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100713 * restrictive tag length. */
714 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
715 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
716 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
717 {
718 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
719 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100720 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100721
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100722 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100723 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
724 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100725 {
Steven Cooremancd640932021-03-08 12:00:27 +0100726 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
727 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
729 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100730 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100731 ( alg1_len <= alg2_len ) )
732 {
733 return( alg2 );
734 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100735 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100736 ( alg2_len <= alg1_len ) )
737 {
738 return( alg1 );
739 }
740 }
741 /* If the policies are from the same MAC family, check whether one
742 * of them is a minimum-MAC-length policy. Calculate the most
743 * restrictive tag length. */
744 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
745 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
746 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
747 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100748 /* Validate the combination of key type and algorithm. Since the base
749 * algorithm of alg1 and alg2 are the same, we only need this once. */
750 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100751 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100752
Steven Cooreman31a876d2021-03-03 20:47:40 +0100753 /* Get the (exact or at-least) output lengths for both sides of the
754 * requested intersection. None of the currently supported algorithms
755 * have an output length dependent on the actual key size, so setting it
756 * to a bogus value of 0 is currently OK.
757 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100758 * Note that for at-least-this-length wildcard algorithms, the output
759 * length is set to the shortest allowed length, which allows us to
760 * calculate the most restrictive tag length for the intersection. */
761 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
762 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100763 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100764
Steven Cooremana1d83222021-02-25 10:20:29 +0100765 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100766 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
767 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100768 {
Steven Cooremancd640932021-03-08 12:00:27 +0100769 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100770 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100771
772 /* If only one is an at-least-this-length policy, the intersection would
773 * be the other (fixed-length) policy as long as said fixed length is
774 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100775 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100776 {
Steven Cooremancd640932021-03-08 12:00:27 +0100777 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100778 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100779 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100780 {
Steven Cooremancd640932021-03-08 12:00:27 +0100781 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100782 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100783
Steven Cooremancd640932021-03-08 12:00:27 +0100784 /* If none of them are wildcards, check whether they define the same tag
785 * length. This is still possible here when one is default-length and
786 * the other specific-length. Ensure to always return the
787 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100788 if( alg1_len == alg2_len )
789 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100790 }
791 /* If the policies are incompatible, allow nothing. */
792 return( 0 );
793}
794
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795static int psa_key_algorithm_permits( psa_key_type_t key_type,
796 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200797 psa_algorithm_t requested_alg )
798{
Gilles Peskine549ea862019-05-22 11:45:59 +0200799 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200800 if( requested_alg == policy_alg )
801 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100802 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
803 * and requested_alg is the same hash-and-sign family with any hash,
804 * then requested_alg is compliant with policy_alg. */
805 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
806 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200807 {
Steven Cooreman03488022021-02-18 12:07:20 +0100808 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
809 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
810 }
811 /* If policy_alg is a wildcard AEAD algorithm of the same base as
812 * the requested algorithm, check the requested tag length to be
813 * equal-length or longer than the wildcard-specified length. */
814 if( PSA_ALG_IS_AEAD( policy_alg ) &&
815 PSA_ALG_IS_AEAD( requested_alg ) &&
816 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
817 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100818 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100819 {
820 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
821 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
822 }
Steven Cooremancd640932021-03-08 12:00:27 +0100823 /* If policy_alg is a MAC algorithm of the same base as the requested
824 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100825 if( PSA_ALG_IS_MAC( policy_alg ) &&
826 PSA_ALG_IS_MAC( requested_alg ) &&
827 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100828 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100829 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100830 /* Validate the combination of key type and algorithm. Since the policy
831 * and requested algorithms are the same, we only need this once. */
832 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100833 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100834
Steven Cooreman31a876d2021-03-03 20:47:40 +0100835 /* Get both the requested output length for the algorithm which is to be
836 * verified, and the default output length for the base algorithm.
837 * Note that none of the currently supported algorithms have an output
838 * length dependent on actual key size, so setting it to a bogus value
839 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100840 size_t requested_output_length = PSA_MAC_LENGTH(
841 key_type, 0, requested_alg );
842 size_t default_output_length = PSA_MAC_LENGTH(
843 key_type, 0,
844 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100845
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100846 /* If the policy is default-length, only allow an algorithm with
847 * a declared exact-length matching the default. */
848 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100849 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100850
851 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100852 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100853 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
854 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
855 {
856 return( 1 );
857 }
858
Steven Cooremancd640932021-03-08 12:00:27 +0100859 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
860 * check for the requested MAC length to be equal to or longer than the
861 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100862 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
863 {
864 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100865 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100866 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200867 }
Steven Cooremance48e852020-10-05 16:02:45 +0200868 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200869 * a key derivation with that key agreement should also be allowed. This
870 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200871 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
872 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
873 {
874 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
875 policy_alg );
876 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100877 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200878 return( 0 );
879}
880
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100881/** Test whether a policy permits an algorithm.
882 *
883 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100884 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100885 * \note This function requires providing the key type for which the policy is
886 * being validated, since some algorithm policy definitions (e.g. MAC)
887 * have different properties depending on what kind of cipher it is
888 * combined with.
889 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100890 * \retval PSA_SUCCESS When \p alg is a specific algorithm
891 * allowed by the \p policy.
892 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
893 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
894 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100895 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100896static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100897 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100898 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100899{
Steven Cooremand788fab2021-02-25 11:29:17 +0100900 /* '0' is not a valid algorithm */
901 if( alg == 0 )
902 return( PSA_ERROR_INVALID_ARGUMENT );
903
Steven Cooreman7e39f052021-02-23 14:18:32 +0100904 /* A requested algorithm cannot be a wildcard. */
905 if( PSA_ALG_IS_WILDCARD( alg ) )
906 return( PSA_ERROR_INVALID_ARGUMENT );
907
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100908 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
909 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100910 return( PSA_SUCCESS );
911 else
912 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100913}
914
Gilles Peskinef603c712019-01-19 13:40:11 +0100915/** Restrict a key policy based on a constraint.
916 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100917 * \note This function requires providing the key type for which the policy is
918 * being restricted, since some algorithm policy definitions (e.g. MAC)
919 * have different properties depending on what kind of cipher it is
920 * combined with.
921 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100922 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100923 * \param[in,out] policy The policy to restrict.
924 * \param[in] constraint The policy constraint to apply.
925 *
926 * \retval #PSA_SUCCESS
927 * \c *policy contains the intersection of the original value of
928 * \c *policy and \c *constraint.
929 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100930 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100931 * \c *policy is unchanged.
932 */
933static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100934 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100935 psa_key_policy_t *policy,
936 const psa_key_policy_t *constraint )
937{
938 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100939 psa_key_policy_algorithm_intersection( key_type, policy->alg,
940 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200941 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100942 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
943 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100944 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
945 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200946 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
947 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100948 policy->usage &= constraint->usage;
949 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200950 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100951 return( PSA_SUCCESS );
952}
953
Ronald Cron5c522922020-11-14 16:35:34 +0100954/** Get the description of a key given its identifier and policy constraints
955 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200956 *
Ronald Cron5c522922020-11-14 16:35:34 +0100957 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100958 * nonzero, the key must allow operations with this algorithm. If \p alg is
959 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100960 *
Ronald Cron5c522922020-11-14 16:35:34 +0100961 * In case of a persistent key, the function loads the description of the key
962 * into a key slot if not already done.
963 *
964 * On success, the returned key slot is locked. It is the responsibility of
965 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200966 */
Ronald Cron5c522922020-11-14 16:35:34 +0100967static psa_status_t psa_get_and_lock_key_slot_with_policy(
968 mbedtls_svc_key_id_t key,
969 psa_key_slot_t **p_slot,
970 psa_key_usage_t usage,
971 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100972{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200973 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
974 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100975
Ronald Cron5c522922020-11-14 16:35:34 +0100976 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100977 if( status != PSA_SUCCESS )
978 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200979 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100980
981 /* Enforce that usage policy for the key slot contains all the flags
982 * required by the usage parameter. There is one exception: public
983 * keys can always be exported, so we treat public key objects as
984 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200985 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100986 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987
Gilles Peskine8e338702019-07-30 20:06:31 +0200988 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100989 {
990 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200991 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100992 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100993
994 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100995 if( alg != 0 )
996 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100997 status = psa_key_policy_permits( &slot->attr.policy,
998 slot->attr.type,
999 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001000 if( status != PSA_SUCCESS )
1001 goto error;
1002 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001003
Darryl Green06fd18d2018-07-16 11:21:11 +01001004 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001005
1006error:
1007 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001008 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001009
1010 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001011}
Darryl Green940d72c2018-07-13 13:18:51 +01001012
Ronald Cron5c522922020-11-14 16:35:34 +01001013/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001014 *
1015 * A transparent key is a key for which the key material is directly
1016 * available, as opposed to a key in a secure element.
1017 *
Ronald Cron5c522922020-11-14 16:35:34 +01001018 * This is a temporary function to use instead of
1019 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1020 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001021 *
Ronald Cron5c522922020-11-14 16:35:34 +01001022 * On success, the returned key slot is locked. It is the responsibility of the
1023 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001024 */
1025#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001026static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1027 mbedtls_svc_key_id_t key,
1028 psa_key_slot_t **p_slot,
1029 psa_key_usage_t usage,
1030 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001031{
Ronald Cron5c522922020-11-14 16:35:34 +01001032 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1033 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001034 if( status != PSA_SUCCESS )
1035 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001036
Gilles Peskineadad8132019-07-25 11:31:23 +02001037 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001038 {
Ronald Cron5c522922020-11-14 16:35:34 +01001039 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001040 *p_slot = NULL;
1041 return( PSA_ERROR_NOT_SUPPORTED );
1042 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001043
Gilles Peskine28f8f302019-07-24 13:30:31 +02001044 return( PSA_SUCCESS );
1045}
1046#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1047/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001048#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1049 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001050#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1051
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001052psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001053{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001054 /* Data pointer will always be either a valid pointer or NULL in an
1055 * initialized slot, so we can just free it. */
1056 if( slot->key.data != NULL )
1057 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1058
1059 mbedtls_free( slot->key.data );
1060 slot->key.data = NULL;
1061 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001062
1063 return( PSA_SUCCESS );
1064}
1065
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001066/** Completely wipe a slot in memory, including its policy.
1067 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001068psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001069{
1070 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001071
1072 /*
1073 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001074 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001075 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1076 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001077 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001078 */
Ronald Cron5c522922020-11-14 16:35:34 +01001079 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001080 {
1081#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001082 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001083#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001084 status = PSA_ERROR_CORRUPTION_DETECTED;
1085 }
1086
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001087 /* Multipart operations may still be using the key. This is safe
1088 * because all multipart operation objects are independent from
1089 * the key slot: if they need to access the key after the setup
1090 * phase, they have a copy of the key. Note that this means that
1091 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001092 /* At this point, key material and other type-specific content has
1093 * been wiped. Clear remaining metadata. We can call memset and not
1094 * zeroize because the metadata is not particularly sensitive. */
1095 memset( slot, 0, sizeof( *slot ) );
1096 return( status );
1097}
1098
Ronald Croncf56a0a2020-08-04 09:51:30 +02001099psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001100{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001101 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 psa_status_t status; /* status of the last operation */
1103 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001104#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1105 psa_se_drv_table_entry_t *driver;
1106#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001107
Ronald Croncf56a0a2020-08-04 09:51:30 +02001108 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001109 return( PSA_SUCCESS );
1110
Ronald Cronf2911112020-10-29 17:51:10 +01001111 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001112 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001113 * key, this will load the key description from persistent memory if not
1114 * done yet. We cannot avoid this loading as without it we don't know if
1115 * the key is operated by an SE or not and this information is needed by
1116 * the current implementation.
1117 */
Ronald Cron5c522922020-11-14 16:35:34 +01001118 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001119 if( status != PSA_SUCCESS )
1120 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001121
Ronald Cronf2911112020-10-29 17:51:10 +01001122 /*
1123 * If the key slot containing the key description is under access by the
1124 * library (apart from the present access), the key cannot be destroyed
1125 * yet. For the time being, just return in error. Eventually (to be
1126 * implemented), the key should be destroyed when all accesses have
1127 * stopped.
1128 */
Ronald Cron5c522922020-11-14 16:35:34 +01001129 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001130 {
Ronald Cron5c522922020-11-14 16:35:34 +01001131 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001132 return( PSA_ERROR_GENERIC_ERROR );
1133 }
1134
Gilles Peskine354f7672019-07-12 23:46:38 +02001135#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001136 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001137 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001138 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001139 /* For a key in a secure element, we need to do three things:
1140 * remove the key file in internal storage, destroy the
1141 * key inside the secure element, and update the driver's
1142 * persistent data. Start a transaction that will encompass these
1143 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001144 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001145 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001146 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001147 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001148 status = psa_crypto_save_transaction( );
1149 if( status != PSA_SUCCESS )
1150 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001151 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001152 /* We should still try to destroy the key in the secure
1153 * element and the key metadata in storage. This is especially
1154 * important if the error is that the storage is full.
1155 * But how to do it exactly without risking an inconsistent
1156 * state after a reset?
1157 * https://github.com/ARMmbed/mbed-crypto/issues/215
1158 */
1159 overall_status = status;
1160 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001161 }
1162
Ronald Cronea0f8a62020-11-25 17:52:23 +01001163 status = psa_destroy_se_key( driver,
1164 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001165 if( overall_status == PSA_SUCCESS )
1166 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001167 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001168#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1169
Darryl Greend49a4992018-06-18 17:27:26 +01001170#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001171 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001172 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001173 status = psa_destroy_persistent_key( slot->attr.id );
1174 if( overall_status == PSA_SUCCESS )
1175 overall_status = status;
1176
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001177 /* TODO: other slots may have a copy of the same key. We should
1178 * invalidate them.
1179 * https://github.com/ARMmbed/mbed-crypto/issues/214
1180 */
Darryl Greend49a4992018-06-18 17:27:26 +01001181 }
1182#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001183
Gilles Peskinefc762652019-07-22 19:30:34 +02001184#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1185 if( driver != NULL )
1186 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001187 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001188 if( overall_status == PSA_SUCCESS )
1189 overall_status = status;
1190 status = psa_crypto_stop_transaction( );
1191 if( overall_status == PSA_SUCCESS )
1192 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001193 }
1194#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1195
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001196#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1197exit:
1198#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001199 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001200 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1201 if( overall_status == PSA_SUCCESS )
1202 overall_status = status;
1203 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001204}
1205
John Durkop07cc04a2020-11-16 22:08:34 -08001206#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001207 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001208static psa_status_t psa_get_rsa_public_exponent(
1209 const mbedtls_rsa_context *rsa,
1210 psa_key_attributes_t *attributes )
1211{
1212 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001214 uint8_t *buffer = NULL;
1215 size_t buflen;
1216 mbedtls_mpi_init( &mpi );
1217
1218 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1219 if( ret != 0 )
1220 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001221 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1222 {
1223 /* It's the default value, which is reported as an empty string,
1224 * so there's nothing to do. */
1225 goto exit;
1226 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001227
1228 buflen = mbedtls_mpi_size( &mpi );
1229 buffer = mbedtls_calloc( 1, buflen );
1230 if( buffer == NULL )
1231 {
1232 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1233 goto exit;
1234 }
1235 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1236 if( ret != 0 )
1237 goto exit;
1238 attributes->domain_parameters = buffer;
1239 attributes->domain_parameters_size = buflen;
1240
1241exit:
1242 mbedtls_mpi_free( &mpi );
1243 if( ret != 0 )
1244 mbedtls_free( buffer );
1245 return( mbedtls_to_psa_error( ret ) );
1246}
John Durkop07cc04a2020-11-16 22:08:34 -08001247#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001248 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001249
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001250/** Retrieve all the publicly-accessible attributes of a key.
1251 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001252psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001253 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001254{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001256 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001257 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001258
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001259 psa_reset_key_attributes( attributes );
1260
Ronald Cron5c522922020-11-14 16:35:34 +01001261 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001262 if( status != PSA_SUCCESS )
1263 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001264
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001265 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001266 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1267 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1268
1269#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1270 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001271 psa_set_key_slot_number( attributes,
1272 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001273#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001274
Gilles Peskine8e338702019-07-30 20:06:31 +02001275 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001276 {
John Durkop07cc04a2020-11-16 22:08:34 -08001277#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001278 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001279 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001280 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001281#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001282 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001283 * is not yet implemented.
1284 * https://github.com/ARMmbed/mbed-crypto/issues/216
1285 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001286 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001287 break;
1288#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001289 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001290 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001291
Ronald Cron90857082020-11-25 14:58:33 +01001292 status = mbedtls_psa_rsa_load_representation(
1293 slot->attr.type,
1294 slot->key.data,
1295 slot->key.bytes,
1296 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001297 if( status != PSA_SUCCESS )
1298 break;
1299
Steven Cooremana2371e52020-07-28 14:30:39 +02001300 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001301 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001302 mbedtls_rsa_free( rsa );
1303 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001304 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001305 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001306#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001307 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001308 default:
1309 /* Nothing else to do. */
1310 break;
1311 }
1312
1313 if( status != PSA_SUCCESS )
1314 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001315
Ronald Cron5c522922020-11-14 16:35:34 +01001316 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001317
Ronald Cron5c522922020-11-14 16:35:34 +01001318 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001319}
1320
Gilles Peskinec8000c02019-08-02 20:15:51 +02001321#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1322psa_status_t psa_get_key_slot_number(
1323 const psa_key_attributes_t *attributes,
1324 psa_key_slot_number_t *slot_number )
1325{
1326 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1327 {
1328 *slot_number = attributes->slot_number;
1329 return( PSA_SUCCESS );
1330 }
1331 else
1332 return( PSA_ERROR_INVALID_ARGUMENT );
1333}
1334#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1335
Ronald Crond18b5f82020-11-25 16:46:05 +01001336static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1337 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001338 uint8_t *data,
1339 size_t data_size,
1340 size_t *data_length )
1341{
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001343 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001344 memcpy( data, key_buffer, key_buffer_size );
1345 memset( data + key_buffer_size, 0,
1346 data_size - key_buffer_size );
1347 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001348 return( PSA_SUCCESS );
1349}
1350
Ronald Cron7285cda2020-11-26 14:46:37 +01001351psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001352 const psa_key_attributes_t *attributes,
1353 const uint8_t *key_buffer, size_t key_buffer_size,
1354 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001355{
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 psa_key_type_t type = attributes->core.type;
1357
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( key_type_is_raw_bytes( type ) ||
1359 PSA_KEY_TYPE_IS_RSA( type ) ||
1360 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001361 {
1362 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 key_buffer, key_buffer_size,
1364 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001365 }
1366 else
1367 {
1368 /* This shouldn't happen in the reference implementation, but
1369 it is valid for a special-purpose implementation to omit
1370 support for exporting certain key types. */
1371 return( PSA_ERROR_NOT_SUPPORTED );
1372 }
1373}
1374
1375psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1376 uint8_t *data,
1377 size_t data_size,
1378 size_t *data_length )
1379{
1380 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1381 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1382 psa_key_slot_t *slot;
1383
Ronald Crone907e552021-01-18 13:22:38 +01001384 /* Reject a zero-length output buffer now, since this can never be a
1385 * valid key representation. This way we know that data must be a valid
1386 * pointer and we can do things like memset(data, ..., data_size). */
1387 if( data_size == 0 )
1388 return( PSA_ERROR_BUFFER_TOO_SMALL );
1389
Ronald Cron9486f9d2020-11-26 13:36:23 +01001390 /* Set the key to empty now, so that even when there are errors, we always
1391 * set data_length to a value between 0 and data_size. On error, setting
1392 * the key to empty is a good choice because an empty key representation is
1393 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001394 *data_length = 0;
1395
Ronald Cron9486f9d2020-11-26 13:36:23 +01001396 /* Export requires the EXPORT flag. There is an exception for public keys,
1397 * which don't require any flag, but
1398 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1399 */
1400 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1401 PSA_KEY_USAGE_EXPORT, 0 );
1402 if( status != PSA_SUCCESS )
1403 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001404
Ronald Crond18b5f82020-11-25 16:46:05 +01001405 psa_key_attributes_t attributes = {
1406 .core = slot->attr
1407 };
Ronald Cron67227982020-11-26 15:16:05 +01001408 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001409 slot->key.data, slot->key.bytes,
1410 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001411
Ronald Cron9486f9d2020-11-26 13:36:23 +01001412 unlock_status = psa_unlock_key_slot( slot );
1413
1414 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1415}
1416
Ronald Cron7285cda2020-11-26 14:46:37 +01001417psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001418 const psa_key_attributes_t *attributes,
1419 const uint8_t *key_buffer,
1420 size_t key_buffer_size,
1421 uint8_t *data,
1422 size_t data_size,
1423 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001424{
Ronald Crond18b5f82020-11-25 16:46:05 +01001425 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001426
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001428 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001429 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001430 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001431 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001432 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001433 key_buffer, key_buffer_size,
1434 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001435 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001436
Ronald Crond18b5f82020-11-25 16:46:05 +01001437 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001438 {
John Durkop0e005192020-10-31 22:06:54 -07001439#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1440 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001441 return( mbedtls_psa_rsa_export_public_key( attributes,
1442 key_buffer,
1443 key_buffer_size,
1444 data,
1445 data_size,
1446 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001447#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001448 /* We don't know how to convert a private RSA key to public. */
1449 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001450#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1451 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001452 }
1453 else
Moran Pekera998bc62018-04-16 18:16:20 +03001454 {
John Durkop6ba40d12020-11-10 08:50:04 -08001455#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1456 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001457 return( mbedtls_psa_ecp_export_public_key( attributes,
1458 key_buffer,
1459 key_buffer_size,
1460 data,
1461 data_size,
1462 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001463#else
1464 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001465 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001466#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1467 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001468 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001469 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001470 else
1471 {
1472 /* This shouldn't happen in the reference implementation, but
1473 it is valid for a special-purpose implementation to omit
1474 support for exporting certain key types. */
1475 return( PSA_ERROR_NOT_SUPPORTED );
1476 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001477}
Ronald Crond18b5f82020-11-25 16:46:05 +01001478
Ronald Croncf56a0a2020-08-04 09:51:30 +02001479psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001480 uint8_t *data,
1481 size_t data_size,
1482 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001483{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001484 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001485 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001486 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001487
Ronald Crone907e552021-01-18 13:22:38 +01001488 /* Reject a zero-length output buffer now, since this can never be a
1489 * valid key representation. This way we know that data must be a valid
1490 * pointer and we can do things like memset(data, ..., data_size). */
1491 if( data_size == 0 )
1492 return( PSA_ERROR_BUFFER_TOO_SMALL );
1493
Darryl Greendd8fb772018-11-07 16:00:44 +00001494 /* Set the key to empty now, so that even when there are errors, we always
1495 * set data_length to a value between 0 and data_size. On error, setting
1496 * the key to empty is a good choice because an empty key representation is
1497 * unlikely to be accepted anywhere. */
1498 *data_length = 0;
1499
1500 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001501 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001502 if( status != PSA_SUCCESS )
1503 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001504
Ronald Cron9486f9d2020-11-26 13:36:23 +01001505 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1506 {
1507 status = PSA_ERROR_INVALID_ARGUMENT;
1508 goto exit;
1509 }
1510
Ronald Crond18b5f82020-11-25 16:46:05 +01001511 psa_key_attributes_t attributes = {
1512 .core = slot->attr
1513 };
Ronald Cron67227982020-11-26 15:16:05 +01001514 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001515 &attributes, slot->key.data, slot->key.bytes,
1516 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001517
1518exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001519 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001520
Ronald Cron5c522922020-11-14 16:35:34 +01001521 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001522}
1523
Gilles Peskine91e8c332019-08-02 19:19:39 +02001524#if defined(static_assert)
1525static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1526 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001527static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001528 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001529static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001530 "One or more key attribute flag is listed as both internal-only and external-only" );
1531#endif
1532
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001533/** Validate that a key policy is internally well-formed.
1534 *
1535 * This function only rejects invalid policies. It does not validate the
1536 * consistency of the policy with respect to other attributes of the key
1537 * such as the key type.
1538 */
1539static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001540{
1541 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001542 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001543 PSA_KEY_USAGE_ENCRYPT |
1544 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arme8efa392021-04-14 21:14:28 +02001545 PSA_KEY_USAGE_SIGN_MESSAGE |
1546 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001547 PSA_KEY_USAGE_SIGN_HASH |
1548 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001549 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1550 return( PSA_ERROR_INVALID_ARGUMENT );
1551
Gilles Peskine4747d192019-04-17 15:05:45 +02001552 return( PSA_SUCCESS );
1553}
1554
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001555/** Validate the internal consistency of key attributes.
1556 *
1557 * This function only rejects invalid attribute values. If does not
1558 * validate the consistency of the attributes with any key data that may
1559 * be involved in the creation of the key.
1560 *
1561 * Call this function early in the key creation process.
1562 *
1563 * \param[in] attributes Key attributes for the new key.
1564 * \param[out] p_drv On any return, the driver for the key, if any.
1565 * NULL for a transparent key.
1566 *
1567 */
1568static psa_status_t psa_validate_key_attributes(
1569 const psa_key_attributes_t *attributes,
1570 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001571{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001572 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001573 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001574 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001575
Ronald Cron54b90082020-10-29 15:26:43 +01001576 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001577 if( status != PSA_SUCCESS )
1578 return( status );
1579
Ronald Crond2ed4812020-07-17 16:11:30 +02001580 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001581 if( status != PSA_SUCCESS )
1582 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001583
Ronald Cron65f38a32020-10-23 17:11:13 +02001584 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1585 {
1586 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1587 return( PSA_ERROR_INVALID_ARGUMENT );
1588 }
1589 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001590 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001591 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1592 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001593 }
1594
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001595 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001596 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001597 return( status );
1598
1599 /* Refuse to create overly large keys.
1600 * Note that this doesn't trigger on import if the attributes don't
1601 * explicitly specify a size (so psa_get_key_bits returns 0), so
1602 * psa_import_key() needs its own checks. */
1603 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1604 return( PSA_ERROR_NOT_SUPPORTED );
1605
Gilles Peskine91e8c332019-08-02 19:19:39 +02001606 /* Reject invalid flags. These should not be reachable through the API. */
1607 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1608 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1609 return( PSA_ERROR_INVALID_ARGUMENT );
1610
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001611 return( PSA_SUCCESS );
1612}
1613
Gilles Peskine4747d192019-04-17 15:05:45 +02001614/** Prepare a key slot to receive key material.
1615 *
1616 * This function allocates a key slot and sets its metadata.
1617 *
1618 * If this function fails, call psa_fail_key_creation().
1619 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001620 * This function is intended to be used as follows:
1621 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001622 * it with the specified attributes, and in case of a volatile key assign it
1623 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001624 * -# Populate the slot with the key material.
1625 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1626 * In case of failure at any step, stop the sequence and call
1627 * psa_fail_key_creation().
1628 *
Ronald Cron5c522922020-11-14 16:35:34 +01001629 * On success, the key slot is locked. It is the responsibility of the caller
1630 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001631 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001632 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001633 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001634 * \param[out] p_slot On success, a pointer to the prepared slot.
1635 * \param[out] p_drv On any return, the driver for the key, if any.
1636 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001637 *
1638 * \retval #PSA_SUCCESS
1639 * The key slot is ready to receive key material.
1640 * \return If this function fails, the key slot is an invalid state.
1641 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001642 */
1643static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001644 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001645 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001646 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001647 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001648{
1649 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001650 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001651 psa_key_slot_t *slot;
1652
Gilles Peskinedf179142019-07-15 22:02:14 +02001653 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 *p_drv = NULL;
1655
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001656 status = psa_validate_key_attributes( attributes, p_drv );
1657 if( status != PSA_SUCCESS )
1658 return( status );
1659
Ronald Cronc4d1b512020-07-31 11:26:37 +02001660 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001661 if( status != PSA_SUCCESS )
1662 return( status );
1663 slot = *p_slot;
1664
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001665 /* We're storing the declared bit-size of the key. It's up to each
1666 * creation mechanism to verify that this information is correct.
1667 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001668 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001669 * is optional (import, copy). In case of a volatile key, assign it the
1670 * volatile key identifier associated to the slot returned to contain its
1671 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001672
1673 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001674 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1675 {
1676#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1677 slot->attr.id = volatile_key_id;
1678#else
1679 slot->attr.id.key_id = volatile_key_id;
1680#endif
1681 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001682
Gilles Peskine91e8c332019-08-02 19:19:39 +02001683 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001684 * external-only flags, query `attributes`. Thanks to the check
1685 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001686 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001687 * may have set. */
1688 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001689
Gilles Peskinecbaff462019-07-12 23:46:04 +02001690#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001691 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001692 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001693 * create the key file in internal storage, create the
1694 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001695 * persistent data. This is done by starting a transaction that will
1696 * encompass these three actions.
1697 * For registering a volatile key, we just need to find an appropriate
1698 * slot number inside the SE. Since the key is designated volatile, creating
1699 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001700 /* The first thing to do is to find a slot number for the new key.
1701 * We save the slot number in persistent storage as part of the
1702 * transaction data. It will be needed to recover if the power
1703 * fails during the key creation process, to clean up on the secure
1704 * element side after restarting. Obtaining a slot number from the
1705 * secure element driver updates its persistent state, but we do not yet
1706 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001707 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001708 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001709 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001710 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001711 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001712 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001713 if( status != PSA_SUCCESS )
1714 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001715
1716 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001717 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001718 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1719 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001721 psa_crypto_transaction.key.id = slot->attr.id;
1722 status = psa_crypto_save_transaction( );
1723 if( status != PSA_SUCCESS )
1724 {
1725 (void) psa_crypto_stop_transaction( );
1726 return( status );
1727 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001728 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729
1730 status = psa_copy_key_material_into_slot(
1731 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001732 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001733
1734 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1735 {
1736 /* Key registration only makes sense with a secure element. */
1737 return( PSA_ERROR_INVALID_ARGUMENT );
1738 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001739#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1740
Ronald Cronc4d1b512020-07-31 11:26:37 +02001741 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001742}
Gilles Peskine4747d192019-04-17 15:05:45 +02001743
1744/** Finalize the creation of a key once its key material has been set.
1745 *
1746 * This entails writing the key to persistent storage.
1747 *
1748 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001749 * See the documentation of psa_start_key_creation() for the intended use
1750 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 *
Ronald Cron5c522922020-11-14 16:35:34 +01001752 * If the finalization succeeds, the function unlocks the key slot (it was
1753 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1754 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001755 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001756 * \param[in,out] slot Pointer to the slot with key material.
1757 * \param[in] driver The secure element driver for the key,
1758 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001759 * \param[out] key On success, identifier of the key. Note that the
1760 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001761 *
1762 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001763 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001764 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1765 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1766 * \retval #PSA_ERROR_ALREADY_EXISTS
1767 * \retval #PSA_ERROR_DATA_INVALID
1768 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001769 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001770 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001771 * \return If this function fails, the key slot is an invalid state.
1772 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001774static psa_status_t psa_finish_key_creation(
1775 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001776 psa_se_drv_table_entry_t *driver,
1777 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001778{
1779 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001780 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001782
1783#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001784 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001786#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1787 if( driver != NULL )
1788 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001789 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001790 psa_key_slot_number_t slot_number =
1791 psa_key_slot_get_slot_number( slot ) ;
1792
Gilles Peskineb46bef22019-07-30 21:32:04 +02001793#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001794 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001795 sizeof( data.slot_number ),
1796 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001797#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001798 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001799 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001800 (uint8_t*) &data,
1801 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001802 }
1803 else
1804#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1805 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001806 /* Key material is saved in export representation in the slot, so
1807 * just pass the slot buffer for storage. */
1808 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001809 slot->key.data,
1810 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001811 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001812 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001813#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1814
Gilles Peskinecbaff462019-07-12 23:46:04 +02001815#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001816 /* Finish the transaction for a key creation. This does not
1817 * happen when registering an existing key. Detect this case
1818 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001819 * creation of a persistent key in a secure element requires a transaction,
1820 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001821 if( driver != NULL &&
1822 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001823 {
1824 status = psa_save_se_persistent_data( driver );
1825 if( status != PSA_SUCCESS )
1826 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001827 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001828 return( status );
1829 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001830 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001831 }
1832#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1833
Ronald Cron50972942020-11-14 11:28:25 +01001834 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001835 {
1836 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001837 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001838 if( status != PSA_SUCCESS )
1839 *key = MBEDTLS_SVC_KEY_ID_INIT;
1840 }
Ronald Cron50972942020-11-14 11:28:25 +01001841
Gilles Peskine4747d192019-04-17 15:05:45 +02001842 return( status );
1843}
1844
1845/** Abort the creation of a key.
1846 *
1847 * You may call this function after calling psa_start_key_creation(),
1848 * or after psa_finish_key_creation() fails. In other circumstances, this
1849 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001850 * See the documentation of psa_start_key_creation() for the intended use
1851 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001852 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001853 * \param[in,out] slot Pointer to the slot with key material.
1854 * \param[in] driver The secure element driver for the key,
1855 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001856 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001857static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001858 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001859{
Gilles Peskine011e4282019-06-26 18:34:38 +02001860 (void) driver;
1861
Gilles Peskine4747d192019-04-17 15:05:45 +02001862 if( slot == NULL )
1863 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001864
1865#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001866 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001867 * element, and the failure happened later (when saving metadata
1868 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001869 * element.
1870 * https://github.com/ARMmbed/mbed-crypto/issues/217
1871 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001872
Gilles Peskined7729582019-08-05 15:55:54 +02001873 /* Abort the ongoing transaction if any (there may not be one if
1874 * the creation process failed before starting one, or if the
1875 * key creation is a registration of a key in a secure element).
1876 * Earlier functions must already have done what it takes to undo any
1877 * partial creation. All that's left is to update the transaction data
1878 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001879 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001880#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1881
Gilles Peskine4747d192019-04-17 15:05:45 +02001882 psa_wipe_key_slot( slot );
1883}
1884
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001885/** Validate optional attributes during key creation.
1886 *
1887 * Some key attributes are optional during key creation. If they are
1888 * specified in the attributes structure, check that they are consistent
1889 * with the data in the slot.
1890 *
1891 * This function should be called near the end of key creation, after
1892 * the slot in memory is fully populated but before saving persistent data.
1893 */
1894static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 const psa_key_slot_t *slot,
1896 const psa_key_attributes_t *attributes )
1897{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001898 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001899 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001900 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 return( PSA_ERROR_INVALID_ARGUMENT );
1902 }
1903
1904 if( attributes->domain_parameters_size != 0 )
1905 {
John Durkop0e005192020-10-31 22:06:54 -07001906#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1907 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001908 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001910 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001911 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001913
Ronald Cron90857082020-11-25 14:58:33 +01001914 psa_status_t status = mbedtls_psa_rsa_load_representation(
1915 slot->attr.type,
1916 slot->key.data,
1917 slot->key.bytes,
1918 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001919 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001920 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001921
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001922 mbedtls_mpi_init( &actual );
1923 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001924 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001926 mbedtls_rsa_free( rsa );
1927 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001928 if( ret != 0 )
1929 goto rsa_exit;
1930 ret = mbedtls_mpi_read_binary( &required,
1931 attributes->domain_parameters,
1932 attributes->domain_parameters_size );
1933 if( ret != 0 )
1934 goto rsa_exit;
1935 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1936 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1937 rsa_exit:
1938 mbedtls_mpi_free( &actual );
1939 mbedtls_mpi_free( &required );
1940 if( ret != 0)
1941 return( mbedtls_to_psa_error( ret ) );
1942 }
1943 else
John Durkop9814fa22020-11-04 12:28:15 -08001944#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1945 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946 {
1947 return( PSA_ERROR_INVALID_ARGUMENT );
1948 }
1949 }
1950
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001951 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001952 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001953 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954 return( PSA_ERROR_INVALID_ARGUMENT );
1955 }
1956
1957 return( PSA_SUCCESS );
1958}
1959
Gilles Peskine4747d192019-04-17 15:05:45 +02001960psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001962 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001963 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001964{
1965 psa_status_t status;
1966 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001967 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001968 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001969
Ronald Cron81709fc2020-11-14 12:10:32 +01001970 *key = MBEDTLS_SVC_KEY_ID_INIT;
1971
Gilles Peskine0f84d622019-09-12 19:03:13 +02001972 /* Reject zero-length symmetric keys (including raw data key objects).
1973 * This also rejects any key which might be encoded as an empty string,
1974 * which is never valid. */
1975 if( data_length == 0 )
1976 return( PSA_ERROR_INVALID_ARGUMENT );
1977
Gilles Peskinedf179142019-07-15 22:02:14 +02001978 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001979 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001980 if( status != PSA_SUCCESS )
1981 goto exit;
1982
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001983 /* In the case of a transparent key or an opaque key stored in local
1984 * storage (thus not in the case of generating a key in a secure element
1985 * or cryptoprocessor with storage), we have to allocate a buffer to
1986 * hold the generated key material. */
1987 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001988 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001989 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001990 if( status != PSA_SUCCESS )
1991 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001992 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001993
1994 bits = slot->attr.bits;
1995 status = psa_driver_wrapper_import_key( attributes,
1996 data, data_length,
1997 slot->key.data,
1998 slot->key.bytes,
1999 &slot->key.bytes, &bits );
2000 if( status != PSA_SUCCESS )
2001 goto exit;
2002
2003 if( slot->attr.bits == 0 )
2004 slot->attr.bits = (psa_key_bits_t) bits;
2005 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002006 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002007 status = PSA_ERROR_INVALID_ARGUMENT;
2008 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002009 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002010
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002011 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002012 if( status != PSA_SUCCESS )
2013 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002014
Ronald Cron81709fc2020-11-14 12:10:32 +01002015 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002016exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002017 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002018 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002019
Gilles Peskine4747d192019-04-17 15:05:45 +02002020 return( status );
2021}
2022
Gilles Peskined7729582019-08-05 15:55:54 +02002023#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2024psa_status_t mbedtls_psa_register_se_key(
2025 const psa_key_attributes_t *attributes )
2026{
2027 psa_status_t status;
2028 psa_key_slot_t *slot = NULL;
2029 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002030 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002031
2032 /* Leaving attributes unspecified is not currently supported.
2033 * It could make sense to query the key type and size from the
2034 * secure element, but not all secure elements support this
2035 * and the driver HAL doesn't currently support it. */
2036 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2037 return( PSA_ERROR_NOT_SUPPORTED );
2038 if( psa_get_key_bits( attributes ) == 0 )
2039 return( PSA_ERROR_NOT_SUPPORTED );
2040
2041 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002042 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002043 if( status != PSA_SUCCESS )
2044 goto exit;
2045
Ronald Cron81709fc2020-11-14 12:10:32 +01002046 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002047
2048exit:
2049 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002050 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002051
Gilles Peskined7729582019-08-05 15:55:54 +02002052 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002053 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002054 return( status );
2055}
2056#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2057
Gilles Peskinef603c712019-01-19 13:40:11 +01002058static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002059 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002060{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002061 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002062 source->key.data,
2063 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002064 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002065 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002066
Steven Cooreman398aee52020-10-13 14:35:45 +02002067 target->attr.type = source->attr.type;
2068 target->attr.bits = source->attr.bits;
2069
2070 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002071}
2072
Ronald Croncf56a0a2020-08-04 09:51:30 +02002073psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002075 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002076{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002078 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002079 psa_key_slot_t *source_slot = NULL;
2080 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002081 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002082 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002083
Ronald Cron81709fc2020-11-14 12:10:32 +01002084 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2085
Ronald Cron5c522922020-11-14 16:35:34 +01002086 status = psa_get_and_lock_transparent_key_slot_with_policy(
2087 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002088 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002089 goto exit;
2090
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002091 status = psa_validate_optional_attributes( source_slot,
2092 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002093 if( status != PSA_SUCCESS )
2094 goto exit;
2095
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002096 status = psa_restrict_key_policy( source_slot->attr.type,
2097 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002098 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002099 if( status != PSA_SUCCESS )
2100 goto exit;
2101
Ronald Cron81709fc2020-11-14 12:10:32 +01002102 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2103 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002104 if( status != PSA_SUCCESS )
2105 goto exit;
2106
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002107#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2108 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002109 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002110 /* Copying to a secure element is not implemented yet. */
2111 status = PSA_ERROR_NOT_SUPPORTED;
2112 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002113 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002114#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002115
Ronald Cron6cc66312021-04-02 12:27:47 +02002116 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2117 {
2118 /*
2119 * Copying through an opaque driver is not implemented yet, consider
2120 * a lifetime with an external location as an invalid parameter for
2121 * now.
2122 */
2123 status = PSA_ERROR_INVALID_ARGUMENT;
2124 goto exit;
2125 }
2126
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002127 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002128 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002129 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002130
Ronald Cron81709fc2020-11-14 12:10:32 +01002131 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002132exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002133 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002134 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002135
Ronald Cron5c522922020-11-14 16:35:34 +01002136 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002137
Ronald Cron5c522922020-11-14 16:35:34 +01002138 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002139}
2140
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002141
2142
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002143/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002144/* Message digests */
2145/****************************************************************/
2146
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2148{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002149 /* Aborting a non-active operation is allowed */
2150 if( operation->id == 0 )
2151 return( PSA_SUCCESS );
2152
2153 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2154 operation->id = 0;
2155
2156 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002157}
2158
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002159psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002160 psa_algorithm_t alg )
2161{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002162 /* A context must be freshly initialized before it can be set up. */
2163 if( operation->id != 0 )
2164 return( PSA_ERROR_BAD_STATE );
2165
2166 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002167 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002168
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002169 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2170 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002171 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2172
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002173 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002174}
2175
2176psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2177 const uint8_t *input,
2178 size_t input_length )
2179{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002180 if( operation->id == 0 )
2181 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002182
Steven Cooremanc8288352021-03-04 14:02:19 +01002183 /* Don't require hash implementations to behave correctly on a
2184 * zero-length input, which may have an invalid pointer. */
2185 if( input_length == 0 )
2186 return( PSA_SUCCESS );
2187
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002188 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2189 input, input_length );
2190 if( status != PSA_SUCCESS )
2191 psa_hash_abort( operation );
2192
2193 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194}
2195
2196psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2197 uint8_t *hash,
2198 size_t hash_size,
2199 size_t *hash_length )
2200{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002201 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002202 if( operation->id == 0 )
2203 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002204
Steven Cooreman1e582352021-02-18 17:24:37 +01002205 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002206 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002207 psa_hash_abort( operation );
2208 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002209}
2210
Gilles Peskine2d277862018-06-18 15:41:12 +02002211psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2212 const uint8_t *hash,
2213 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002214{
2215 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2216 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002217 psa_status_t status = psa_hash_finish(
2218 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002219 actual_hash, sizeof( actual_hash ),
2220 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221 if( status != PSA_SUCCESS )
2222 return( status );
2223 if( actual_hash_length != hash_length )
2224 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooremana2a1b802021-04-29 16:37:59 +02002225 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002226 return( PSA_ERROR_INVALID_SIGNATURE );
2227 return( PSA_SUCCESS );
2228}
2229
Gilles Peskine0a749c82019-11-28 19:33:58 +01002230psa_status_t psa_hash_compute( psa_algorithm_t alg,
2231 const uint8_t *input, size_t input_length,
2232 uint8_t *hash, size_t hash_size,
2233 size_t *hash_length )
2234{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002235 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002236 if( !PSA_ALG_IS_HASH( alg ) )
2237 return( PSA_ERROR_INVALID_ARGUMENT );
2238
Steven Cooreman1e582352021-02-18 17:24:37 +01002239 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2240 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002241}
2242
2243psa_status_t psa_hash_compare( psa_algorithm_t alg,
2244 const uint8_t *input, size_t input_length,
2245 const uint8_t *hash, size_t hash_length )
2246{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002247 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2248 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002249
2250 if( !PSA_ALG_IS_HASH( alg ) )
2251 return( PSA_ERROR_INVALID_ARGUMENT );
2252
Steven Cooreman1e582352021-02-18 17:24:37 +01002253 psa_status_t status = psa_driver_wrapper_hash_compute(
2254 alg, input, input_length,
2255 actual_hash, sizeof(actual_hash),
2256 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002257 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002258 return( status );
2259 if( actual_hash_length != hash_length )
2260 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooremana2a1b802021-04-29 16:37:59 +02002261 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002262 return( PSA_ERROR_INVALID_SIGNATURE );
2263 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002264}
2265
Gilles Peskineeb35d782019-01-22 17:56:16 +01002266psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2267 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002268{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002269 if( source_operation->id == 0 ||
2270 target_operation->id != 0 )
2271 {
2272 return( PSA_ERROR_BAD_STATE );
2273 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002274
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002275 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2276 target_operation );
2277 if( status != PSA_SUCCESS )
2278 psa_hash_abort( target_operation );
2279
2280 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002281}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002282
2283
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002284/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002285/* MAC */
2286/****************************************************************/
2287
Steven Cooreman07897832021-03-19 18:28:56 +01002288psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002289{
Steven Cooreman07897832021-03-19 18:28:56 +01002290 /* Aborting a non-active operation is allowed */
2291 if( operation->id == 0 )
2292 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002293
Steven Cooreman07897832021-03-19 18:28:56 +01002294 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002295 operation->mac_size = 0;
2296 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002297 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002298
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002299 return( status );
2300}
2301
Ronald Cron1c650a12021-06-17 16:33:22 +02002302static psa_status_t psa_mac_finalize_alg_and_key_validation(
2303 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002304 const psa_key_attributes_t *attributes,
2305 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002306{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002307 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondef68e72021-06-17 16:46:44 +02002308 psa_key_type_t key_type = psa_get_key_type( attributes );
2309 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002310
Ronald Cron48f875e2021-06-17 16:10:24 +02002311 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Crondef68e72021-06-17 16:46:44 +02002312 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman07897832021-03-19 18:28:56 +01002313
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002314 /* Validate the combination of key type and algorithm */
Ronald Crondef68e72021-06-17 16:46:44 +02002315 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002316 if( status != PSA_SUCCESS )
Ronald Crondef68e72021-06-17 16:46:44 +02002317 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002318
Steven Cooremana6474de2021-05-10 11:13:41 +02002319 /* Get the output length for the algorithm and key combination */
Ronald Crondef68e72021-06-17 16:46:44 +02002320 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002321
Ronald Crondef68e72021-06-17 16:46:44 +02002322 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002323 {
2324 /* A very short MAC is too short for security since it can be
2325 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2326 * so we make this our minimum, even though 32 bits is still
2327 * too small for security. */
Ronald Crondef68e72021-06-17 16:46:44 +02002328 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002329 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002330
Ronald Crondef68e72021-06-17 16:46:44 +02002331 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2332 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002333 {
2334 /* It's impossible to "truncate" to a larger length than the full length
2335 * of the algorithm. */
Ronald Crondef68e72021-06-17 16:46:44 +02002336 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002337 }
2338
Ronald Crondef68e72021-06-17 16:46:44 +02002339 return( PSA_SUCCESS );
Ronald Cron1c650a12021-06-17 16:33:22 +02002340}
2341
2342static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2343 mbedtls_svc_key_id_t key,
2344 psa_algorithm_t alg,
2345 int is_sign )
2346{
2347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2348 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2349 psa_key_slot_t *slot;
2350
2351 /* A context must be freshly initialized before it can be set up. */
2352 if( operation->id != 0 )
2353 return( PSA_ERROR_BAD_STATE );
2354
2355 status = psa_get_and_lock_key_slot_with_policy(
2356 key,
2357 &slot,
2358 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2359 alg );
2360 if( status != PSA_SUCCESS )
2361 return( status );
2362
2363 psa_key_attributes_t attributes = {
2364 .core = slot->attr
2365 };
2366
Ronald Crondef68e72021-06-17 16:46:44 +02002367 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2368 &operation->mac_size );
Ronald Cron1c650a12021-06-17 16:33:22 +02002369 if( status != PSA_SUCCESS )
2370 goto exit;
2371
2372 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002373 /* Dispatch the MAC setup call with validated input */
2374 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002375 {
Steven Cooreman07897832021-03-19 18:28:56 +01002376 status = psa_driver_wrapper_mac_sign_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002377 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002378 slot->key.data,
2379 slot->key.bytes,
2380 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002381 }
2382 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002383 {
Steven Cooreman07897832021-03-19 18:28:56 +01002384 status = psa_driver_wrapper_mac_verify_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002385 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002386 slot->key.data,
2387 slot->key.bytes,
2388 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002389 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002390
Gilles Peskinefbfac682018-07-08 20:51:54 +02002391exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002392 if( status != PSA_SUCCESS )
Steven Cooreman07897832021-03-19 18:28:56 +01002393 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002394
Ronald Cron5c522922020-11-14 16:35:34 +01002395 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002396
Ronald Cron5c522922020-11-14 16:35:34 +01002397 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002398}
2399
Gilles Peskine89167cb2018-07-08 20:12:23 +02002400psa_status_t psa_mac_sign_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, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002405}
2406
2407psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002408 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002409 psa_algorithm_t alg )
2410{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002411 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002412}
2413
Steven Cooreman11743f92021-03-19 18:38:46 +01002414psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002415 const uint8_t *input,
2416 size_t input_length )
2417{
Steven Cooreman11743f92021-03-19 18:38:46 +01002418 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002419 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420
Steven Cooreman11743f92021-03-19 18:38:46 +01002421 /* Don't require hash implementations to behave correctly on a
2422 * zero-length input, which may have an invalid pointer. */
2423 if( input_length == 0 )
2424 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002425
Steven Cooreman11743f92021-03-19 18:38:46 +01002426 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2427 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002428 if( status != PSA_SUCCESS )
Steven Cooreman11743f92021-03-19 18:38:46 +01002429 psa_mac_abort( operation );
2430
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002431 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002432}
2433
Steven Cooreman87885df2021-03-19 19:04:39 +01002434psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002435 uint8_t *mac,
2436 size_t mac_size,
2437 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002438{
Steven Cooreman87885df2021-03-19 19:04:39 +01002439 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2440 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002441
Steven Cooreman15f0d922021-05-07 14:14:37 +02002442 /* Set the output length and content to a safe default, such that in
2443 * case the caller misses an error check, the output would be an
2444 * unachievable MAC. */
2445 *mac_length = mac_size;
2446
Steven Cooreman87885df2021-03-19 19:04:39 +01002447 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002448 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002449
Steven Cooreman15f0d922021-05-07 14:14:37 +02002450 if( ! operation->is_sign )
2451 return( PSA_ERROR_BAD_STATE );
2452
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002453 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2454 * once all the error checks are done. */
2455 if( operation->mac_size == 0 )
2456 return( PSA_ERROR_BAD_STATE );
2457
2458 if( mac_size < operation->mac_size )
Steven Cooreman15f0d922021-05-07 14:14:37 +02002459 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002460
Steven Cooreman87885df2021-03-19 19:04:39 +01002461 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman15f0d922021-05-07 14:14:37 +02002462 mac, operation->mac_size,
2463 mac_length );
2464
Ronald Cron882eb782021-06-18 13:05:48 +02002465 /* In case of success, set the potential excess room in the output buffer
2466 * to an invalid value, to avoid potentially leaking a longer MAC.
2467 * In case of error, set the output length and content to a safe default,
2468 * such that in case the caller misses an error check, the output would be
2469 * an unachievable MAC.
2470 */
2471 if( status != PSA_SUCCESS )
Steven Cooreman15f0d922021-05-07 14:14:37 +02002472 {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002473 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002474 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002475 }
mohammad16036df908f2018-04-02 08:34:15 -07002476
Ronald Cron882eb782021-06-18 13:05:48 +02002477 if( mac_size > operation->mac_size )
2478 memset( &mac[operation->mac_size], '!',
2479 mac_size - operation->mac_size );
2480
Steven Cooreman87885df2021-03-19 19:04:39 +01002481 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002482
Steven Cooreman87885df2021-03-19 19:04:39 +01002483 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002484}
2485
Steven Cooreman87885df2021-03-19 19:04:39 +01002486psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002487 const uint8_t *mac,
2488 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002489{
Steven Cooreman87885df2021-03-19 19:04:39 +01002490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2491 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002492
Steven Cooreman87885df2021-03-19 19:04:39 +01002493 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002494 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002495
Steven Cooreman15f0d922021-05-07 14:14:37 +02002496 if( operation->is_sign )
2497 return( PSA_ERROR_BAD_STATE );
2498
2499 if( operation->mac_size != mac_length )
2500 {
2501 status = PSA_ERROR_INVALID_SIGNATURE;
2502 goto cleanup;
2503 }
2504
Steven Cooreman87885df2021-03-19 19:04:39 +01002505 status = psa_driver_wrapper_mac_verify_finish( operation,
2506 mac, mac_length );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002507
2508cleanup:
Steven Cooreman87885df2021-03-19 19:04:39 +01002509 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002510
Steven Cooreman87885df2021-03-19 19:04:39 +01002511 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002512}
2513
Ronald Cronef0d8f12021-06-18 14:23:33 +02002514static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2515 psa_algorithm_t alg,
2516 const uint8_t *input,
2517 size_t input_length,
2518 uint8_t *mac,
2519 size_t mac_size,
2520 size_t *mac_length,
2521 int is_sign )
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002522{
2523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002524 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2525 psa_key_slot_t *slot;
2526 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002527
Ronald Crondbb86462021-06-17 17:17:20 +02002528 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cronef0d8f12021-06-18 14:23:33 +02002529 key, &slot,
2530 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2531 alg );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002532 if( status != PSA_SUCCESS )
2533 goto exit;
2534
Ronald Crondbb86462021-06-17 17:17:20 +02002535 psa_key_attributes_t attributes = {
2536 .core = slot->attr
2537 };
2538
2539 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2540 &operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002541 if( status != PSA_SUCCESS )
2542 goto exit;
2543
Ronald Crondbb86462021-06-17 17:17:20 +02002544 if( mac_size < operation_mac_size )
2545 {
2546 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002547 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002548 }
2549
2550 status = psa_driver_wrapper_mac_compute(
2551 &attributes,
2552 slot->key.data, slot->key.bytes,
2553 alg,
2554 input, input_length,
2555 mac, operation_mac_size, mac_length );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002556
2557exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002558 /* In case of success, set the potential excess room in the output buffer
2559 * to an invalid value, to avoid potentially leaking a longer MAC.
2560 * In case of error, set the output length and content to a safe default,
2561 * such that in case the caller misses an error check, the output would be
2562 * an unachievable MAC.
2563 */
2564 if( status != PSA_SUCCESS )
Ronald Crondbb86462021-06-17 17:17:20 +02002565 {
Ronald Crondbb86462021-06-17 17:17:20 +02002566 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002567 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002568 }
Ronald Cron882eb782021-06-18 13:05:48 +02002569 if( mac_size > operation_mac_size )
2570 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002571
Ronald Crondbb86462021-06-17 17:17:20 +02002572 unlock_status = psa_unlock_key_slot( slot );
2573
2574 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002575}
2576
Ronald Cronef0d8f12021-06-18 14:23:33 +02002577psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2578 psa_algorithm_t alg,
2579 const uint8_t *input,
2580 size_t input_length,
2581 uint8_t *mac,
2582 size_t mac_size,
2583 size_t *mac_length)
2584{
2585 return( psa_mac_compute_internal( key, alg,
2586 input, input_length,
2587 mac, mac_size, mac_length, 1 ) );
2588}
2589
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002590psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2591 psa_algorithm_t alg,
2592 const uint8_t *input,
2593 size_t input_length,
2594 const uint8_t *mac,
2595 size_t mac_length)
2596{
2597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002598 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2599 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002600
Ronald Cron4ed83682021-06-18 14:51:29 +02002601 status = psa_mac_compute_internal( key, alg,
2602 input, input_length,
2603 actual_mac, sizeof( actual_mac ),
2604 &actual_mac_length, 0 );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002605 if( status != PSA_SUCCESS )
2606 goto exit;
2607
Ronald Cron4ed83682021-06-18 14:51:29 +02002608 if( mac_length != actual_mac_length )
2609 {
2610 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002611 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002612 }
2613 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2614 {
2615 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002616 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002617 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002618
2619exit:
Ronald Cron4ed83682021-06-18 14:51:29 +02002620 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002621
2622 return ( status );
2623}
Gilles Peskine20035e32018-02-03 22:44:14 +01002624
Gilles Peskine20035e32018-02-03 22:44:14 +01002625/****************************************************************/
2626/* Asymmetric cryptography */
2627/****************************************************************/
2628
gabor-mezei-armc9795782021-05-12 11:03:09 +02002629static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm56980482021-05-05 13:56:27 +02002630 psa_algorithm_t alg )
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002631{
gabor-mezei-armc9795782021-05-12 11:03:09 +02002632 if( input_is_message )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002633 {
2634 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2635 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002636
gabor-mezei-arm56980482021-05-05 13:56:27 +02002637 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2638 {
2639 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2640 return( PSA_ERROR_INVALID_ARGUMENT );
2641 }
2642 }
2643 else
2644 {
2645 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2646 return( PSA_ERROR_INVALID_ARGUMENT );
2647 }
2648
2649 return( PSA_SUCCESS );
2650}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002651
2652static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002653 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002654 psa_algorithm_t alg,
2655 const uint8_t * input,
2656 size_t input_length,
2657 uint8_t * signature,
2658 size_t signature_size,
2659 size_t * signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002660{
2661 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2662 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2663 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002664
2665 *signature_length = 0;
2666
gabor-mezei-armc9795782021-05-12 11:03:09 +02002667 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002668 if( status != PSA_SUCCESS )
2669 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002670
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002671 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002672 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002673 * buffer can in principle be empty since it doesn't actually have
2674 * to be a hash.) */
2675 if( signature_size == 0 )
2676 return( PSA_ERROR_BUFFER_TOO_SMALL );
2677
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002678 status = psa_get_and_lock_key_slot_with_policy(
2679 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002680 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2681 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002682 alg );
2683
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002684 if( status != PSA_SUCCESS )
2685 goto exit;
2686
2687 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2688 {
2689 status = PSA_ERROR_INVALID_ARGUMENT;
2690 goto exit;
2691 }
2692
2693 psa_key_attributes_t attributes = {
2694 .core = slot->attr
2695 };
2696
gabor-mezei-armc9795782021-05-12 11:03:09 +02002697 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002698 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002699 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002700 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002701 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002702 signature, signature_size, signature_length );
2703 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002704 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002705 {
2706
2707 status = psa_driver_wrapper_sign_hash(
2708 &attributes, slot->key.data, slot->key.bytes,
2709 alg, input, input_length,
2710 signature, signature_size, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002711 }
2712
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002713
2714exit:
2715 /* Fill the unused part of the output buffer (the whole buffer on error,
2716 * the trailing part on success) with something that isn't a valid signature
2717 * (barring an attack on the signature and deliberately-crafted input),
2718 * in case the caller doesn't check the return status properly. */
2719 if( status == PSA_SUCCESS )
2720 memset( signature + *signature_length, '!',
2721 signature_size - *signature_length );
2722 else
2723 memset( signature, '!', signature_size );
2724 /* If signature_size is 0 then we have nothing to do. We must not call
2725 * memset because signature may be NULL in this case. */
2726
2727 unlock_status = psa_unlock_key_slot( slot );
2728
2729 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2730}
2731
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002732static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002733 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002734 psa_algorithm_t alg,
2735 const uint8_t * input,
2736 size_t input_length,
2737 const uint8_t * signature,
2738 size_t signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002739{
2740 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2741 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2742 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002743
gabor-mezei-armc9795782021-05-12 11:03:09 +02002744 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002745 if( status != PSA_SUCCESS )
2746 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002747
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002748 status = psa_get_and_lock_key_slot_with_policy(
2749 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002750 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2751 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002752 alg );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002753
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002754 if( status != PSA_SUCCESS )
2755 return( status );
2756
2757 psa_key_attributes_t attributes = {
2758 .core = slot->attr
2759 };
2760
gabor-mezei-armc9795782021-05-12 11:03:09 +02002761 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002762 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002763 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002764 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002765 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002766 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002767 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002768 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002769 {
2770 status = psa_driver_wrapper_verify_hash(
2771 &attributes, slot->key.data, slot->key.bytes,
2772 alg, input, input_length,
2773 signature, signature_length );
2774 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002775
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002776 unlock_status = psa_unlock_key_slot( slot );
2777
2778 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002779
2780}
2781
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002782psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002783 const psa_key_attributes_t *attributes,
2784 const uint8_t *key_buffer,
2785 size_t key_buffer_size,
2786 psa_algorithm_t alg,
2787 const uint8_t *input,
2788 size_t input_length,
2789 uint8_t *signature,
2790 size_t signature_size,
2791 size_t *signature_length )
2792{
2793 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002794
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002795 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2796 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002797 size_t hash_length;
2798 uint8_t hash[PSA_HASH_MAX_SIZE];
2799
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002800 status = psa_driver_wrapper_hash_compute(
2801 PSA_ALG_SIGN_GET_HASH( alg ),
2802 input, input_length,
2803 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002804
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002805 if( status != PSA_SUCCESS )
2806 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002807
2808 return psa_driver_wrapper_sign_hash(
2809 attributes, key_buffer, key_buffer_size,
2810 alg, hash, hash_length,
2811 signature, signature_size, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002812 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002813
gabor-mezei-arm56980482021-05-05 13:56:27 +02002814 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002815}
2816
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002817psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2818 psa_algorithm_t alg,
2819 const uint8_t * input,
2820 size_t input_length,
2821 uint8_t * signature,
2822 size_t signature_size,
2823 size_t * signature_length )
2824{
2825 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002826 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002827 signature, signature_size, signature_length );
2828}
2829
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002830psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002831 const psa_key_attributes_t *attributes,
2832 const uint8_t *key_buffer,
2833 size_t key_buffer_size,
2834 psa_algorithm_t alg,
2835 const uint8_t *input,
2836 size_t input_length,
2837 const uint8_t *signature,
2838 size_t signature_length )
2839{
2840 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002841
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002842 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2843 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002844 size_t hash_length;
2845 uint8_t hash[PSA_HASH_MAX_SIZE];
2846
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002847 status = psa_driver_wrapper_hash_compute(
2848 PSA_ALG_SIGN_GET_HASH( alg ),
2849 input, input_length,
2850 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002851
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002852 if( status != PSA_SUCCESS )
2853 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002854
2855 return psa_driver_wrapper_verify_hash(
2856 attributes, key_buffer, key_buffer_size,
2857 alg, hash, hash_length,
2858 signature, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002859 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002860
gabor-mezei-armef6f2aa2021-05-05 13:59:01 +02002861 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002862}
2863
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002864psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2865 psa_algorithm_t alg,
2866 const uint8_t * input,
2867 size_t input_length,
2868 const uint8_t * signature,
2869 size_t signature_length )
2870{
2871 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002872 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002873 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002874}
2875
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002876psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002877 const psa_key_attributes_t *attributes,
2878 const uint8_t *key_buffer, size_t key_buffer_size,
2879 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2880 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002881{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002882 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002883 {
Ronald Cron4501c982021-03-19 20:09:32 +01002884 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2885 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002886 {
Ronald Cron4501c982021-03-19 20:09:32 +01002887#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2888 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2889 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002890 attributes,
2891 key_buffer, key_buffer_size,
2892 alg, hash, hash_length,
2893 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002894#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2895 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002896 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002897 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002898 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002899 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002900 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002901 }
2902 else
Ronald Cron4501c982021-03-19 20:09:32 +01002903 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2904 {
2905 if( PSA_ALG_IS_ECDSA( alg ) )
2906 {
2907#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2908 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2909 return( mbedtls_psa_ecdsa_sign_hash(
2910 attributes,
2911 key_buffer, key_buffer_size,
2912 alg, hash, hash_length,
2913 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002914#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2915 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002916 }
2917 else
2918 {
2919 return( PSA_ERROR_INVALID_ARGUMENT );
2920 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002921 }
Ronald Cron4501c982021-03-19 20:09:32 +01002922
2923 (void)key_buffer;
2924 (void)key_buffer_size;
2925 (void)hash;
2926 (void)hash_length;
2927 (void)signature;
2928 (void)signature_size;
2929 (void)signature_length;
2930
2931 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002932}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002933
2934psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2935 psa_algorithm_t alg,
2936 const uint8_t *hash,
2937 size_t hash_length,
2938 uint8_t *signature,
2939 size_t signature_size,
2940 size_t *signature_length )
2941{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002942 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002943 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002944 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002945}
2946
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002947psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002948 const psa_key_attributes_t *attributes,
2949 const uint8_t *key_buffer, size_t key_buffer_size,
2950 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2951 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002952{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002953 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002954 {
Ronald Cron4501c982021-03-19 20:09:32 +01002955 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2956 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002957 {
Ronald Cron4501c982021-03-19 20:09:32 +01002958#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2959 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2960 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002961 attributes,
2962 key_buffer, key_buffer_size,
2963 alg, hash, hash_length,
2964 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002965#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2966 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002967 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002968 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002969 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002970 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002971 }
itayzafrir5c753392018-05-08 11:18:38 +03002972 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002973 else
Ronald Cron4501c982021-03-19 20:09:32 +01002974 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002975 {
Ronald Cron4501c982021-03-19 20:09:32 +01002976 if( PSA_ALG_IS_ECDSA( alg ) )
2977 {
2978#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2979 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2980 return( mbedtls_psa_ecdsa_verify_hash(
2981 attributes,
2982 key_buffer, key_buffer_size,
2983 alg, hash, hash_length,
2984 signature, signature_length ) );
2985#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2986 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2987 }
2988 else
2989 {
2990 return( PSA_ERROR_INVALID_ARGUMENT );
2991 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002992 }
Ronald Cron4501c982021-03-19 20:09:32 +01002993
2994 (void)key_buffer;
2995 (void)key_buffer_size;
2996 (void)hash;
2997 (void)hash_length;
2998 (void)signature;
2999 (void)signature_length;
3000
3001 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003002}
3003
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003004psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3005 psa_algorithm_t alg,
3006 const uint8_t *hash,
3007 size_t hash_length,
3008 const uint8_t *signature,
3009 size_t signature_length )
3010{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003011 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003012 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003013 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003014}
3015
John Durkop0e005192020-10-31 22:06:54 -07003016#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003017static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3018 mbedtls_rsa_context *rsa )
3019{
3020 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3021 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3022 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3023 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3024}
John Durkop0e005192020-10-31 22:06:54 -07003025#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003026
Ronald Croncf56a0a2020-08-04 09:51:30 +02003027psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003028 psa_algorithm_t alg,
3029 const uint8_t *input,
3030 size_t input_length,
3031 const uint8_t *salt,
3032 size_t salt_length,
3033 uint8_t *output,
3034 size_t output_size,
3035 size_t *output_length )
3036{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003037 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003038 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003039 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003040
Darryl Green5cc689a2018-07-24 15:34:10 +01003041 (void) input;
3042 (void) input_length;
3043 (void) salt;
3044 (void) output;
3045 (void) output_size;
3046
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003047 *output_length = 0;
3048
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003049 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3050 return( PSA_ERROR_INVALID_ARGUMENT );
3051
Ronald Cron5c522922020-11-14 16:35:34 +01003052 status = psa_get_and_lock_transparent_key_slot_with_policy(
3053 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003054 if( status != PSA_SUCCESS )
3055 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003056 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3057 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003058 {
3059 status = PSA_ERROR_INVALID_ARGUMENT;
3060 goto exit;
3061 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003062
John Durkop6ba40d12020-11-10 08:50:04 -08003063#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3064 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003065 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003066 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003067 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003068 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3069 slot->key.data,
3070 slot->key.bytes,
3071 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003072 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003073 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003074
3075 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003076 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003077 status = PSA_ERROR_BUFFER_TOO_SMALL;
3078 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003079 }
John Durkop0e005192020-10-31 22:06:54 -07003080#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003081 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3082 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003083 status = mbedtls_to_psa_error(
3084 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003085 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003086 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003087 MBEDTLS_RSA_PUBLIC,
3088 input_length,
3089 input,
3090 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003091 }
3092 else
John Durkop0e005192020-10-31 22:06:54 -07003093#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3094#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003095 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3096 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003097 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003098 status = mbedtls_to_psa_error(
3099 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003100 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003101 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003102 MBEDTLS_RSA_PUBLIC,
3103 salt, salt_length,
3104 input_length,
3105 input,
3106 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003107 }
3108 else
John Durkop0e005192020-10-31 22:06:54 -07003109#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003110 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003111 status = PSA_ERROR_INVALID_ARGUMENT;
3112 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003113 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003114rsa_exit:
3115 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003116 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003117
Steven Cooremana2371e52020-07-28 14:30:39 +02003118 mbedtls_rsa_free( rsa );
3119 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121 else
John Durkop9814fa22020-11-04 12:28:15 -08003122#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003123 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003125 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003126 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003127
3128exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003129 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003130
Ronald Cron5c522922020-11-14 16:35:34 +01003131 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003132}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133
Ronald Croncf56a0a2020-08-04 09:51:30 +02003134psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003135 psa_algorithm_t alg,
3136 const uint8_t *input,
3137 size_t input_length,
3138 const uint8_t *salt,
3139 size_t salt_length,
3140 uint8_t *output,
3141 size_t output_size,
3142 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003143{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003144 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003145 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003146 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003147
Darryl Green5cc689a2018-07-24 15:34:10 +01003148 (void) input;
3149 (void) input_length;
3150 (void) salt;
3151 (void) output;
3152 (void) output_size;
3153
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003154 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003155
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003156 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3157 return( PSA_ERROR_INVALID_ARGUMENT );
3158
Ronald Cron5c522922020-11-14 16:35:34 +01003159 status = psa_get_and_lock_transparent_key_slot_with_policy(
3160 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003161 if( status != PSA_SUCCESS )
3162 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003163 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003164 {
3165 status = PSA_ERROR_INVALID_ARGUMENT;
3166 goto exit;
3167 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168
John Durkop6ba40d12020-11-10 08:50:04 -08003169#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3170 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003171 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003172 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003173 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003174 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3175 slot->key.data,
3176 slot->key.bytes,
3177 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003178 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003179 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003180
Steven Cooremana2371e52020-07-28 14:30:39 +02003181 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003182 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003183 status = PSA_ERROR_INVALID_ARGUMENT;
3184 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003185 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003186
John Durkop0e005192020-10-31 22:06:54 -07003187#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003188 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003189 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003190 status = mbedtls_to_psa_error(
3191 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003192 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003193 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003194 MBEDTLS_RSA_PRIVATE,
3195 output_length,
3196 input,
3197 output,
3198 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003199 }
3200 else
John Durkop0e005192020-10-31 22:06:54 -07003201#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3202#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003203 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003204 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003205 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003206 status = mbedtls_to_psa_error(
3207 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003208 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003209 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003210 MBEDTLS_RSA_PRIVATE,
3211 salt, salt_length,
3212 output_length,
3213 input,
3214 output,
3215 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003216 }
3217 else
John Durkop0e005192020-10-31 22:06:54 -07003218#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003220 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003221 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003222
Steven Cooreman4fed4552020-08-03 14:46:03 +02003223rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003224 mbedtls_rsa_free( rsa );
3225 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003226 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003227 else
John Durkop6ba40d12020-11-10 08:50:04 -08003228#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3229 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003230 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003231 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003232 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003233
3234exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003235 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003236
Ronald Cron5c522922020-11-14 16:35:34 +01003237 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003238}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003239
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003240
3241
mohammad1603503973b2018-03-12 15:59:30 +02003242/****************************************************************/
3243/* Symmetric cryptography */
3244/****************************************************************/
3245
Ronald Cronab99ac22020-10-01 16:38:28 +02003246static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3247 mbedtls_svc_key_id_t key,
3248 psa_algorithm_t alg,
3249 mbedtls_operation_t cipher_operation )
3250{
3251 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3252 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3253 psa_key_slot_t *slot;
3254 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3255 PSA_KEY_USAGE_ENCRYPT :
3256 PSA_KEY_USAGE_DECRYPT );
3257
3258 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003259 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003260 return( PSA_ERROR_BAD_STATE );
3261
3262 /* The requested algorithm must be one that can be processed by cipher. */
3263 if( ! PSA_ALG_IS_CIPHER( alg ) )
3264 return( PSA_ERROR_INVALID_ARGUMENT );
3265
3266 /* Fetch key material from key storage. */
3267 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3268 if( status != PSA_SUCCESS )
3269 goto exit;
3270
Ronald Cron49fafa92021-03-10 08:34:23 +01003271 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003272 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003273 * so we only set it (in the driver wrapper) after resources have been
3274 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003275 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003276 if( alg == PSA_ALG_ECB_NO_PADDING )
3277 operation->iv_required = 0;
3278 else
3279 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003280 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003281
Ronald Crona4af55f2020-12-14 14:36:06 +01003282 psa_key_attributes_t attributes = {
3283 .core = slot->attr
3284 };
3285
Ronald Cronab99ac22020-10-01 16:38:28 +02003286 /* Try doing the operation through a driver before using software fallback. */
3287 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003288 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3289 &attributes,
3290 slot->key.data,
3291 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003292 alg );
3293 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003294 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3295 &attributes,
3296 slot->key.data,
3297 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003298 alg );
3299
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003300exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003301 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003302 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003303
Ronald Cron5c522922020-11-14 16:35:34 +01003304 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003305
Ronald Cron5c522922020-11-14 16:35:34 +01003306 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003307}
3308
Gilles Peskinefe119512018-07-08 21:39:34 +02003309psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003310 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003311 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003312{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003313 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003314}
3315
Gilles Peskinefe119512018-07-08 21:39:34 +02003316psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003317 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003318 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003319{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003320 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003321}
3322
Gilles Peskinefe119512018-07-08 21:39:34 +02003323psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003324 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003325 size_t iv_size,
3326 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003327{
Ronald Cron6d051732020-10-01 14:10:20 +02003328 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003329
Ronald Cron5618a392021-03-26 09:52:26 +01003330 *iv_length = 0;
3331
Ronald Cron49fafa92021-03-10 08:34:23 +01003332 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003333 {
3334 return( PSA_ERROR_BAD_STATE );
3335 }
3336
Steven Cooreman7df02922020-09-09 15:28:49 +02003337 if( operation->iv_set || ! operation->iv_required )
3338 {
3339 return( PSA_ERROR_BAD_STATE );
3340 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003341
Ronald Cron5618a392021-03-26 09:52:26 +01003342 if( iv_size < operation->default_iv_length )
3343 {
3344 status = PSA_ERROR_BUFFER_TOO_SMALL;
3345 goto exit;
3346 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003347
Ronald Cron5618a392021-03-26 09:52:26 +01003348 status = psa_generate_random( iv, operation->default_iv_length );
3349 if( status != PSA_SUCCESS )
3350 goto exit;
3351
3352 status = psa_driver_wrapper_cipher_set_iv( operation,
3353 iv,
3354 operation->default_iv_length );
3355
3356exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003357 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003358 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003359 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003360 *iv_length = operation->default_iv_length;
3361 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003362 else
Moran Peker395db872018-05-31 14:07:14 +03003363 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003364
itayzafrir534bd7c2018-08-02 13:56:32 +03003365 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003366}
3367
Gilles Peskinefe119512018-07-08 21:39:34 +02003368psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003369 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003370 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003371{
Ronald Cron6d051732020-10-01 14:10:20 +02003372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003373
Ronald Cron49fafa92021-03-10 08:34:23 +01003374 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003375 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003376
Steven Cooreman7df02922020-09-09 15:28:49 +02003377 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003378 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003379
3380 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3381 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003382
Ronald Crondd24c9b2020-12-15 14:10:01 +01003383 status = psa_driver_wrapper_cipher_set_iv( operation,
3384 iv,
3385 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003386
itayzafrir534bd7c2018-08-02 13:56:32 +03003387 if( status == PSA_SUCCESS )
3388 operation->iv_set = 1;
3389 else
mohammad1603503973b2018-03-12 15:59:30 +02003390 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003391 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003392}
3393
Gilles Peskinee553c652018-06-04 16:22:46 +02003394psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3395 const uint8_t *input,
3396 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003397 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003398 size_t output_size,
3399 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003400{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003401 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003402
Ronald Cron49fafa92021-03-10 08:34:23 +01003403 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003404 {
3405 return( PSA_ERROR_BAD_STATE );
3406 }
3407 if( operation->iv_required && ! operation->iv_set )
3408 {
3409 return( PSA_ERROR_BAD_STATE );
3410 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003411
Ronald Crondd24c9b2020-12-15 14:10:01 +01003412 status = psa_driver_wrapper_cipher_update( operation,
3413 input,
3414 input_length,
3415 output,
3416 output_size,
3417 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003418 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003419 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003420
itayzafrir534bd7c2018-08-02 13:56:32 +03003421 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003422}
3423
Gilles Peskinee553c652018-06-04 16:22:46 +02003424psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3425 uint8_t *output,
3426 size_t output_size,
3427 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003428{
David Saadab4ecc272019-02-14 13:48:10 +02003429 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003430
Ronald Cron49fafa92021-03-10 08:34:23 +01003431 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003432 {
3433 return( PSA_ERROR_BAD_STATE );
3434 }
3435 if( operation->iv_required && ! operation->iv_set )
3436 {
3437 return( PSA_ERROR_BAD_STATE );
3438 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003439
Ronald Crondd24c9b2020-12-15 14:10:01 +01003440 status = psa_driver_wrapper_cipher_finish( operation,
3441 output,
3442 output_size,
3443 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003444 if( status == PSA_SUCCESS )
3445 return( psa_cipher_abort( operation ) );
3446 else
3447 {
3448 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003449 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003450
Steven Cooremanef8575e2020-09-11 11:44:50 +02003451 return( status );
3452 }
mohammad1603503973b2018-03-12 15:59:30 +02003453}
3454
Gilles Peskinee553c652018-06-04 16:22:46 +02003455psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3456{
Ronald Cron49fafa92021-03-10 08:34:23 +01003457 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003458 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003459 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003460 * in use. It's ok to call abort on such an object, and there's
3461 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003462 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003463 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003464
Ronald Crondd24c9b2020-12-15 14:10:01 +01003465 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003466
Ronald Cron49fafa92021-03-10 08:34:23 +01003467 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003468 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003469 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003470
Moran Peker395db872018-05-31 14:07:14 +03003471 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003472}
3473
mohammad16035955c982018-04-26 00:53:03 +03003474/****************************************************************/
3475/* AEAD */
3476/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003477
Ronald Croncf56a0a2020-08-04 09:51:30 +02003478psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003479 psa_algorithm_t alg,
3480 const uint8_t *nonce,
3481 size_t nonce_length,
3482 const uint8_t *additional_data,
3483 size_t additional_data_length,
3484 const uint8_t *plaintext,
3485 size_t plaintext_length,
3486 uint8_t *ciphertext,
3487 size_t ciphertext_size,
3488 size_t *ciphertext_length )
3489{
Ronald Cron215633c2021-03-16 17:15:37 +01003490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3491 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003492
mohammad1603f08a5502018-06-03 15:05:47 +03003493 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003494
Steven Cooremanea7ab132021-03-17 16:28:00 +01003495 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3496 return( PSA_ERROR_NOT_SUPPORTED );
3497
Ronald Cron9a986162021-03-26 12:40:07 +01003498 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003499 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003500 if( status != PSA_SUCCESS )
3501 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003502
Ronald Cron215633c2021-03-16 17:15:37 +01003503 psa_key_attributes_t attributes = {
3504 .core = slot->attr
3505 };
mohammad16035955c982018-04-26 00:53:03 +03003506
Ronald Cronde822812021-03-17 16:08:20 +01003507 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003508 &attributes, slot->key.data, slot->key.bytes,
3509 alg,
3510 nonce, nonce_length,
3511 additional_data, additional_data_length,
3512 plaintext, plaintext_length,
3513 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003514
Gilles Peskineedf9a652018-08-17 18:11:56 +02003515 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3516 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003517
Ronald Cron9f310172021-03-16 16:36:37 +01003518 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003519
mohammad16035955c982018-04-26 00:53:03 +03003520 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003521}
3522
Ronald Croncf56a0a2020-08-04 09:51:30 +02003523psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003524 psa_algorithm_t alg,
3525 const uint8_t *nonce,
3526 size_t nonce_length,
3527 const uint8_t *additional_data,
3528 size_t additional_data_length,
3529 const uint8_t *ciphertext,
3530 size_t ciphertext_length,
3531 uint8_t *plaintext,
3532 size_t plaintext_size,
3533 size_t *plaintext_length )
3534{
Ronald Cron215633c2021-03-16 17:15:37 +01003535 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3536 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003537
Gilles Peskineee652a32018-06-01 19:23:52 +02003538 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003539
Steven Cooremanea7ab132021-03-17 16:28:00 +01003540 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3541 return( PSA_ERROR_NOT_SUPPORTED );
3542
Ronald Cron9a986162021-03-26 12:40:07 +01003543 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003544 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003545 if( status != PSA_SUCCESS )
3546 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003547
Ronald Cron215633c2021-03-16 17:15:37 +01003548 psa_key_attributes_t attributes = {
3549 .core = slot->attr
3550 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003551
Ronald Cronde822812021-03-17 16:08:20 +01003552 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003553 &attributes, slot->key.data, slot->key.bytes,
3554 alg,
3555 nonce, nonce_length,
3556 additional_data, additional_data_length,
3557 ciphertext, ciphertext_length,
3558 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003559
Gilles Peskineedf9a652018-08-17 18:11:56 +02003560 if( status != PSA_SUCCESS && plaintext_size != 0 )
3561 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003562
Ronald Cron215633c2021-03-16 17:15:37 +01003563 psa_unlock_key_slot( slot );
3564
Gilles Peskineedf9a652018-08-17 18:11:56 +02003565 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003566}
3567
Gilles Peskinee59236f2018-01-27 23:32:46 +01003568/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003569/* Generators */
3570/****************************************************************/
3571
John Durkop07cc04a2020-11-16 22:08:34 -08003572#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3573 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3574 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3575#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003576#endif /* At least one builtin KDF */
3577
3578#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3579 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3580 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3581static psa_status_t psa_key_derivation_start_hmac(
3582 psa_mac_operation_t *operation,
3583 psa_algorithm_t hash_alg,
3584 const uint8_t *hmac_key,
3585 size_t hmac_key_length )
3586{
3587 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3588 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3589 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3590 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3591 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3592
Steven Cooreman15f0d922021-05-07 14:14:37 +02003593 operation->is_sign = 1;
3594 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3595
Steven Cooreman9878a162021-05-06 17:58:36 +02003596 status = psa_driver_wrapper_mac_sign_setup( operation,
3597 &attributes,
3598 hmac_key, hmac_key_length,
3599 PSA_ALG_HMAC( hash_alg ) );
3600
3601 psa_reset_key_attributes( &attributes );
3602 return( status );
3603}
3604#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003605
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003606#define HKDF_STATE_INIT 0 /* no input yet */
3607#define HKDF_STATE_STARTED 1 /* got salt */
3608#define HKDF_STATE_KEYED 2 /* got key */
3609#define HKDF_STATE_OUTPUT 3 /* output started */
3610
Gilles Peskinecbe66502019-05-16 16:59:18 +02003611static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003612 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003613{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003614 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3615 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003616 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003617 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003618}
3619
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003620psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003621{
3622 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003623 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003624 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003625 {
3626 /* The object has (apparently) been initialized but it is not
3627 * in use. It's ok to call abort on such an object, and there's
3628 * nothing to do. */
3629 }
3630 else
John Durkopd0321952020-10-29 21:37:36 -07003631#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003632 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003633 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003634 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003635 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003636 }
John Durkop07cc04a2020-11-16 22:08:34 -08003637 else
3638#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3639#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3640 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3641 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003642 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003643 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003644 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003645 if( operation->ctx.tls12_prf.secret != NULL )
3646 {
3647 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3648 operation->ctx.tls12_prf.secret_length );
3649 mbedtls_free( operation->ctx.tls12_prf.secret );
3650 }
3651
Janos Follath6a1d2622019-06-11 10:37:28 +01003652 if( operation->ctx.tls12_prf.seed != NULL )
3653 {
3654 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3655 operation->ctx.tls12_prf.seed_length );
3656 mbedtls_free( operation->ctx.tls12_prf.seed );
3657 }
3658
3659 if( operation->ctx.tls12_prf.label != NULL )
3660 {
3661 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3662 operation->ctx.tls12_prf.label_length );
3663 mbedtls_free( operation->ctx.tls12_prf.label );
3664 }
3665
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003666 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003667
3668 /* We leave the fields Ai and output_block to be erased safely by the
3669 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003670 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003671 else
John Durkop07cc04a2020-11-16 22:08:34 -08003672#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3673 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003674 {
3675 status = PSA_ERROR_BAD_STATE;
3676 }
Janos Follath083036a2019-06-11 10:22:26 +01003677 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003678 return( status );
3679}
3680
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003681psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003682 size_t *capacity)
3683{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003684 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003685 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003686 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003687 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003688 }
3689
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003690 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003691 return( PSA_SUCCESS );
3692}
3693
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003694psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003695 size_t capacity )
3696{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003697 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003698 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003699 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003700 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003701 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003702 return( PSA_SUCCESS );
3703}
3704
John Durkopd0321952020-10-29 21:37:36 -07003705#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003706/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003707 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003708static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremanb27e3502021-04-29 19:11:25 +02003709 psa_algorithm_t hash_alg,
3710 uint8_t *output,
3711 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003712{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003713 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003714 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003715 psa_status_t status;
3716
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003717 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3718 return( PSA_ERROR_BAD_STATE );
3719 hkdf->state = HKDF_STATE_OUTPUT;
3720
Gilles Peskinebef7f142018-07-12 17:22:21 +02003721 while( output_length != 0 )
3722 {
3723 /* Copy what remains of the current block */
3724 uint8_t n = hash_length - hkdf->offset_in_block;
3725 if( n > output_length )
3726 n = (uint8_t) output_length;
3727 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3728 output += n;
3729 output_length -= n;
3730 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003731 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003732 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003733 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003734 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003735 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003736 * object was corrupted or if this function is called directly
3737 * inside the library. */
3738 if( hkdf->block_number == 0xff )
3739 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003740
3741 /* We need a new block */
3742 ++hkdf->block_number;
3743 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02003744
Steven Cooreman9878a162021-05-06 17:58:36 +02003745 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3746 hash_alg,
3747 hkdf->prk,
3748 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003749 if( status != PSA_SUCCESS )
3750 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003751
Gilles Peskinebef7f142018-07-12 17:22:21 +02003752 if( hkdf->block_number != 1 )
3753 {
Steven Cooremanb27e3502021-04-29 19:11:25 +02003754 status = psa_mac_update( &hkdf->hmac,
3755 hkdf->output_block,
3756 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003757 if( status != PSA_SUCCESS )
3758 return( status );
3759 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02003760 status = psa_mac_update( &hkdf->hmac,
3761 hkdf->info,
3762 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003763 if( status != PSA_SUCCESS )
3764 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003765 status = psa_mac_update( &hkdf->hmac,
3766 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003767 if( status != PSA_SUCCESS )
3768 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003769 status = psa_mac_sign_finish( &hkdf->hmac,
3770 hkdf->output_block,
3771 sizeof( hkdf->output_block ),
3772 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003773 if( status != PSA_SUCCESS )
3774 return( status );
3775 }
3776
3777 return( PSA_SUCCESS );
3778}
John Durkop07cc04a2020-11-16 22:08:34 -08003779#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003780
John Durkop07cc04a2020-11-16 22:08:34 -08003781#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3782 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003783static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3784 psa_tls12_prf_key_derivation_t *tls12_prf,
3785 psa_algorithm_t alg )
3786{
3787 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003788 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003789 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3790 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003791 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003792
Janos Follath7742fee2019-06-17 12:58:10 +01003793 /* We can't be wanting more output after block 0xff, otherwise
3794 * the capacity check in psa_key_derivation_output_bytes() would have
3795 * prevented this call. It could happen only if the operation
3796 * object was corrupted or if this function is called directly
3797 * inside the library. */
3798 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003799 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003800
3801 /* We need a new block */
3802 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003803 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003804
3805 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3806 *
3807 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3808 *
3809 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3810 * HMAC_hash(secret, A(2) + seed) +
3811 * HMAC_hash(secret, A(3) + seed) + ...
3812 *
3813 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003814 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003815 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003816 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003817 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003818 * is currently extracted as `output_block` and where i is
3819 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003820 */
3821
Steven Cooreman9878a162021-05-06 17:58:36 +02003822 status = psa_key_derivation_start_hmac( &hmac,
3823 hash_alg,
3824 tls12_prf->secret,
3825 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003826 if( status != PSA_SUCCESS )
3827 goto cleanup;
3828
3829 /* Calculate A(i) where i = tls12_prf->block_number. */
3830 if( tls12_prf->block_number == 1 )
3831 {
3832 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3833 * the variable seed and in this instance means it in the context of the
3834 * P_hash function, where seed = label + seed.) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003835 status = psa_mac_update( &hmac,
3836 tls12_prf->label,
3837 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003838 if( status != PSA_SUCCESS )
3839 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003840 status = psa_mac_update( &hmac,
3841 tls12_prf->seed,
3842 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003843 if( status != PSA_SUCCESS )
3844 goto cleanup;
3845 }
3846 else
3847 {
3848 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003849 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003850 if( status != PSA_SUCCESS )
3851 goto cleanup;
3852 }
3853
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003854 status = psa_mac_sign_finish( &hmac,
3855 tls12_prf->Ai, hash_length,
3856 &hmac_output_length );
3857 if( hmac_output_length != hash_length )
3858 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003859 if( status != PSA_SUCCESS )
3860 goto cleanup;
3861
3862 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman9878a162021-05-06 17:58:36 +02003863 status = psa_key_derivation_start_hmac( &hmac,
3864 hash_alg,
3865 tls12_prf->secret,
3866 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003867 if( status != PSA_SUCCESS )
3868 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003869 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003870 if( status != PSA_SUCCESS )
3871 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003872 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003873 if( status != PSA_SUCCESS )
3874 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003875 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003876 if( status != PSA_SUCCESS )
3877 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003878 status = psa_mac_sign_finish( &hmac,
3879 tls12_prf->output_block, hash_length,
3880 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003881 if( status != PSA_SUCCESS )
3882 goto cleanup;
3883
Janos Follath7742fee2019-06-17 12:58:10 +01003884
3885cleanup:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003886 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003887 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3888 status = cleanup_status;
3889
3890 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003891}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003892
Janos Follath844eb0e2019-06-19 12:10:49 +01003893static psa_status_t psa_key_derivation_tls12_prf_read(
3894 psa_tls12_prf_key_derivation_t *tls12_prf,
3895 psa_algorithm_t alg,
3896 uint8_t *output,
3897 size_t output_length )
3898{
3899 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003900 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003901 psa_status_t status;
3902 uint8_t offset, length;
3903
Gilles Peskinef216f0d2021-06-11 22:41:46 +02003904 switch( tls12_prf->state )
3905 {
3906 case PSA_TLS12_PRF_STATE_LABEL_SET:
3907 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
3908 break;
3909 case PSA_TLS12_PRF_STATE_OUTPUT:
3910 break;
3911 default:
3912 return( PSA_ERROR_BAD_STATE );
3913 }
3914
Janos Follath844eb0e2019-06-19 12:10:49 +01003915 while( output_length != 0 )
3916 {
3917 /* Check if we have fully processed the current block. */
3918 if( tls12_prf->left_in_block == 0 )
3919 {
3920 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3921 alg );
3922 if( status != PSA_SUCCESS )
3923 return( status );
3924
3925 continue;
3926 }
3927
3928 if( tls12_prf->left_in_block > output_length )
3929 length = (uint8_t) output_length;
3930 else
3931 length = tls12_prf->left_in_block;
3932
3933 offset = hash_length - tls12_prf->left_in_block;
3934 memcpy( output, tls12_prf->output_block + offset, length );
3935 output += length;
3936 output_length -= length;
3937 tls12_prf->left_in_block -= length;
3938 }
3939
3940 return( PSA_SUCCESS );
3941}
John Durkop07cc04a2020-11-16 22:08:34 -08003942#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3943 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003944
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003945psa_status_t psa_key_derivation_output_bytes(
3946 psa_key_derivation_operation_t *operation,
3947 uint8_t *output,
3948 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003949{
3950 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003951 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003952
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003953 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003954 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003955 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003956 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003957 }
3958
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003959 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003960 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003961 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003962 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003963 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003964 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003965 goto exit;
3966 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003967 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003968 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003969 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003970 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003971 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3972 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003973 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003974 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003975 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003976 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003977 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003978
John Durkopd0321952020-10-29 21:37:36 -07003979#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003980 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003981 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003982 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003983 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003984 output, output_length );
3985 }
Janos Follathadbec812019-06-14 11:05:39 +01003986 else
John Durkop07cc04a2020-11-16 22:08:34 -08003987#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3988#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3989 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003990 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003991 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003992 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003993 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003994 kdf_alg, output,
3995 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003996 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003997 else
John Durkop07cc04a2020-11-16 22:08:34 -08003998#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3999 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004000 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004001 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004002 return( PSA_ERROR_BAD_STATE );
4003 }
4004
4005exit:
4006 if( status != PSA_SUCCESS )
4007 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004008 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004009 * This allows us to differentiate between exhausted operations and
4010 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4011 * operations. */
4012 psa_algorithm_t alg = operation->alg;
4013 psa_key_derivation_abort( operation );
4014 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004015 memset( output, '!', output_length );
4016 }
4017 return( status );
4018}
4019
David Brown7807bf72021-02-09 16:28:23 -07004020#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004021static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4022{
4023 if( data_size >= 8 )
4024 mbedtls_des_key_set_parity( data );
4025 if( data_size >= 16 )
4026 mbedtls_des_key_set_parity( data + 8 );
4027 if( data_size >= 24 )
4028 mbedtls_des_key_set_parity( data + 16 );
4029}
David Brown7807bf72021-02-09 16:28:23 -07004030#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004031
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004032static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004033 psa_key_slot_t *slot,
4034 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004035 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004036{
4037 uint8_t *data = NULL;
4038 size_t bytes = PSA_BITS_TO_BYTES( bits );
4039 psa_status_t status;
4040
Gilles Peskine8e338702019-07-30 20:06:31 +02004041 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004042 return( PSA_ERROR_INVALID_ARGUMENT );
4043 if( bits % 8 != 0 )
4044 return( PSA_ERROR_INVALID_ARGUMENT );
4045 data = mbedtls_calloc( 1, bytes );
4046 if( data == NULL )
4047 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4048
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004049 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004050 if( status != PSA_SUCCESS )
4051 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004052#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004053 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004054 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004055#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004056
4057 status = psa_allocate_buffer_to_slot( slot, bytes );
4058 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004059 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004060
Ronald Cronbf33c932020-11-28 18:06:53 +01004061 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004062 psa_key_attributes_t attributes = {
4063 .core = slot->attr
4064 };
4065
Ronald Cronbf33c932020-11-28 18:06:53 +01004066 status = psa_driver_wrapper_import_key( &attributes,
4067 data, bytes,
4068 slot->key.data,
4069 slot->key.bytes,
4070 &slot->key.bytes, &bits );
4071 if( bits != slot->attr.bits )
4072 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004073
4074exit:
4075 mbedtls_free( data );
4076 return( status );
4077}
4078
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004079psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004080 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004081 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004082{
4083 psa_status_t status;
4084 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004085 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004086
Ronald Cron81709fc2020-11-14 12:10:32 +01004087 *key = MBEDTLS_SVC_KEY_ID_INIT;
4088
Gilles Peskine0f84d622019-09-12 19:03:13 +02004089 /* Reject any attempt to create a zero-length key so that we don't
4090 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4091 if( psa_get_key_bits( attributes ) == 0 )
4092 return( PSA_ERROR_INVALID_ARGUMENT );
4093
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004094 if( ! operation->can_output_key )
4095 return( PSA_ERROR_NOT_PERMITTED );
4096
Ronald Cron81709fc2020-11-14 12:10:32 +01004097 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4098 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004099#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4100 if( driver != NULL )
4101 {
4102 /* Deriving a key in a secure element is not implemented yet. */
4103 status = PSA_ERROR_NOT_SUPPORTED;
4104 }
4105#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004106 if( status == PSA_SUCCESS )
4107 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004108 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004109 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004110 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004111 }
4112 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004113 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004114 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004115 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004116
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004117 return( status );
4118}
4119
Gilles Peskineeab56e42018-07-12 17:12:33 +02004120
4121
4122/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004123/* Key derivation */
4124/****************************************************************/
4125
Steven Cooreman932ffb72021-02-15 12:14:32 +01004126#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004127static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004128 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004129 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004130{
John Durkop07cc04a2020-11-16 22:08:34 -08004131 int is_kdf_alg_supported;
4132
Janos Follath5fe19732019-06-20 15:09:30 +01004133 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4134 * initialisers for this union leave some bytes unspecified.) */
4135 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4136
Gilles Peskine969c5d62019-01-16 15:53:06 +01004137 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004138#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004139 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4140 is_kdf_alg_supported = 1;
4141 else
4142#endif
4143#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4144 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4145 is_kdf_alg_supported = 1;
4146 else
4147#endif
4148#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4149 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4150 is_kdf_alg_supported = 1;
4151 else
4152#endif
4153 is_kdf_alg_supported = 0;
4154
4155 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004156 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004157 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004158 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004159 if( hash_size == 0 )
4160 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004161 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4162 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004163 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004164 {
4165 return( PSA_ERROR_NOT_SUPPORTED );
4166 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004167 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004168 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004169 }
John Durkop07cc04a2020-11-16 22:08:34 -08004170
4171 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004172}
John Durkop07cc04a2020-11-16 22:08:34 -08004173#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004174
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004175psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004176 psa_algorithm_t alg )
4177{
4178 psa_status_t status;
4179
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004180 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004181 return( PSA_ERROR_BAD_STATE );
4182
Gilles Peskine6843c292019-01-18 16:44:49 +01004183 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4184 return( PSA_ERROR_INVALID_ARGUMENT );
4185 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004186 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004187#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004188 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004189 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004190#else
4191 return( PSA_ERROR_NOT_SUPPORTED );
4192#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004193 }
4194 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4195 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004196#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004197 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004198#else
4199 return( PSA_ERROR_NOT_SUPPORTED );
4200#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004201 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004202 else
4203 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004204
4205 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004206 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004207 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004208}
4209
John Durkopd0321952020-10-29 21:37:36 -07004210#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004211static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004212 psa_algorithm_t hash_alg,
4213 psa_key_derivation_step_t step,
4214 const uint8_t *data,
4215 size_t data_length )
4216{
4217 psa_status_t status;
4218 switch( step )
4219 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004220 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004221 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004222 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004223 else
4224 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004225 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4226 hash_alg,
4227 data, data_length );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004228 if( status != PSA_SUCCESS )
4229 return( status );
4230 hkdf->state = HKDF_STATE_STARTED;
4231 return( PSA_SUCCESS );
4232 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004233 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004234 /* If no salt was provided, use an empty salt. */
4235 if( hkdf->state == HKDF_STATE_INIT )
4236 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004237 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4238 hash_alg,
4239 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004240 if( status != PSA_SUCCESS )
4241 return( status );
4242 hkdf->state = HKDF_STATE_STARTED;
4243 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004244 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004245 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004246 status = psa_mac_update( &hkdf->hmac,
4247 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004248 if( status != PSA_SUCCESS )
4249 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004250 status = psa_mac_sign_finish( &hkdf->hmac,
4251 hkdf->prk,
4252 sizeof( hkdf->prk ),
4253 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004254 if( status != PSA_SUCCESS )
4255 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004256 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004257 hkdf->block_number = 0;
4258 hkdf->state = HKDF_STATE_KEYED;
4259 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004260 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004261 if( hkdf->state == HKDF_STATE_OUTPUT )
4262 return( PSA_ERROR_BAD_STATE );
4263 if( hkdf->info_set )
4264 return( PSA_ERROR_BAD_STATE );
4265 hkdf->info_length = data_length;
4266 if( data_length != 0 )
4267 {
4268 hkdf->info = mbedtls_calloc( 1, data_length );
4269 if( hkdf->info == NULL )
4270 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4271 memcpy( hkdf->info, data, data_length );
4272 }
4273 hkdf->info_set = 1;
4274 return( PSA_SUCCESS );
4275 default:
4276 return( PSA_ERROR_INVALID_ARGUMENT );
4277 }
4278}
John Durkop07cc04a2020-11-16 22:08:34 -08004279#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004280
John Durkop07cc04a2020-11-16 22:08:34 -08004281#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4282 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004283static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4284 const uint8_t *data,
4285 size_t data_length )
4286{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004287 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004288 return( PSA_ERROR_BAD_STATE );
4289
Janos Follathd6dce9f2019-07-04 09:11:38 +01004290 if( data_length != 0 )
4291 {
4292 prf->seed = mbedtls_calloc( 1, data_length );
4293 if( prf->seed == NULL )
4294 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004295
Janos Follathd6dce9f2019-07-04 09:11:38 +01004296 memcpy( prf->seed, data, data_length );
4297 prf->seed_length = data_length;
4298 }
Janos Follathf08e2652019-06-13 09:05:41 +01004299
Gilles Peskine43f958b2020-12-13 14:55:14 +01004300 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004301
4302 return( PSA_SUCCESS );
4303}
4304
Janos Follath81550542019-06-13 14:26:34 +01004305static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004306 const uint8_t *data,
4307 size_t data_length )
4308{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004309 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004310 return( PSA_ERROR_BAD_STATE );
4311
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004312 if( data_length != 0 )
4313 {
4314 prf->secret = mbedtls_calloc( 1, data_length );
4315 if( prf->secret == NULL )
4316 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4317
4318 memcpy( prf->secret, data, data_length );
4319 prf->secret_length = data_length;
4320 }
Janos Follath81550542019-06-13 14:26:34 +01004321
Gilles Peskine43f958b2020-12-13 14:55:14 +01004322 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004323
4324 return( PSA_SUCCESS );
4325}
4326
Janos Follath63028dd2019-06-13 09:15:47 +01004327static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4328 const uint8_t *data,
4329 size_t data_length )
4330{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004331 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004332 return( PSA_ERROR_BAD_STATE );
4333
Janos Follathd6dce9f2019-07-04 09:11:38 +01004334 if( data_length != 0 )
4335 {
4336 prf->label = mbedtls_calloc( 1, data_length );
4337 if( prf->label == NULL )
4338 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004339
Janos Follathd6dce9f2019-07-04 09:11:38 +01004340 memcpy( prf->label, data, data_length );
4341 prf->label_length = data_length;
4342 }
Janos Follath63028dd2019-06-13 09:15:47 +01004343
Gilles Peskine43f958b2020-12-13 14:55:14 +01004344 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004345
4346 return( PSA_SUCCESS );
4347}
4348
Janos Follathb03233e2019-06-11 15:30:30 +01004349static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004350 psa_key_derivation_step_t step,
4351 const uint8_t *data,
4352 size_t data_length )
4353{
Janos Follathb03233e2019-06-11 15:30:30 +01004354 switch( step )
4355 {
Janos Follathf08e2652019-06-13 09:05:41 +01004356 case PSA_KEY_DERIVATION_INPUT_SEED:
4357 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004358 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004359 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004360 case PSA_KEY_DERIVATION_INPUT_LABEL:
4361 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004362 default:
4363 return( PSA_ERROR_INVALID_ARGUMENT );
4364 }
4365}
John Durkop07cc04a2020-11-16 22:08:34 -08004366#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4367 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4368
4369#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4370static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4371 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004372 const uint8_t *data,
4373 size_t data_length )
4374{
4375 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004376 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004377 uint8_t *cur = pms;
4378
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004379 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004380 return( PSA_ERROR_INVALID_ARGUMENT );
4381
4382 /* Quoting RFC 4279, Section 2:
4383 *
4384 * The premaster secret is formed as follows: if the PSK is N octets
4385 * long, concatenate a uint16 with the value N, N zero octets, a second
4386 * uint16 with the value N, and the PSK itself.
4387 */
4388
4389 *cur++ = ( data_length >> 8 ) & 0xff;
4390 *cur++ = ( data_length >> 0 ) & 0xff;
4391 memset( cur, 0, data_length );
4392 cur += data_length;
4393 *cur++ = pms[0];
4394 *cur++ = pms[1];
4395 memcpy( cur, data, data_length );
4396 cur += data_length;
4397
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004398 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004399
4400 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4401 return( status );
4402}
Janos Follath6660f0e2019-06-17 08:44:03 +01004403
4404static psa_status_t psa_tls12_prf_psk_to_ms_input(
4405 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004406 psa_key_derivation_step_t step,
4407 const uint8_t *data,
4408 size_t data_length )
4409{
4410 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004411 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004412 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004413 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004414 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004415
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004416 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004417}
John Durkop07cc04a2020-11-16 22:08:34 -08004418#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004419
Gilles Peskineb8965192019-09-24 16:21:10 +02004420/** Check whether the given key type is acceptable for the given
4421 * input step of a key derivation.
4422 *
4423 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4424 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4425 * Both secret and non-secret inputs can alternatively have the type
4426 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4427 * that the input was passed as a buffer rather than via a key object.
4428 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004429static int psa_key_derivation_check_input_type(
4430 psa_key_derivation_step_t step,
4431 psa_key_type_t key_type )
4432{
4433 switch( step )
4434 {
4435 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004436 if( key_type == PSA_KEY_TYPE_DERIVE )
4437 return( PSA_SUCCESS );
4438 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004439 return( PSA_SUCCESS );
4440 break;
4441 case PSA_KEY_DERIVATION_INPUT_LABEL:
4442 case PSA_KEY_DERIVATION_INPUT_SALT:
4443 case PSA_KEY_DERIVATION_INPUT_INFO:
4444 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004445 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4446 return( PSA_SUCCESS );
4447 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004448 return( PSA_SUCCESS );
4449 break;
4450 }
4451 return( PSA_ERROR_INVALID_ARGUMENT );
4452}
4453
Janos Follathb80a94e2019-06-12 15:54:46 +01004454static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004455 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004456 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004457 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004458 const uint8_t *data,
4459 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004460{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004461 psa_status_t status;
4462 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4463
4464 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004465 if( status != PSA_SUCCESS )
4466 goto exit;
4467
John Durkopd0321952020-10-29 21:37:36 -07004468#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004469 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004470 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004471 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004472 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004473 step, data, data_length );
4474 }
John Durkop07cc04a2020-11-16 22:08:34 -08004475 else
4476#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4477#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4478 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004479 {
Janos Follathb03233e2019-06-11 15:30:30 +01004480 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004481 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004482 }
John Durkop07cc04a2020-11-16 22:08:34 -08004483 else
4484#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4485#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4486 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004487 {
4488 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004489 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004490 }
4491 else
John Durkop07cc04a2020-11-16 22:08:34 -08004492#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004493 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004494 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004495 (void) data;
4496 (void) data_length;
4497 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004498 return( PSA_ERROR_BAD_STATE );
4499 }
4500
Gilles Peskine224b0d62019-09-23 18:13:17 +02004501exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004502 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004503 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004504 return( status );
4505}
4506
Janos Follath51f4a0f2019-06-14 11:35:55 +01004507psa_status_t psa_key_derivation_input_bytes(
4508 psa_key_derivation_operation_t *operation,
4509 psa_key_derivation_step_t step,
4510 const uint8_t *data,
4511 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004512{
Gilles Peskineb8965192019-09-24 16:21:10 +02004513 return( psa_key_derivation_input_internal( operation, step,
4514 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004515 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004516}
4517
Janos Follath51f4a0f2019-06-14 11:35:55 +01004518psa_status_t psa_key_derivation_input_key(
4519 psa_key_derivation_operation_t *operation,
4520 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004521 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004522{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004524 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004525 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004526
Ronald Cron5c522922020-11-14 16:35:34 +01004527 status = psa_get_and_lock_transparent_key_slot_with_policy(
4528 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004529 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004530 {
4531 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004532 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004533 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004534
4535 /* Passing a key object as a SECRET input unlocks the permission
4536 * to output to a key object. */
4537 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4538 operation->can_output_key = 1;
4539
Ronald Cronf95a2b12020-10-22 15:24:49 +02004540 status = psa_key_derivation_input_internal( operation,
4541 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004542 slot->key.data,
4543 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004544
Ronald Cron5c522922020-11-14 16:35:34 +01004545 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004546
Ronald Cron5c522922020-11-14 16:35:34 +01004547 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004548}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004549
4550
4551
4552/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004553/* Key agreement */
4554/****************************************************************/
4555
John Durkop6ba40d12020-11-10 08:50:04 -08004556#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004557static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4558 size_t peer_key_length,
4559 const mbedtls_ecp_keypair *our_key,
4560 uint8_t *shared_secret,
4561 size_t shared_secret_size,
4562 size_t *shared_secret_length )
4563{
Steven Cooremand4867872020-08-05 16:31:39 +02004564 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004565 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004566 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004567 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004568 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004569 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004570
Ronald Cron90857082020-11-25 14:58:33 +01004571 status = mbedtls_psa_ecp_load_representation(
4572 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004573 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004574 peer_key,
4575 peer_key_length,
4576 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004577 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004578 goto exit;
4579
Jaeden Amero97271b32019-01-10 19:38:51 +00004580 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004581 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004582 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004583 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004584 status = mbedtls_to_psa_error(
4585 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4586 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004587 goto exit;
4588
Jaeden Amero97271b32019-01-10 19:38:51 +00004589 status = mbedtls_to_psa_error(
4590 mbedtls_ecdh_calc_secret( &ecdh,
4591 shared_secret_length,
4592 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004593 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004594 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004595 if( status != PSA_SUCCESS )
4596 goto exit;
4597 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4598 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004599
4600exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004601 if( status != PSA_SUCCESS )
4602 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004603 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004604 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004605 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004606
Jaeden Amero97271b32019-01-10 19:38:51 +00004607 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004608}
John Durkop6ba40d12020-11-10 08:50:04 -08004609#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004610
Gilles Peskine01d718c2018-09-18 12:01:02 +02004611#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4612
Gilles Peskine0216fe12019-04-11 21:23:21 +02004613static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4614 psa_key_slot_t *private_key,
4615 const uint8_t *peer_key,
4616 size_t peer_key_length,
4617 uint8_t *shared_secret,
4618 size_t shared_secret_size,
4619 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004620{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004621 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004622 {
John Durkop6ba40d12020-11-10 08:50:04 -08004623#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004624 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004625 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004626 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004627 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004628 psa_status_t status = mbedtls_psa_ecp_load_representation(
4629 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004630 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004631 private_key->key.data,
4632 private_key->key.bytes,
4633 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004634 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004635 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004636 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004637 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004638 shared_secret, shared_secret_size,
4639 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004640 mbedtls_ecp_keypair_free( ecp );
4641 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004642 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004643#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004644 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004645 (void) private_key;
4646 (void) peer_key;
4647 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004648 (void) shared_secret;
4649 (void) shared_secret_size;
4650 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004651 return( PSA_ERROR_NOT_SUPPORTED );
4652 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004653}
4654
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004655/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004656 * to potentially free embedded data structures and wipe confidential data.
4657 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004658static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004659 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004660 psa_key_slot_t *private_key,
4661 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004662 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004663{
4664 psa_status_t status;
4665 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4666 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004667 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004668
4669 /* Step 1: run the secret agreement algorithm to generate the shared
4670 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004671 status = psa_key_agreement_raw_internal( ka_alg,
4672 private_key,
4673 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004674 shared_secret,
4675 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004676 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004677 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004678 goto exit;
4679
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004680 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004681 * the shared secret. A shared secret is permitted wherever a key
4682 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004683 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004684 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004685 shared_secret,
4686 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004687exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004688 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004689 return( status );
4690}
4691
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004692psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004693 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004694 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004695 const uint8_t *peer_key,
4696 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004697{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004699 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004700 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004701
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004702 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004703 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004704 status = psa_get_and_lock_transparent_key_slot_with_policy(
4705 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004706 if( status != PSA_SUCCESS )
4707 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004708 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004709 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004710 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004711 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004712 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004713 else
4714 {
4715 /* If a private key has been added as SECRET, we allow the derived
4716 * key material to be used as a key in PSA Crypto. */
4717 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4718 operation->can_output_key = 1;
4719 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004720
Ronald Cron5c522922020-11-14 16:35:34 +01004721 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004722
Ronald Cron5c522922020-11-14 16:35:34 +01004723 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004724}
4725
Gilles Peskinebe697d82019-05-16 18:00:41 +02004726psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004727 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004728 const uint8_t *peer_key,
4729 size_t peer_key_length,
4730 uint8_t *output,
4731 size_t output_size,
4732 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004733{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004734 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004735 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004736 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004737
4738 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4739 {
4740 status = PSA_ERROR_INVALID_ARGUMENT;
4741 goto exit;
4742 }
Ronald Cron5c522922020-11-14 16:35:34 +01004743 status = psa_get_and_lock_transparent_key_slot_with_policy(
4744 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004745 if( status != PSA_SUCCESS )
4746 goto exit;
4747
4748 status = psa_key_agreement_raw_internal( alg, slot,
4749 peer_key, peer_key_length,
4750 output, output_size,
4751 output_length );
4752
4753exit:
4754 if( status != PSA_SUCCESS )
4755 {
4756 /* If an error happens and is not handled properly, the output
4757 * may be used as a key to protect sensitive data. Arrange for such
4758 * a key to be random, which is likely to result in decryption or
4759 * verification errors. This is better than filling the buffer with
4760 * some constant data such as zeros, which would result in the data
4761 * being protected with a reproducible, easily knowable key.
4762 */
4763 psa_generate_random( output, output_size );
4764 *output_length = output_size;
4765 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004766
Ronald Cron5c522922020-11-14 16:35:34 +01004767 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004768
Ronald Cron5c522922020-11-14 16:35:34 +01004769 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004770}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004771
4772
Gilles Peskine30524eb2020-11-13 17:02:26 +01004773
Gilles Peskine86a440b2018-11-12 18:39:40 +01004774/****************************************************************/
4775/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004776/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004777
Gilles Peskine30524eb2020-11-13 17:02:26 +01004778/** Initialize the PSA random generator.
4779 */
4780static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4781{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004782#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4783 memset( rng, 0, sizeof( *rng ) );
4784#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4785
Gilles Peskine30524eb2020-11-13 17:02:26 +01004786 /* Set default configuration if
4787 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4788 if( rng->entropy_init == NULL )
4789 rng->entropy_init = mbedtls_entropy_init;
4790 if( rng->entropy_free == NULL )
4791 rng->entropy_free = mbedtls_entropy_free;
4792
4793 rng->entropy_init( &rng->entropy );
4794#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4795 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4796 /* The PSA entropy injection feature depends on using NV seed as an entropy
4797 * source. Add NV seed as an entropy source for PSA entropy injection. */
4798 mbedtls_entropy_add_source( &rng->entropy,
4799 mbedtls_nv_seed_poll, NULL,
4800 MBEDTLS_ENTROPY_BLOCK_SIZE,
4801 MBEDTLS_ENTROPY_SOURCE_STRONG );
4802#endif
4803
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004804 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004805#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004806}
4807
4808/** Deinitialize the PSA random generator.
4809 */
4810static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4811{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004812#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4813 memset( rng, 0, sizeof( *rng ) );
4814#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004815 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004816 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004817#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004818}
4819
4820/** Seed the PSA random generator.
4821 */
4822static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4823{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004824#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4825 /* Do nothing: the external RNG seeds itself. */
4826 (void) rng;
4827 return( PSA_SUCCESS );
4828#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004829 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004830 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4831 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004832 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004833#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004834}
4835
Gilles Peskinee59236f2018-01-27 23:32:46 +01004836psa_status_t psa_generate_random( uint8_t *output,
4837 size_t output_size )
4838{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004839 GUARD_MODULE_INITIALIZED;
4840
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004841#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4842
4843 size_t output_length = 0;
4844 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4845 output, output_size,
4846 &output_length );
4847 if( status != PSA_SUCCESS )
4848 return( status );
4849 /* Breaking up a request into smaller chunks is currently not supported
4850 * for the extrernal RNG interface. */
4851 if( output_length != output_size )
4852 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4853 return( PSA_SUCCESS );
4854
4855#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4856
Gilles Peskine71ddab92021-01-04 21:01:07 +01004857 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004858 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004859 size_t request_size =
4860 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4861 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4862 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004863 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4864 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004865 if( ret != 0 )
4866 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004867 output_size -= request_size;
4868 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004869 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004870 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004871#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004872}
4873
Gilles Peskine8814fc42020-12-14 15:33:44 +01004874/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004875 *
4876 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4877 * `psa_generate_random(...)`. The state parameter is ignored since the
4878 * PSA API doesn't support passing an explicit state.
4879 *
4880 * In the non-external case, psa_generate_random() calls an
4881 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4882 * and semantics as mbedtls_psa_get_random(). As an optimization,
4883 * instead of doing this back-and-forth between the PSA API and the
4884 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4885 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004886 */
4887#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4888int mbedtls_psa_get_random( void *p_rng,
4889 unsigned char *output,
4890 size_t output_size )
4891{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004892 /* This function takes a pointer to the RNG state because that's what
4893 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4894 * its own state internally and doesn't let the caller access that state.
4895 * So we just ignore the state parameter, and in practice we'll pass
4896 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004897 (void) p_rng;
4898 psa_status_t status = psa_generate_random( output, output_size );
4899 if( status == PSA_SUCCESS )
4900 return( 0 );
4901 else
4902 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4903}
4904#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4905
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004906#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
4907#include "mbedtls/entropy_poll.h"
4908
Gilles Peskine7228da22019-07-15 11:06:15 +02004909psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004910 size_t seed_size )
4911{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004912 if( global_data.initialized )
4913 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004914
4915 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4916 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4917 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4918 return( PSA_ERROR_INVALID_ARGUMENT );
4919
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004920 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004921}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004922#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004923
Ronald Cron3772afe2021-02-08 16:10:05 +01004924/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004925 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004926 * \param type The key type
4927 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004928 *
4929 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004930 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004931 * \retval #PSA_ERROR_INVALID_ARGUMENT
4932 * The size in bits of the key is not valid.
4933 * \retval #PSA_ERROR_NOT_SUPPORTED
4934 * The type and/or the size in bits of the key or the combination of
4935 * the two is not supported.
4936 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004937static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4938 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004939{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004940 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004941
Gilles Peskinee59236f2018-01-27 23:32:46 +01004942 if( key_type_is_raw_bytes( type ) )
4943 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004944 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004945 if( status != PSA_SUCCESS )
4946 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004947 }
4948 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004949#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004950 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4951 {
4952 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4953 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004954
Ronald Cron01b2aba2020-10-05 09:42:02 +02004955 /* Accept only byte-aligned keys, for the same reasons as
4956 * in psa_import_rsa_key(). */
4957 if( bits % 8 != 0 )
4958 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004959 }
4960 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004961#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004962
Ronald Cron5c4d3862020-12-07 11:07:24 +01004963#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004964 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4965 {
Ronald Crond81ab562021-02-16 09:01:16 +01004966 /* To avoid empty block, return successfully here. */
4967 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004968 }
4969 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004970#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004971 {
4972 return( PSA_ERROR_NOT_SUPPORTED );
4973 }
4974
4975 return( PSA_SUCCESS );
4976}
4977
Ronald Cron55ed0592020-10-05 10:30:40 +02004978psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004979 const psa_key_attributes_t *attributes,
4980 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004981{
4982 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004983 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004984
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004985 if( ( attributes->domain_parameters == NULL ) &&
4986 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004987 return( PSA_ERROR_INVALID_ARGUMENT );
4988
Ronald Cron01b2aba2020-10-05 09:42:02 +02004989 if( key_type_is_raw_bytes( type ) )
4990 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004991 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004992 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004993 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004994
David Brown12ca5032021-02-11 11:02:00 -07004995#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004996 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004997 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004998#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004999 }
5000 else
5001
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005002#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5003 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005004 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005005 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005006 return( mbedtls_psa_rsa_generate_key( attributes,
5007 key_buffer,
5008 key_buffer_size,
5009 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005010 }
5011 else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005012#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5013 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005014
John Durkop9814fa22020-11-04 12:28:15 -08005015#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005016 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005017 {
Ronald Cron7023db52020-11-20 18:17:42 +01005018 return( mbedtls_psa_ecp_generate_key( attributes,
5019 key_buffer,
5020 key_buffer_size,
5021 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005022 }
5023 else
John Durkop9814fa22020-11-04 12:28:15 -08005024#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005025 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005026 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005027 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005028 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005029
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005030 return( PSA_SUCCESS );
5031}
Darryl Green0c6575a2018-11-07 16:05:30 +00005032
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005033psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005034 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005035{
5036 psa_status_t status;
5037 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005038 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005039 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005040
Ronald Cron81709fc2020-11-14 12:10:32 +01005041 *key = MBEDTLS_SVC_KEY_ID_INIT;
5042
Gilles Peskine0f84d622019-09-12 19:03:13 +02005043 /* Reject any attempt to create a zero-length key so that we don't
5044 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5045 if( psa_get_key_bits( attributes ) == 0 )
5046 return( PSA_ERROR_INVALID_ARGUMENT );
5047
Ronald Cron81709fc2020-11-14 12:10:32 +01005048 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5049 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005050 if( status != PSA_SUCCESS )
5051 goto exit;
5052
Ronald Cron977c2472020-10-13 08:32:21 +02005053 /* In the case of a transparent key or an opaque key stored in local
5054 * storage (thus not in the case of generating a key in a secure element
5055 * or cryptoprocessor with storage), we have to allocate a buffer to
5056 * hold the generated key material. */
5057 if( slot->key.data == NULL )
5058 {
5059 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5060 PSA_KEY_LOCATION_LOCAL_STORAGE )
5061 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005062 status = psa_validate_key_type_and_size_for_key_generation(
5063 attributes->core.type, attributes->core.bits );
5064 if( status != PSA_SUCCESS )
5065 goto exit;
5066
5067 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5068 attributes->core.type,
5069 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005070 }
5071 else
5072 {
5073 status = psa_driver_wrapper_get_key_buffer_size(
5074 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005075 if( status != PSA_SUCCESS )
5076 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005077 }
Ronald Cron977c2472020-10-13 08:32:21 +02005078
5079 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5080 if( status != PSA_SUCCESS )
5081 goto exit;
5082 }
5083
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005084 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005085 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005086
Ronald Cron2b56bc82020-10-05 10:02:26 +02005087 if( status != PSA_SUCCESS )
5088 psa_remove_key_data_from_memory( slot );
5089
Gilles Peskine11792082019-08-06 18:36:36 +02005090exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005091 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005092 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005093 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005094 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005095
Darryl Green0c6575a2018-11-07 16:05:30 +00005096 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005097}
5098
Gilles Peskinee59236f2018-01-27 23:32:46 +01005099/****************************************************************/
5100/* Module setup */
5101/****************************************************************/
5102
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005103#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005104psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5105 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5106 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5107{
5108 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5109 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005110 global_data.rng.entropy_init = entropy_init;
5111 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005112 return( PSA_SUCCESS );
5113}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005114#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005115
Gilles Peskinee59236f2018-01-27 23:32:46 +01005116void mbedtls_psa_crypto_free( void )
5117{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005118 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005119 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5120 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005121 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005122 }
5123 /* Wipe all remaining data, including configuration.
5124 * In particular, this sets all state indicator to the value
5125 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005126 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005127#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005128 /* Unregister all secure element drivers, so that we restart from
5129 * a pristine state. */
5130 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005131#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005132}
5133
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005134#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5135/** Recover a transaction that was interrupted by a power failure.
5136 *
5137 * This function is called during initialization, before psa_crypto_init()
5138 * returns. If this function returns a failure status, the initialization
5139 * fails.
5140 */
5141static psa_status_t psa_crypto_recover_transaction(
5142 const psa_crypto_transaction_t *transaction )
5143{
5144 switch( transaction->unknown.type )
5145 {
5146 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5147 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005148 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005149 * is implemented.
5150 * https://github.com/ARMmbed/mbed-crypto/issues/218
5151 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005152 default:
5153 /* We found an unsupported transaction in the storage.
5154 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005155 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005156 }
5157}
5158#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5159
Gilles Peskinee59236f2018-01-27 23:32:46 +01005160psa_status_t psa_crypto_init( void )
5161{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005162 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005163
Gilles Peskinec6b69072018-11-20 21:42:52 +01005164 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005165 if( global_data.initialized != 0 )
5166 return( PSA_SUCCESS );
5167
Gilles Peskine30524eb2020-11-13 17:02:26 +01005168 /* Initialize and seed the random generator. */
5169 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005170 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005171 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005172 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005173 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005174 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005175
Gilles Peskine66fb1262018-12-10 16:29:04 +01005176 status = psa_initialize_key_slots( );
5177 if( status != PSA_SUCCESS )
5178 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005179
Gilles Peskined9348f22019-10-01 15:22:29 +02005180#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5181 status = psa_init_all_se_drivers( );
5182 if( status != PSA_SUCCESS )
5183 goto exit;
5184#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5185
Gilles Peskine4b734222019-07-24 15:56:31 +02005186#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005187 status = psa_crypto_load_transaction( );
5188 if( status == PSA_SUCCESS )
5189 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005190 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5191 if( status != PSA_SUCCESS )
5192 goto exit;
5193 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005194 }
5195 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5196 {
5197 /* There's no transaction to complete. It's all good. */
5198 status = PSA_SUCCESS;
5199 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005200#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005201
Gilles Peskinec6b69072018-11-20 21:42:52 +01005202 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005203 global_data.initialized = 1;
5204
5205exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005206 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005207 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005208 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005209}
5210
5211#endif /* MBEDTLS_PSA_CRYPTO_C */