blob: 217e904ddfad89b2ee1f2b579addb7d420fd055f [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
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.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 Peskine9ef733f2018-02-07 21:05:37 +010095/* constant-time buffer comparison */
96static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
97{
98 size_t i;
99 unsigned char diff = 0;
100
101 for( i = 0; i < n; i++ )
102 diff |= a[i] ^ b[i];
103
104 return( diff );
105}
106
107
108
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100109/****************************************************************/
110/* Global data, support functions and library management */
111/****************************************************************/
112
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200113static int key_type_is_raw_bytes( psa_key_type_t type )
114{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200115 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200116}
117
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100118/* Values for psa_global_data_t::rng_state */
119#define RNG_NOT_INITIALIZED 0
120#define RNG_INITIALIZED 1
121#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100122
Gilles Peskine2d277862018-06-18 15:41:12 +0200123typedef struct
124{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100125 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100126 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100127 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100128} psa_global_data_t;
129
130static psa_global_data_t global_data;
131
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100132#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
133mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
134 &global_data.rng.drbg;
135#endif
136
itayzafrir0adf0fc2018-09-06 16:24:41 +0300137#define GUARD_MODULE_INITIALIZED \
138 if( global_data.initialized == 0 ) \
139 return( PSA_ERROR_BAD_STATE );
140
Steven Cooreman01164162020-07-20 15:31:37 +0200141psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100142{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100143 /* Mbed TLS error codes can combine a high-level error code and a
144 * low-level error code. The low-level error usually reflects the
145 * root cause better, so dispatch on that preferably. */
146 int low_level_ret = - ( -ret & 0x007f );
147 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100148 {
149 case 0:
150 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100151
152 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
153 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
154 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
155 return( PSA_ERROR_NOT_SUPPORTED );
156 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
157 return( PSA_ERROR_HARDWARE_FAILURE );
158
159 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
160 return( PSA_ERROR_HARDWARE_FAILURE );
161
Gilles Peskine9a944802018-06-21 09:35:35 +0200162 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
163 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
164 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
165 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
166 case MBEDTLS_ERR_ASN1_INVALID_DATA:
167 return( PSA_ERROR_INVALID_ARGUMENT );
168 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
169 return( PSA_ERROR_INSUFFICIENT_MEMORY );
170 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
171 return( PSA_ERROR_BUFFER_TOO_SMALL );
172
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000174 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000175#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
176 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
177#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100178 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
179 return( PSA_ERROR_NOT_SUPPORTED );
180 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
181 return( PSA_ERROR_HARDWARE_FAILURE );
182
Jaeden Amero93e21112019-02-20 13:57:28 +0000183#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000184 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000185#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
186 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
187#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100188 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
191 return( PSA_ERROR_HARDWARE_FAILURE );
192
193 case MBEDTLS_ERR_CCM_BAD_INPUT:
194 return( PSA_ERROR_INVALID_ARGUMENT );
195 case MBEDTLS_ERR_CCM_AUTH_FAILED:
196 return( PSA_ERROR_INVALID_SIGNATURE );
197 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
198 return( PSA_ERROR_HARDWARE_FAILURE );
199
Gilles Peskine26869f22019-05-06 15:25:00 +0200200 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
201 return( PSA_ERROR_INVALID_ARGUMENT );
202
203 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
204 return( PSA_ERROR_BAD_STATE );
205 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
206 return( PSA_ERROR_INVALID_SIGNATURE );
207
Gilles Peskinea5905292018-02-07 20:59:33 +0100208 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
209 return( PSA_ERROR_NOT_SUPPORTED );
210 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
211 return( PSA_ERROR_INVALID_ARGUMENT );
212 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
213 return( PSA_ERROR_INSUFFICIENT_MEMORY );
214 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
215 return( PSA_ERROR_INVALID_PADDING );
216 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
219 return( PSA_ERROR_INVALID_SIGNATURE );
220 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200221 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
223 return( PSA_ERROR_HARDWARE_FAILURE );
224
225 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
226 return( PSA_ERROR_HARDWARE_FAILURE );
227
Gilles Peskine82e57d12020-11-13 21:31:17 +0100228#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
229 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100230 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
231 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100232 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
233 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
234 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
235 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
236 return( PSA_ERROR_NOT_SUPPORTED );
237 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
238 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100239#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100240
241 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
242 return( PSA_ERROR_NOT_SUPPORTED );
243 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
244 return( PSA_ERROR_HARDWARE_FAILURE );
245
Gilles Peskinee59236f2018-01-27 23:32:46 +0100246 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
247 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
248 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100250
251 case MBEDTLS_ERR_GCM_AUTH_FAILED:
252 return( PSA_ERROR_INVALID_SIGNATURE );
253 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200254 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
256 return( PSA_ERROR_HARDWARE_FAILURE );
257
Gilles Peskine82e57d12020-11-13 21:31:17 +0100258#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
259 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100260 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
261 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100262 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
263 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
264 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
265 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
268 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
269#endif
270
Gilles Peskinea5905292018-02-07 20:59:33 +0100271 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
272 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
273 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
274 return( PSA_ERROR_HARDWARE_FAILURE );
275
276 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
277 return( PSA_ERROR_NOT_SUPPORTED );
278 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_MD_ALLOC_FAILED:
281 return( PSA_ERROR_INSUFFICIENT_MEMORY );
282 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
283 return( PSA_ERROR_STORAGE_FAILURE );
284 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
285 return( PSA_ERROR_HARDWARE_FAILURE );
286
Gilles Peskinef76aa772018-10-29 19:24:33 +0100287 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
288 return( PSA_ERROR_STORAGE_FAILURE );
289 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
290 return( PSA_ERROR_INVALID_ARGUMENT );
291 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
292 return( PSA_ERROR_INVALID_ARGUMENT );
293 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
294 return( PSA_ERROR_BUFFER_TOO_SMALL );
295 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
296 return( PSA_ERROR_INVALID_ARGUMENT );
297 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
298 return( PSA_ERROR_INVALID_ARGUMENT );
299 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
300 return( PSA_ERROR_INVALID_ARGUMENT );
301 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
303
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100304 case MBEDTLS_ERR_PK_ALLOC_FAILED:
305 return( PSA_ERROR_INSUFFICIENT_MEMORY );
306 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
307 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
308 return( PSA_ERROR_INVALID_ARGUMENT );
309 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100310 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100311 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
312 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
313 return( PSA_ERROR_INVALID_ARGUMENT );
314 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
315 return( PSA_ERROR_NOT_SUPPORTED );
316 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
317 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
318 return( PSA_ERROR_NOT_PERMITTED );
319 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
320 return( PSA_ERROR_INVALID_ARGUMENT );
321 case MBEDTLS_ERR_PK_INVALID_ALG:
322 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
323 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
324 return( PSA_ERROR_NOT_SUPPORTED );
325 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
326 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329
Gilles Peskineff2d2002019-05-06 15:26:23 +0200330 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
331 return( PSA_ERROR_HARDWARE_FAILURE );
332 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
333 return( PSA_ERROR_NOT_SUPPORTED );
334
Gilles Peskinea5905292018-02-07 20:59:33 +0100335 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
336 return( PSA_ERROR_HARDWARE_FAILURE );
337
338 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
339 return( PSA_ERROR_INVALID_ARGUMENT );
340 case MBEDTLS_ERR_RSA_INVALID_PADDING:
341 return( PSA_ERROR_INVALID_PADDING );
342 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
343 return( PSA_ERROR_HARDWARE_FAILURE );
344 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
345 return( PSA_ERROR_INVALID_ARGUMENT );
346 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
347 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200348 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100349 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
350 return( PSA_ERROR_INVALID_SIGNATURE );
351 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
352 return( PSA_ERROR_BUFFER_TOO_SMALL );
353 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100354 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100355 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
356 return( PSA_ERROR_NOT_SUPPORTED );
357 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
358 return( PSA_ERROR_HARDWARE_FAILURE );
359
360 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
361 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
362 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
363 return( PSA_ERROR_HARDWARE_FAILURE );
364
365 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
366 return( PSA_ERROR_INVALID_ARGUMENT );
367 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
368 return( PSA_ERROR_HARDWARE_FAILURE );
369
itayzafrir5c753392018-05-08 11:18:38 +0300370 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300372 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300373 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
374 return( PSA_ERROR_BUFFER_TOO_SMALL );
375 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
376 return( PSA_ERROR_NOT_SUPPORTED );
377 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
378 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
379 return( PSA_ERROR_INVALID_SIGNATURE );
380 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
381 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100382 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
383 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300384 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
385 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100386
Janos Follatha13b9052019-11-22 12:48:59 +0000387 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
388 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300389
Gilles Peskinee59236f2018-01-27 23:32:46 +0100390 default:
David Saadab4ecc272019-02-14 13:48:10 +0200391 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100392 }
393}
394
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200395
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200396
397
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100398/****************************************************************/
399/* Key management */
400/****************************************************************/
401
Gilles Peskine73167e12019-07-12 23:44:37 +0200402#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
403static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
404{
Gilles Peskine8e338702019-07-30 20:06:31 +0200405 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200406}
407#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
408
John Durkop07cc04a2020-11-16 22:08:34 -0800409/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
410 * current test driver in key_management.c is using this function
411 * when accelerators are used for ECC key pair and public key.
412 * Once that dependency is resolved these guards can be removed.
413 */
John Durkop9814fa22020-11-04 12:28:15 -0800414#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800415 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
416 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
417 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100418mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100419 size_t bits,
420 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200421{
422 switch( curve )
423 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100424 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100427#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100428 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100429 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100430#endif
431#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100432 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100433 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100434#endif
435#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100436 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100437 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100438#endif
439#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100440 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100441 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100442#endif
443#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100445 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100446 case 528:
447 if( bits_is_sloppy )
448 return( MBEDTLS_ECP_DP_SECP521R1 );
449 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100450#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100451 }
452 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100453
Paul Elliott8ff510a2020-06-02 17:19:28 +0100454 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100455 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100456 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100457#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100458 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100459 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100460#endif
461#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100462 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100463 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100464#endif
465#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100466 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100467 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100468#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100469 }
470 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100471
Paul Elliott8ff510a2020-06-02 17:19:28 +0100472 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100473 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100474 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100475#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100476 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100477 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100478 case 256:
479 if( bits_is_sloppy )
480 return( MBEDTLS_ECP_DP_CURVE25519 );
481 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100482#endif
483#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100484 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100485 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100486#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100487 }
488 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100489
Paul Elliott8ff510a2020-06-02 17:19:28 +0100490 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100491 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100492 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100493#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100494 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100495 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100496#endif
497#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100498 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100499 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100500#endif
501#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100502 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100503 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100504#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100505 }
506 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200507 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100508
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100509 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100510 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200511}
John Durkop9814fa22020-11-04 12:28:15 -0800512#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800513 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
514 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
515 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200516
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200517static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
518 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200519{
520 /* Check that the bit size is acceptable for the key type */
521 switch( type )
522 {
523 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200524 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200525 case PSA_KEY_TYPE_DERIVE:
526 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100527#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200528 case PSA_KEY_TYPE_AES:
529 if( bits != 128 && bits != 192 && bits != 256 )
530 return( PSA_ERROR_INVALID_ARGUMENT );
531 break;
532#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100533#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200534 case PSA_KEY_TYPE_CAMELLIA:
535 if( bits != 128 && bits != 192 && bits != 256 )
536 return( PSA_ERROR_INVALID_ARGUMENT );
537 break;
538#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100539#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200540 case PSA_KEY_TYPE_DES:
541 if( bits != 64 && bits != 128 && bits != 192 )
542 return( PSA_ERROR_INVALID_ARGUMENT );
543 break;
544#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100545#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200546 case PSA_KEY_TYPE_ARC4:
547 if( bits < 8 || bits > 2048 )
548 return( PSA_ERROR_INVALID_ARGUMENT );
549 break;
550#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100551#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200552 case PSA_KEY_TYPE_CHACHA20:
553 if( bits != 256 )
554 return( PSA_ERROR_INVALID_ARGUMENT );
555 break;
556#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200557 default:
558 return( PSA_ERROR_NOT_SUPPORTED );
559 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200560 if( bits % 8 != 0 )
561 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200562
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200563 return( PSA_SUCCESS );
564}
565
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100566/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100567 *
Steven Cooremancd640932021-03-08 12:00:27 +0100568 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
569 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100570 *
571 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100572 * \param[in] key_type The key type of the key to be used with the
573 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100574 *
575 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100576 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100577 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100578 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100579 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100580MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100581 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100582 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100583{
Steven Cooremancd640932021-03-08 12:00:27 +0100584 if( PSA_ALG_IS_HMAC( algorithm ) )
585 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100586 if( key_type == PSA_KEY_TYPE_HMAC )
587 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100588 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100589
590 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100591 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100592 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
593 * key. */
594 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
595 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
596 {
597 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
598 * the block length (larger than 1) for block ciphers. */
599 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
600 return( PSA_SUCCESS );
601 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100602 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100603
604 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100605}
606
Steven Cooreman75b74362020-07-28 14:30:13 +0200607/** Try to allocate a buffer to an empty key slot.
608 *
609 * \param[in,out] slot Key slot to attach buffer to.
610 * \param[in] buffer_length Requested size of the buffer.
611 *
612 * \retval #PSA_SUCCESS
613 * The buffer has been successfully allocated.
614 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
615 * Not enough memory was available for allocation.
616 * \retval #PSA_ERROR_ALREADY_EXISTS
617 * Trying to allocate a buffer to a non-empty key slot.
618 */
619static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
620 size_t buffer_length )
621{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100622 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200623 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200624
Ronald Cronea0f8a62020-11-25 17:52:23 +0100625 slot->key.data = mbedtls_calloc( 1, buffer_length );
626 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200627 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200628
Ronald Cronea0f8a62020-11-25 17:52:23 +0100629 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200630 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200631}
632
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200633psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
634 const uint8_t* data,
635 size_t data_length )
636{
637 psa_status_t status = psa_allocate_buffer_to_slot( slot,
638 data_length );
639 if( status != PSA_SUCCESS )
640 return( status );
641
Ronald Cronea0f8a62020-11-25 17:52:23 +0100642 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200643 return( PSA_SUCCESS );
644}
645
Ronald Crona0fe59f2020-11-29 11:14:53 +0100646psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100647 const psa_key_attributes_t *attributes,
648 const uint8_t *data, size_t data_length,
649 uint8_t *key_buffer, size_t key_buffer_size,
650 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100651{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100652 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
653 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100654
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200655 /* zero-length keys are never supported. */
656 if( data_length == 0 )
657 return( PSA_ERROR_NOT_SUPPORTED );
658
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100659 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100660 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100661 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200662
Steven Cooreman75b74362020-07-28 14:30:13 +0200663 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
664 if( data_length > SIZE_MAX / 8 )
665 return( PSA_ERROR_NOT_SUPPORTED );
666
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200667 /* Enforce a size limit, and in particular ensure that the bit
668 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100669 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200670 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200671
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100672 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200673 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200674 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200675
Ronald Crondd04d422020-11-28 15:14:42 +0100676 /* Copy the key material. */
677 memcpy( key_buffer, data, data_length );
678 *key_buffer_length = data_length;
679 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200680
Steven Cooreman40120f62020-10-29 11:42:22 +0100681 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100682 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200684 {
John Durkop9814fa22020-11-04 12:28:15 -0800685#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
686 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100687 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200688 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100689 return( mbedtls_psa_ecp_import_key( attributes,
690 data, data_length,
691 key_buffer, key_buffer_size,
692 key_buffer_length,
693 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100694 }
John Durkop9814fa22020-11-04 12:28:15 -0800695#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
696 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700697#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
698 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100699 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200700 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100701 return( mbedtls_psa_rsa_import_key( attributes,
702 data, data_length,
703 key_buffer, key_buffer_size,
704 key_buffer_length,
705 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200706 }
John Durkop9814fa22020-11-04 12:28:15 -0800707#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
708 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100709 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100710
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100711 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100712}
713
Gilles Peskinef603c712019-01-19 13:40:11 +0100714/** Calculate the intersection of two algorithm usage policies.
715 *
716 * Return 0 (which allows no operation) on incompatibility.
717 */
718static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100719 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100720 psa_algorithm_t alg1,
721 psa_algorithm_t alg2 )
722{
Gilles Peskine549ea862019-05-22 11:45:59 +0200723 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100724 if( alg1 == alg2 )
725 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100726 /* If the policies are from the same hash-and-sign family, check
727 * if one is a wildcard. If so the other has the specific algorithm. */
728 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
729 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
730 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100731 {
Steven Cooreman03488022021-02-18 12:07:20 +0100732 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
733 return( alg2 );
734 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
735 return( alg1 );
736 }
737 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100738 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100739 * restrictive tag length. */
740 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
741 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
742 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
743 {
744 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
745 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100746 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100747
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100748 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100749 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
750 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100751 {
Steven Cooremancd640932021-03-08 12:00:27 +0100752 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
753 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100754 }
755 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100756 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100757 ( alg1_len <= alg2_len ) )
758 {
759 return( alg2 );
760 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100761 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100762 ( alg2_len <= alg1_len ) )
763 {
764 return( alg1 );
765 }
766 }
767 /* If the policies are from the same MAC family, check whether one
768 * of them is a minimum-MAC-length policy. Calculate the most
769 * restrictive tag length. */
770 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
771 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
772 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
773 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100774 /* Validate the combination of key type and algorithm. Since the base
775 * algorithm of alg1 and alg2 are the same, we only need this once. */
776 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100777 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100778
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779 /* Get the (exact or at-least) output lengths for both sides of the
780 * requested intersection. None of the currently supported algorithms
781 * have an output length dependent on the actual key size, so setting it
782 * to a bogus value of 0 is currently OK.
783 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784 * Note that for at-least-this-length wildcard algorithms, the output
785 * length is set to the shortest allowed length, which allows us to
786 * calculate the most restrictive tag length for the intersection. */
787 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
788 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100789 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100790
Steven Cooremana1d83222021-02-25 10:20:29 +0100791 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100792 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
793 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100794 {
Steven Cooremancd640932021-03-08 12:00:27 +0100795 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100796 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100797
798 /* If only one is an at-least-this-length policy, the intersection would
799 * be the other (fixed-length) policy as long as said fixed length is
800 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100801 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100802 {
Steven Cooremancd640932021-03-08 12:00:27 +0100803 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100804 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100805 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100806 {
Steven Cooremancd640932021-03-08 12:00:27 +0100807 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100808 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100809
Steven Cooremancd640932021-03-08 12:00:27 +0100810 /* If none of them are wildcards, check whether they define the same tag
811 * length. This is still possible here when one is default-length and
812 * the other specific-length. Ensure to always return the
813 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100814 if( alg1_len == alg2_len )
815 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100816 }
817 /* If the policies are incompatible, allow nothing. */
818 return( 0 );
819}
820
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100821static int psa_key_algorithm_permits( psa_key_type_t key_type,
822 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200823 psa_algorithm_t requested_alg )
824{
Gilles Peskine549ea862019-05-22 11:45:59 +0200825 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200826 if( requested_alg == policy_alg )
827 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100828 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
829 * and requested_alg is the same hash-and-sign family with any hash,
830 * then requested_alg is compliant with policy_alg. */
831 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
832 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200833 {
Steven Cooreman03488022021-02-18 12:07:20 +0100834 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
835 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
836 }
837 /* If policy_alg is a wildcard AEAD algorithm of the same base as
838 * the requested algorithm, check the requested tag length to be
839 * equal-length or longer than the wildcard-specified length. */
840 if( PSA_ALG_IS_AEAD( policy_alg ) &&
841 PSA_ALG_IS_AEAD( requested_alg ) &&
842 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
843 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100844 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100845 {
846 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
847 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
848 }
Steven Cooremancd640932021-03-08 12:00:27 +0100849 /* If policy_alg is a MAC algorithm of the same base as the requested
850 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100851 if( PSA_ALG_IS_MAC( policy_alg ) &&
852 PSA_ALG_IS_MAC( requested_alg ) &&
853 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100854 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100855 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100856 /* Validate the combination of key type and algorithm. Since the policy
857 * and requested algorithms are the same, we only need this once. */
858 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100859 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100860
Steven Cooreman31a876d2021-03-03 20:47:40 +0100861 /* Get both the requested output length for the algorithm which is to be
862 * verified, and the default output length for the base algorithm.
863 * Note that none of the currently supported algorithms have an output
864 * length dependent on actual key size, so setting it to a bogus value
865 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100866 size_t requested_output_length = PSA_MAC_LENGTH(
867 key_type, 0, requested_alg );
868 size_t default_output_length = PSA_MAC_LENGTH(
869 key_type, 0,
870 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100871
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100872 /* If the policy is default-length, only allow an algorithm with
873 * a declared exact-length matching the default. */
874 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100875 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100876
877 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100878 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100879 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
880 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
881 {
882 return( 1 );
883 }
884
Steven Cooremancd640932021-03-08 12:00:27 +0100885 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
886 * check for the requested MAC length to be equal to or longer than the
887 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100888 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
889 {
890 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100891 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100892 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200893 }
Steven Cooremance48e852020-10-05 16:02:45 +0200894 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200895 * a key derivation with that key agreement should also be allowed. This
896 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200897 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
898 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
899 {
900 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
901 policy_alg );
902 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100903 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200904 return( 0 );
905}
906
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100907/** Test whether a policy permits an algorithm.
908 *
909 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100910 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100911 * \note This function requires providing the key type for which the policy is
912 * being validated, since some algorithm policy definitions (e.g. MAC)
913 * have different properties depending on what kind of cipher it is
914 * combined with.
915 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100916 * \retval PSA_SUCCESS When \p alg is a specific algorithm
917 * allowed by the \p policy.
918 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
919 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
920 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100921 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100923 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100925{
Steven Cooremand788fab2021-02-25 11:29:17 +0100926 /* '0' is not a valid algorithm */
927 if( alg == 0 )
928 return( PSA_ERROR_INVALID_ARGUMENT );
929
Steven Cooreman7e39f052021-02-23 14:18:32 +0100930 /* A requested algorithm cannot be a wildcard. */
931 if( PSA_ALG_IS_WILDCARD( alg ) )
932 return( PSA_ERROR_INVALID_ARGUMENT );
933
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100934 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
935 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100936 return( PSA_SUCCESS );
937 else
938 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100939}
940
Gilles Peskinef603c712019-01-19 13:40:11 +0100941/** Restrict a key policy based on a constraint.
942 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100943 * \note This function requires providing the key type for which the policy is
944 * being restricted, since some algorithm policy definitions (e.g. MAC)
945 * have different properties depending on what kind of cipher it is
946 * combined with.
947 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100948 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100949 * \param[in,out] policy The policy to restrict.
950 * \param[in] constraint The policy constraint to apply.
951 *
952 * \retval #PSA_SUCCESS
953 * \c *policy contains the intersection of the original value of
954 * \c *policy and \c *constraint.
955 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100956 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100957 * \c *policy is unchanged.
958 */
959static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100960 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100961 psa_key_policy_t *policy,
962 const psa_key_policy_t *constraint )
963{
964 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100965 psa_key_policy_algorithm_intersection( key_type, policy->alg,
966 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200967 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100968 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
969 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100970 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
971 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200972 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
973 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100974 policy->usage &= constraint->usage;
975 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200976 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100977 return( PSA_SUCCESS );
978}
979
Ronald Cron5c522922020-11-14 16:35:34 +0100980/** Get the description of a key given its identifier and policy constraints
981 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200982 *
Ronald Cron5c522922020-11-14 16:35:34 +0100983 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100984 * nonzero, the key must allow operations with this algorithm. If \p alg is
985 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100986 *
Ronald Cron5c522922020-11-14 16:35:34 +0100987 * In case of a persistent key, the function loads the description of the key
988 * into a key slot if not already done.
989 *
990 * On success, the returned key slot is locked. It is the responsibility of
991 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200992 */
Ronald Cron5c522922020-11-14 16:35:34 +0100993static psa_status_t psa_get_and_lock_key_slot_with_policy(
994 mbedtls_svc_key_id_t key,
995 psa_key_slot_t **p_slot,
996 psa_key_usage_t usage,
997 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100998{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200999 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1000 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001001
Ronald Cron5c522922020-11-14 16:35:34 +01001002 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001003 if( status != PSA_SUCCESS )
1004 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001005 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001006
1007 /* Enforce that usage policy for the key slot contains all the flags
1008 * required by the usage parameter. There is one exception: public
1009 * keys can always be exported, so we treat public key objects as
1010 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001011 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001012 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001013
Gilles Peskine8e338702019-07-30 20:06:31 +02001014 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +01001015 {
1016 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001017 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001018 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001019
1020 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001021 if( alg != 0 )
1022 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001023 status = psa_key_policy_permits( &slot->attr.policy,
1024 slot->attr.type,
1025 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001026 if( status != PSA_SUCCESS )
1027 goto error;
1028 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001029
Darryl Green06fd18d2018-07-16 11:21:11 +01001030 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001031
1032error:
1033 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001034 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001035
1036 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001037}
Darryl Green940d72c2018-07-13 13:18:51 +01001038
Ronald Cron5c522922020-11-14 16:35:34 +01001039/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001040 *
1041 * A transparent key is a key for which the key material is directly
1042 * available, as opposed to a key in a secure element.
1043 *
Ronald Cron5c522922020-11-14 16:35:34 +01001044 * This is a temporary function to use instead of
1045 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1046 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001047 *
Ronald Cron5c522922020-11-14 16:35:34 +01001048 * On success, the returned key slot is locked. It is the responsibility of the
1049 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001050 */
1051#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001052static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1053 mbedtls_svc_key_id_t key,
1054 psa_key_slot_t **p_slot,
1055 psa_key_usage_t usage,
1056 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001057{
Ronald Cron5c522922020-11-14 16:35:34 +01001058 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1059 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001060 if( status != PSA_SUCCESS )
1061 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001062
Gilles Peskineadad8132019-07-25 11:31:23 +02001063 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001064 {
Ronald Cron5c522922020-11-14 16:35:34 +01001065 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001066 *p_slot = NULL;
1067 return( PSA_ERROR_NOT_SUPPORTED );
1068 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001069
Gilles Peskine28f8f302019-07-24 13:30:31 +02001070 return( PSA_SUCCESS );
1071}
1072#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1073/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001074#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1075 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001076#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1077
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001078/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001079static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001080{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001081 /* Data pointer will always be either a valid pointer or NULL in an
1082 * initialized slot, so we can just free it. */
1083 if( slot->key.data != NULL )
1084 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1085
1086 mbedtls_free( slot->key.data );
1087 slot->key.data = NULL;
1088 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001089
1090 return( PSA_SUCCESS );
1091}
1092
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001093/** Completely wipe a slot in memory, including its policy.
1094 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001095psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001096{
1097 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001098
1099 /*
1100 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001101 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001102 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1103 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001104 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001105 */
Ronald Cron5c522922020-11-14 16:35:34 +01001106 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001107 {
1108#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001109 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001110#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001111 status = PSA_ERROR_CORRUPTION_DETECTED;
1112 }
1113
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001114 /* Multipart operations may still be using the key. This is safe
1115 * because all multipart operation objects are independent from
1116 * the key slot: if they need to access the key after the setup
1117 * phase, they have a copy of the key. Note that this means that
1118 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001119 /* At this point, key material and other type-specific content has
1120 * been wiped. Clear remaining metadata. We can call memset and not
1121 * zeroize because the metadata is not particularly sensitive. */
1122 memset( slot, 0, sizeof( *slot ) );
1123 return( status );
1124}
1125
Ronald Croncf56a0a2020-08-04 09:51:30 +02001126psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001127{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001128 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 psa_status_t status; /* status of the last operation */
1130 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001131#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1132 psa_se_drv_table_entry_t *driver;
1133#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001134
Ronald Croncf56a0a2020-08-04 09:51:30 +02001135 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001136 return( PSA_SUCCESS );
1137
Ronald Cronf2911112020-10-29 17:51:10 +01001138 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001139 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001140 * key, this will load the key description from persistent memory if not
1141 * done yet. We cannot avoid this loading as without it we don't know if
1142 * the key is operated by an SE or not and this information is needed by
1143 * the current implementation.
1144 */
Ronald Cron5c522922020-11-14 16:35:34 +01001145 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001146 if( status != PSA_SUCCESS )
1147 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001148
Ronald Cronf2911112020-10-29 17:51:10 +01001149 /*
1150 * If the key slot containing the key description is under access by the
1151 * library (apart from the present access), the key cannot be destroyed
1152 * yet. For the time being, just return in error. Eventually (to be
1153 * implemented), the key should be destroyed when all accesses have
1154 * stopped.
1155 */
Ronald Cron5c522922020-11-14 16:35:34 +01001156 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001157 {
Ronald Cron5c522922020-11-14 16:35:34 +01001158 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001159 return( PSA_ERROR_GENERIC_ERROR );
1160 }
1161
Gilles Peskine354f7672019-07-12 23:46:38 +02001162#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001163 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001164 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001165 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001166 /* For a key in a secure element, we need to do three things:
1167 * remove the key file in internal storage, destroy the
1168 * key inside the secure element, and update the driver's
1169 * persistent data. Start a transaction that will encompass these
1170 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001171 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001172 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001173 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001174 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001175 status = psa_crypto_save_transaction( );
1176 if( status != PSA_SUCCESS )
1177 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001178 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001179 /* We should still try to destroy the key in the secure
1180 * element and the key metadata in storage. This is especially
1181 * important if the error is that the storage is full.
1182 * But how to do it exactly without risking an inconsistent
1183 * state after a reset?
1184 * https://github.com/ARMmbed/mbed-crypto/issues/215
1185 */
1186 overall_status = status;
1187 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001188 }
1189
Ronald Cronea0f8a62020-11-25 17:52:23 +01001190 status = psa_destroy_se_key( driver,
1191 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001192 if( overall_status == PSA_SUCCESS )
1193 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001194 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001195#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1196
Darryl Greend49a4992018-06-18 17:27:26 +01001197#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001198 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001199 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001200 status = psa_destroy_persistent_key( slot->attr.id );
1201 if( overall_status == PSA_SUCCESS )
1202 overall_status = status;
1203
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001204 /* TODO: other slots may have a copy of the same key. We should
1205 * invalidate them.
1206 * https://github.com/ARMmbed/mbed-crypto/issues/214
1207 */
Darryl Greend49a4992018-06-18 17:27:26 +01001208 }
1209#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001210
Gilles Peskinefc762652019-07-22 19:30:34 +02001211#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1212 if( driver != NULL )
1213 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001214 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001215 if( overall_status == PSA_SUCCESS )
1216 overall_status = status;
1217 status = psa_crypto_stop_transaction( );
1218 if( overall_status == PSA_SUCCESS )
1219 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001220 }
1221#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1222
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001223#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1224exit:
1225#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001226 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001227 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1228 if( overall_status == PSA_SUCCESS )
1229 overall_status = status;
1230 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001231}
1232
John Durkop07cc04a2020-11-16 22:08:34 -08001233#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001234 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001235static psa_status_t psa_get_rsa_public_exponent(
1236 const mbedtls_rsa_context *rsa,
1237 psa_key_attributes_t *attributes )
1238{
1239 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001241 uint8_t *buffer = NULL;
1242 size_t buflen;
1243 mbedtls_mpi_init( &mpi );
1244
1245 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1246 if( ret != 0 )
1247 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001248 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1249 {
1250 /* It's the default value, which is reported as an empty string,
1251 * so there's nothing to do. */
1252 goto exit;
1253 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001254
1255 buflen = mbedtls_mpi_size( &mpi );
1256 buffer = mbedtls_calloc( 1, buflen );
1257 if( buffer == NULL )
1258 {
1259 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1260 goto exit;
1261 }
1262 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1263 if( ret != 0 )
1264 goto exit;
1265 attributes->domain_parameters = buffer;
1266 attributes->domain_parameters_size = buflen;
1267
1268exit:
1269 mbedtls_mpi_free( &mpi );
1270 if( ret != 0 )
1271 mbedtls_free( buffer );
1272 return( mbedtls_to_psa_error( ret ) );
1273}
John Durkop07cc04a2020-11-16 22:08:34 -08001274#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001275 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001276
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001277/** Retrieve all the publicly-accessible attributes of a key.
1278 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001279psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001280 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001281{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001282 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001283 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001284 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001285
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001286 psa_reset_key_attributes( attributes );
1287
Ronald Cron5c522922020-11-14 16:35:34 +01001288 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001289 if( status != PSA_SUCCESS )
1290 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001291
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001292 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001293 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1294 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1295
1296#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1297 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001298 psa_set_key_slot_number( attributes,
1299 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001300#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001301
Gilles Peskine8e338702019-07-30 20:06:31 +02001302 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001303 {
John Durkop07cc04a2020-11-16 22:08:34 -08001304#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001305 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001306 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001308#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001309 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001310 * is not yet implemented.
1311 * https://github.com/ARMmbed/mbed-crypto/issues/216
1312 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001313 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001314 break;
1315#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001316 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001317 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001318
Ronald Cron90857082020-11-25 14:58:33 +01001319 status = mbedtls_psa_rsa_load_representation(
1320 slot->attr.type,
1321 slot->key.data,
1322 slot->key.bytes,
1323 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001324 if( status != PSA_SUCCESS )
1325 break;
1326
Steven Cooremana2371e52020-07-28 14:30:39 +02001327 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001328 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001329 mbedtls_rsa_free( rsa );
1330 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001331 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001332 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001333#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001334 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001335 default:
1336 /* Nothing else to do. */
1337 break;
1338 }
1339
1340 if( status != PSA_SUCCESS )
1341 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001342
Ronald Cron5c522922020-11-14 16:35:34 +01001343 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001344
Ronald Cron5c522922020-11-14 16:35:34 +01001345 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001346}
1347
Gilles Peskinec8000c02019-08-02 20:15:51 +02001348#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1349psa_status_t psa_get_key_slot_number(
1350 const psa_key_attributes_t *attributes,
1351 psa_key_slot_number_t *slot_number )
1352{
1353 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1354 {
1355 *slot_number = attributes->slot_number;
1356 return( PSA_SUCCESS );
1357 }
1358 else
1359 return( PSA_ERROR_INVALID_ARGUMENT );
1360}
1361#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1362
Ronald Crond18b5f82020-11-25 16:46:05 +01001363static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1364 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001365 uint8_t *data,
1366 size_t data_size,
1367 size_t *data_length )
1368{
Ronald Crond18b5f82020-11-25 16:46:05 +01001369 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001370 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001371 memcpy( data, key_buffer, key_buffer_size );
1372 memset( data + key_buffer_size, 0,
1373 data_size - key_buffer_size );
1374 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001375 return( PSA_SUCCESS );
1376}
1377
Ronald Cron7285cda2020-11-26 14:46:37 +01001378psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001379 const psa_key_attributes_t *attributes,
1380 const uint8_t *key_buffer, size_t key_buffer_size,
1381 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001382{
Ronald Crond18b5f82020-11-25 16:46:05 +01001383 psa_key_type_t type = attributes->core.type;
1384
Ronald Crond18b5f82020-11-25 16:46:05 +01001385 if( key_type_is_raw_bytes( type ) ||
1386 PSA_KEY_TYPE_IS_RSA( type ) ||
1387 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001388 {
1389 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001390 key_buffer, key_buffer_size,
1391 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001392 }
1393 else
1394 {
1395 /* This shouldn't happen in the reference implementation, but
1396 it is valid for a special-purpose implementation to omit
1397 support for exporting certain key types. */
1398 return( PSA_ERROR_NOT_SUPPORTED );
1399 }
1400}
1401
1402psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1403 uint8_t *data,
1404 size_t data_size,
1405 size_t *data_length )
1406{
1407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1408 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1409 psa_key_slot_t *slot;
1410
Ronald Crone907e552021-01-18 13:22:38 +01001411 /* Reject a zero-length output buffer now, since this can never be a
1412 * valid key representation. This way we know that data must be a valid
1413 * pointer and we can do things like memset(data, ..., data_size). */
1414 if( data_size == 0 )
1415 return( PSA_ERROR_BUFFER_TOO_SMALL );
1416
Ronald Cron9486f9d2020-11-26 13:36:23 +01001417 /* Set the key to empty now, so that even when there are errors, we always
1418 * set data_length to a value between 0 and data_size. On error, setting
1419 * the key to empty is a good choice because an empty key representation is
1420 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001421 *data_length = 0;
1422
Ronald Cron9486f9d2020-11-26 13:36:23 +01001423 /* Export requires the EXPORT flag. There is an exception for public keys,
1424 * which don't require any flag, but
1425 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1426 */
1427 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1428 PSA_KEY_USAGE_EXPORT, 0 );
1429 if( status != PSA_SUCCESS )
1430 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001431
Ronald Crond18b5f82020-11-25 16:46:05 +01001432 psa_key_attributes_t attributes = {
1433 .core = slot->attr
1434 };
Ronald Cron67227982020-11-26 15:16:05 +01001435 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 slot->key.data, slot->key.bytes,
1437 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001438
Ronald Cron9486f9d2020-11-26 13:36:23 +01001439 unlock_status = psa_unlock_key_slot( slot );
1440
1441 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1442}
1443
Ronald Cron7285cda2020-11-26 14:46:37 +01001444psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001445 const psa_key_attributes_t *attributes,
1446 const uint8_t *key_buffer,
1447 size_t key_buffer_size,
1448 uint8_t *data,
1449 size_t data_size,
1450 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001451{
Ronald Crond18b5f82020-11-25 16:46:05 +01001452 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001453
Ronald Crond18b5f82020-11-25 16:46:05 +01001454 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001455 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001456 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001457 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001458 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001459 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001460 key_buffer, key_buffer_size,
1461 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001462 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001463
Ronald Crond18b5f82020-11-25 16:46:05 +01001464 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001465 {
John Durkop0e005192020-10-31 22:06:54 -07001466#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1467 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001468 return( mbedtls_psa_rsa_export_public_key( attributes,
1469 key_buffer,
1470 key_buffer_size,
1471 data,
1472 data_size,
1473 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001474#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001475 /* We don't know how to convert a private RSA key to public. */
1476 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001477#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1478 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001479 }
1480 else
Moran Pekera998bc62018-04-16 18:16:20 +03001481 {
John Durkop6ba40d12020-11-10 08:50:04 -08001482#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1483 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001484 return( mbedtls_psa_ecp_export_public_key( attributes,
1485 key_buffer,
1486 key_buffer_size,
1487 data,
1488 data_size,
1489 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001490#else
1491 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001492 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001493#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1494 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001495 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001496 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001497 else
1498 {
1499 /* This shouldn't happen in the reference implementation, but
1500 it is valid for a special-purpose implementation to omit
1501 support for exporting certain key types. */
1502 return( PSA_ERROR_NOT_SUPPORTED );
1503 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001504}
Ronald Crond18b5f82020-11-25 16:46:05 +01001505
Ronald Croncf56a0a2020-08-04 09:51:30 +02001506psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001507 uint8_t *data,
1508 size_t data_size,
1509 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001510{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001511 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001512 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001513 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001514
Ronald Crone907e552021-01-18 13:22:38 +01001515 /* Reject a zero-length output buffer now, since this can never be a
1516 * valid key representation. This way we know that data must be a valid
1517 * pointer and we can do things like memset(data, ..., data_size). */
1518 if( data_size == 0 )
1519 return( PSA_ERROR_BUFFER_TOO_SMALL );
1520
Darryl Greendd8fb772018-11-07 16:00:44 +00001521 /* Set the key to empty now, so that even when there are errors, we always
1522 * set data_length to a value between 0 and data_size. On error, setting
1523 * the key to empty is a good choice because an empty key representation is
1524 * unlikely to be accepted anywhere. */
1525 *data_length = 0;
1526
1527 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001528 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001529 if( status != PSA_SUCCESS )
1530 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001531
Ronald Cron9486f9d2020-11-26 13:36:23 +01001532 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1533 {
1534 status = PSA_ERROR_INVALID_ARGUMENT;
1535 goto exit;
1536 }
1537
Ronald Crond18b5f82020-11-25 16:46:05 +01001538 psa_key_attributes_t attributes = {
1539 .core = slot->attr
1540 };
Ronald Cron67227982020-11-26 15:16:05 +01001541 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001542 &attributes, slot->key.data, slot->key.bytes,
1543 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001544
1545exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001546 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001547
Ronald Cron5c522922020-11-14 16:35:34 +01001548 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001549}
1550
Gilles Peskine91e8c332019-08-02 19:19:39 +02001551#if defined(static_assert)
1552static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1553 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001554static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001555 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001556static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001557 "One or more key attribute flag is listed as both internal-only and external-only" );
1558#endif
1559
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001560/** Validate that a key policy is internally well-formed.
1561 *
1562 * This function only rejects invalid policies. It does not validate the
1563 * consistency of the policy with respect to other attributes of the key
1564 * such as the key type.
1565 */
1566static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001567{
1568 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001569 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001570 PSA_KEY_USAGE_ENCRYPT |
1571 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001572 PSA_KEY_USAGE_SIGN_HASH |
1573 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1575 return( PSA_ERROR_INVALID_ARGUMENT );
1576
Gilles Peskine4747d192019-04-17 15:05:45 +02001577 return( PSA_SUCCESS );
1578}
1579
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001580/** Validate the internal consistency of key attributes.
1581 *
1582 * This function only rejects invalid attribute values. If does not
1583 * validate the consistency of the attributes with any key data that may
1584 * be involved in the creation of the key.
1585 *
1586 * Call this function early in the key creation process.
1587 *
1588 * \param[in] attributes Key attributes for the new key.
1589 * \param[out] p_drv On any return, the driver for the key, if any.
1590 * NULL for a transparent key.
1591 *
1592 */
1593static psa_status_t psa_validate_key_attributes(
1594 const psa_key_attributes_t *attributes,
1595 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001596{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001597 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001598 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001599 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001600
Ronald Cron54b90082020-10-29 15:26:43 +01001601 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001602 if( status != PSA_SUCCESS )
1603 return( status );
1604
Ronald Crond2ed4812020-07-17 16:11:30 +02001605 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001606 if( status != PSA_SUCCESS )
1607 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001608
Ronald Cron65f38a32020-10-23 17:11:13 +02001609 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1610 {
1611 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1612 return( PSA_ERROR_INVALID_ARGUMENT );
1613 }
1614 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001615 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001616 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001617 if( status != PSA_SUCCESS )
1618 return( status );
1619 }
1620
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001621 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001622 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001623 return( status );
1624
1625 /* Refuse to create overly large keys.
1626 * Note that this doesn't trigger on import if the attributes don't
1627 * explicitly specify a size (so psa_get_key_bits returns 0), so
1628 * psa_import_key() needs its own checks. */
1629 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1630 return( PSA_ERROR_NOT_SUPPORTED );
1631
Gilles Peskine91e8c332019-08-02 19:19:39 +02001632 /* Reject invalid flags. These should not be reachable through the API. */
1633 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1634 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1635 return( PSA_ERROR_INVALID_ARGUMENT );
1636
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001637 return( PSA_SUCCESS );
1638}
1639
Gilles Peskine4747d192019-04-17 15:05:45 +02001640/** Prepare a key slot to receive key material.
1641 *
1642 * This function allocates a key slot and sets its metadata.
1643 *
1644 * If this function fails, call psa_fail_key_creation().
1645 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001646 * This function is intended to be used as follows:
1647 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001648 * it with the specified attributes, and in case of a volatile key assign it
1649 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001650 * -# Populate the slot with the key material.
1651 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1652 * In case of failure at any step, stop the sequence and call
1653 * psa_fail_key_creation().
1654 *
Ronald Cron5c522922020-11-14 16:35:34 +01001655 * On success, the key slot is locked. It is the responsibility of the caller
1656 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001657 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001658 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001659 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001660 * \param[out] p_slot On success, a pointer to the prepared slot.
1661 * \param[out] p_drv On any return, the driver for the key, if any.
1662 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001663 *
1664 * \retval #PSA_SUCCESS
1665 * The key slot is ready to receive key material.
1666 * \return If this function fails, the key slot is an invalid state.
1667 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001668 */
1669static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001670 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001671 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001672 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001673 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001674{
1675 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001676 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001677 psa_key_slot_t *slot;
1678
Gilles Peskinedf179142019-07-15 22:02:14 +02001679 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001680 *p_drv = NULL;
1681
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001682 status = psa_validate_key_attributes( attributes, p_drv );
1683 if( status != PSA_SUCCESS )
1684 return( status );
1685
Ronald Cronc4d1b512020-07-31 11:26:37 +02001686 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001687 if( status != PSA_SUCCESS )
1688 return( status );
1689 slot = *p_slot;
1690
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001691 /* We're storing the declared bit-size of the key. It's up to each
1692 * creation mechanism to verify that this information is correct.
1693 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001694 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001695 * is optional (import, copy). In case of a volatile key, assign it the
1696 * volatile key identifier associated to the slot returned to contain its
1697 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001698
1699 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001700 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1701 {
1702#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1703 slot->attr.id = volatile_key_id;
1704#else
1705 slot->attr.id.key_id = volatile_key_id;
1706#endif
1707 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001708
Gilles Peskine91e8c332019-08-02 19:19:39 +02001709 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001710 * external-only flags, query `attributes`. Thanks to the check
1711 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001712 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001713 * may have set. */
1714 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001715
Gilles Peskinecbaff462019-07-12 23:46:04 +02001716#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001717 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001718 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001719 * create the key file in internal storage, create the
1720 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001721 * persistent data. This is done by starting a transaction that will
1722 * encompass these three actions.
1723 * For registering a volatile key, we just need to find an appropriate
1724 * slot number inside the SE. Since the key is designated volatile, creating
1725 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001726 /* The first thing to do is to find a slot number for the new key.
1727 * We save the slot number in persistent storage as part of the
1728 * transaction data. It will be needed to recover if the power
1729 * fails during the key creation process, to clean up on the secure
1730 * element side after restarting. Obtaining a slot number from the
1731 * secure element driver updates its persistent state, but we do not yet
1732 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001733 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001734 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001735 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001736 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001737 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001739 if( status != PSA_SUCCESS )
1740 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001741
1742 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001743 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001744 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1745 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001746 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001747 psa_crypto_transaction.key.id = slot->attr.id;
1748 status = psa_crypto_save_transaction( );
1749 if( status != PSA_SUCCESS )
1750 {
1751 (void) psa_crypto_stop_transaction( );
1752 return( status );
1753 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001754 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001755
1756 status = psa_copy_key_material_into_slot(
1757 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001758 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001759
1760 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1761 {
1762 /* Key registration only makes sense with a secure element. */
1763 return( PSA_ERROR_INVALID_ARGUMENT );
1764 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001765#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1766
Ronald Cronc4d1b512020-07-31 11:26:37 +02001767 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001768}
Gilles Peskine4747d192019-04-17 15:05:45 +02001769
1770/** Finalize the creation of a key once its key material has been set.
1771 *
1772 * This entails writing the key to persistent storage.
1773 *
1774 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001775 * See the documentation of psa_start_key_creation() for the intended use
1776 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 *
Ronald Cron5c522922020-11-14 16:35:34 +01001778 * If the finalization succeeds, the function unlocks the key slot (it was
1779 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1780 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001781 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001782 * \param[in,out] slot Pointer to the slot with key material.
1783 * \param[in] driver The secure element driver for the key,
1784 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001785 * \param[out] key On success, identifier of the key. Note that the
1786 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001787 *
1788 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001789 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001790 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1791 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1792 * \retval #PSA_ERROR_ALREADY_EXISTS
1793 * \retval #PSA_ERROR_DATA_INVALID
1794 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001795 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001796 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001797 * \return If this function fails, the key slot is an invalid state.
1798 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001799 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001800static psa_status_t psa_finish_key_creation(
1801 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001802 psa_se_drv_table_entry_t *driver,
1803 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001804{
1805 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001806 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001807 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001808
1809#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001810 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001811 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001812#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1813 if( driver != NULL )
1814 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001815 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001816 psa_key_slot_number_t slot_number =
1817 psa_key_slot_get_slot_number( slot ) ;
1818
Gilles Peskineb46bef22019-07-30 21:32:04 +02001819#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001820 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001821 sizeof( data.slot_number ),
1822 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001823#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001824 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001825 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001826 (uint8_t*) &data,
1827 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001828 }
1829 else
1830#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1831 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001832 /* Key material is saved in export representation in the slot, so
1833 * just pass the slot buffer for storage. */
1834 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001835 slot->key.data,
1836 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001837 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001838 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001839#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1840
Gilles Peskinecbaff462019-07-12 23:46:04 +02001841#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001842 /* Finish the transaction for a key creation. This does not
1843 * happen when registering an existing key. Detect this case
1844 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001845 * creation of a persistent key in a secure element requires a transaction,
1846 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001847 if( driver != NULL &&
1848 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001849 {
1850 status = psa_save_se_persistent_data( driver );
1851 if( status != PSA_SUCCESS )
1852 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001853 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001854 return( status );
1855 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001856 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001857 }
1858#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1859
Ronald Cron50972942020-11-14 11:28:25 +01001860 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001861 {
1862 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001863 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001864 if( status != PSA_SUCCESS )
1865 *key = MBEDTLS_SVC_KEY_ID_INIT;
1866 }
Ronald Cron50972942020-11-14 11:28:25 +01001867
Gilles Peskine4747d192019-04-17 15:05:45 +02001868 return( status );
1869}
1870
1871/** Abort the creation of a key.
1872 *
1873 * You may call this function after calling psa_start_key_creation(),
1874 * or after psa_finish_key_creation() fails. In other circumstances, this
1875 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001876 * See the documentation of psa_start_key_creation() for the intended use
1877 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001878 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001879 * \param[in,out] slot Pointer to the slot with key material.
1880 * \param[in] driver The secure element driver for the key,
1881 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001882 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001883static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001884 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001885{
Gilles Peskine011e4282019-06-26 18:34:38 +02001886 (void) driver;
1887
Gilles Peskine4747d192019-04-17 15:05:45 +02001888 if( slot == NULL )
1889 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001890
1891#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001892 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001893 * element, and the failure happened later (when saving metadata
1894 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001895 * element.
1896 * https://github.com/ARMmbed/mbed-crypto/issues/217
1897 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001898
Gilles Peskined7729582019-08-05 15:55:54 +02001899 /* Abort the ongoing transaction if any (there may not be one if
1900 * the creation process failed before starting one, or if the
1901 * key creation is a registration of a key in a secure element).
1902 * Earlier functions must already have done what it takes to undo any
1903 * partial creation. All that's left is to update the transaction data
1904 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001905 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001906#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1907
Gilles Peskine4747d192019-04-17 15:05:45 +02001908 psa_wipe_key_slot( slot );
1909}
1910
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001911/** Validate optional attributes during key creation.
1912 *
1913 * Some key attributes are optional during key creation. If they are
1914 * specified in the attributes structure, check that they are consistent
1915 * with the data in the slot.
1916 *
1917 * This function should be called near the end of key creation, after
1918 * the slot in memory is fully populated but before saving persistent data.
1919 */
1920static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 const psa_key_slot_t *slot,
1922 const psa_key_attributes_t *attributes )
1923{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001924 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001926 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001927 return( PSA_ERROR_INVALID_ARGUMENT );
1928 }
1929
1930 if( attributes->domain_parameters_size != 0 )
1931 {
John Durkop0e005192020-10-31 22:06:54 -07001932#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1933 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001934 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001935 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001936 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001937 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001938 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001939
Ronald Cron90857082020-11-25 14:58:33 +01001940 psa_status_t status = mbedtls_psa_rsa_load_representation(
1941 slot->attr.type,
1942 slot->key.data,
1943 slot->key.bytes,
1944 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001945 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001946 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001947
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001948 mbedtls_mpi_init( &actual );
1949 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001950 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001951 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001952 mbedtls_rsa_free( rsa );
1953 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954 if( ret != 0 )
1955 goto rsa_exit;
1956 ret = mbedtls_mpi_read_binary( &required,
1957 attributes->domain_parameters,
1958 attributes->domain_parameters_size );
1959 if( ret != 0 )
1960 goto rsa_exit;
1961 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1962 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1963 rsa_exit:
1964 mbedtls_mpi_free( &actual );
1965 mbedtls_mpi_free( &required );
1966 if( ret != 0)
1967 return( mbedtls_to_psa_error( ret ) );
1968 }
1969 else
John Durkop9814fa22020-11-04 12:28:15 -08001970#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1971 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001972 {
1973 return( PSA_ERROR_INVALID_ARGUMENT );
1974 }
1975 }
1976
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001977 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001978 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001979 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001980 return( PSA_ERROR_INVALID_ARGUMENT );
1981 }
1982
1983 return( PSA_SUCCESS );
1984}
1985
Gilles Peskine4747d192019-04-17 15:05:45 +02001986psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001987 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001988 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001989 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001990{
1991 psa_status_t status;
1992 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001993 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001994 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001995
Ronald Cron81709fc2020-11-14 12:10:32 +01001996 *key = MBEDTLS_SVC_KEY_ID_INIT;
1997
Gilles Peskine0f84d622019-09-12 19:03:13 +02001998 /* Reject zero-length symmetric keys (including raw data key objects).
1999 * This also rejects any key which might be encoded as an empty string,
2000 * which is never valid. */
2001 if( data_length == 0 )
2002 return( PSA_ERROR_INVALID_ARGUMENT );
2003
Gilles Peskinedf179142019-07-15 22:02:14 +02002004 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002005 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006 if( status != PSA_SUCCESS )
2007 goto exit;
2008
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002009 /* In the case of a transparent key or an opaque key stored in local
2010 * storage (thus not in the case of generating a key in a secure element
2011 * or cryptoprocessor with storage), we have to allocate a buffer to
2012 * hold the generated key material. */
2013 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02002014 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002015 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002016 if( status != PSA_SUCCESS )
2017 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002018 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002019
2020 bits = slot->attr.bits;
2021 status = psa_driver_wrapper_import_key( attributes,
2022 data, data_length,
2023 slot->key.data,
2024 slot->key.bytes,
2025 &slot->key.bytes, &bits );
2026 if( status != PSA_SUCCESS )
2027 goto exit;
2028
2029 if( slot->attr.bits == 0 )
2030 slot->attr.bits = (psa_key_bits_t) bits;
2031 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002032 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002033 status = PSA_ERROR_INVALID_ARGUMENT;
2034 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002035 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002036
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002037 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002038 if( status != PSA_SUCCESS )
2039 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002040
Ronald Cron81709fc2020-11-14 12:10:32 +01002041 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002042exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002043 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002044 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002045
Gilles Peskine4747d192019-04-17 15:05:45 +02002046 return( status );
2047}
2048
Gilles Peskined7729582019-08-05 15:55:54 +02002049#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2050psa_status_t mbedtls_psa_register_se_key(
2051 const psa_key_attributes_t *attributes )
2052{
2053 psa_status_t status;
2054 psa_key_slot_t *slot = NULL;
2055 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002056 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002057
2058 /* Leaving attributes unspecified is not currently supported.
2059 * It could make sense to query the key type and size from the
2060 * secure element, but not all secure elements support this
2061 * and the driver HAL doesn't currently support it. */
2062 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2063 return( PSA_ERROR_NOT_SUPPORTED );
2064 if( psa_get_key_bits( attributes ) == 0 )
2065 return( PSA_ERROR_NOT_SUPPORTED );
2066
2067 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002068 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002069 if( status != PSA_SUCCESS )
2070 goto exit;
2071
Ronald Cron81709fc2020-11-14 12:10:32 +01002072 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002073
2074exit:
2075 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002076 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002077
Gilles Peskined7729582019-08-05 15:55:54 +02002078 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002079 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002080 return( status );
2081}
2082#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2083
Gilles Peskinef603c712019-01-19 13:40:11 +01002084static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002085 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002086{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002087 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002088 source->key.data,
2089 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002090 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002091 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002092
Steven Cooreman398aee52020-10-13 14:35:45 +02002093 target->attr.type = source->attr.type;
2094 target->attr.bits = source->attr.bits;
2095
2096 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002097}
2098
Ronald Croncf56a0a2020-08-04 09:51:30 +02002099psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002100 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002101 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002102{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002104 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002105 psa_key_slot_t *source_slot = NULL;
2106 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002107 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002108 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002109
Ronald Cron81709fc2020-11-14 12:10:32 +01002110 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2111
Ronald Cron5c522922020-11-14 16:35:34 +01002112 status = psa_get_and_lock_transparent_key_slot_with_policy(
2113 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002114 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002115 goto exit;
2116
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002117 status = psa_validate_optional_attributes( source_slot,
2118 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002119 if( status != PSA_SUCCESS )
2120 goto exit;
2121
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002122 status = psa_restrict_key_policy( source_slot->attr.type,
2123 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002124 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002125 if( status != PSA_SUCCESS )
2126 goto exit;
2127
Ronald Cron81709fc2020-11-14 12:10:32 +01002128 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2129 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002130 if( status != PSA_SUCCESS )
2131 goto exit;
2132
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002133#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2134 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002135 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002136 /* Copying to a secure element is not implemented yet. */
2137 status = PSA_ERROR_NOT_SUPPORTED;
2138 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002139 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002140#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002141
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002142 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002143 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002144 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002145
Ronald Cron81709fc2020-11-14 12:10:32 +01002146 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002147exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002148 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002149 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002150
Ronald Cron5c522922020-11-14 16:35:34 +01002151 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002152
Ronald Cron5c522922020-11-14 16:35:34 +01002153 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002154}
2155
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002156
2157
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002158/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002159/* Message digests */
2160/****************************************************************/
2161
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002162psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2163{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002164 /* Aborting a non-active operation is allowed */
2165 if( operation->id == 0 )
2166 return( PSA_SUCCESS );
2167
2168 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2169 operation->id = 0;
2170
2171 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172}
2173
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002174psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002175 psa_algorithm_t alg )
2176{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002177 /* A context must be freshly initialized before it can be set up. */
2178 if( operation->id != 0 )
2179 return( PSA_ERROR_BAD_STATE );
2180
2181 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002182 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002183
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002184 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2185 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002186 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2187
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002188 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002189}
2190
2191psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2192 const uint8_t *input,
2193 size_t input_length )
2194{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002195 if( operation->id == 0 )
2196 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002197
Steven Cooremanc8288352021-03-04 14:02:19 +01002198 /* Don't require hash implementations to behave correctly on a
2199 * zero-length input, which may have an invalid pointer. */
2200 if( input_length == 0 )
2201 return( PSA_SUCCESS );
2202
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002203 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2204 input, input_length );
2205 if( status != PSA_SUCCESS )
2206 psa_hash_abort( operation );
2207
2208 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002209}
2210
2211psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2212 uint8_t *hash,
2213 size_t hash_size,
2214 size_t *hash_length )
2215{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002216 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002217 if( operation->id == 0 )
2218 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219
Steven Cooreman1e582352021-02-18 17:24:37 +01002220 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002221 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002222 psa_hash_abort( operation );
2223 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002224}
2225
Gilles Peskine2d277862018-06-18 15:41:12 +02002226psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2227 const uint8_t *hash,
2228 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002229{
2230 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2231 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232 psa_status_t status = psa_hash_finish(
2233 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002234 actual_hash, sizeof( actual_hash ),
2235 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002236 if( status != PSA_SUCCESS )
2237 return( status );
2238 if( actual_hash_length != hash_length )
2239 return( PSA_ERROR_INVALID_SIGNATURE );
2240 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2241 return( PSA_ERROR_INVALID_SIGNATURE );
2242 return( PSA_SUCCESS );
2243}
2244
Gilles Peskine0a749c82019-11-28 19:33:58 +01002245psa_status_t psa_hash_compute( psa_algorithm_t alg,
2246 const uint8_t *input, size_t input_length,
2247 uint8_t *hash, size_t hash_size,
2248 size_t *hash_length )
2249{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002250 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002251 if( !PSA_ALG_IS_HASH( alg ) )
2252 return( PSA_ERROR_INVALID_ARGUMENT );
2253
Steven Cooreman1e582352021-02-18 17:24:37 +01002254 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2255 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002256}
2257
2258psa_status_t psa_hash_compare( psa_algorithm_t alg,
2259 const uint8_t *input, size_t input_length,
2260 const uint8_t *hash, size_t hash_length )
2261{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002262 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2263 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002264
2265 if( !PSA_ALG_IS_HASH( alg ) )
2266 return( PSA_ERROR_INVALID_ARGUMENT );
2267
Steven Cooreman1e582352021-02-18 17:24:37 +01002268 psa_status_t status = psa_driver_wrapper_hash_compute(
2269 alg, input, input_length,
2270 actual_hash, sizeof(actual_hash),
2271 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002272 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002273 return( status );
2274 if( actual_hash_length != hash_length )
2275 return( PSA_ERROR_INVALID_SIGNATURE );
2276 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2277 return( PSA_ERROR_INVALID_SIGNATURE );
2278 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002279}
2280
Gilles Peskineeb35d782019-01-22 17:56:16 +01002281psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2282 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002283{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002284 if( source_operation->id == 0 ||
2285 target_operation->id != 0 )
2286 {
2287 return( PSA_ERROR_BAD_STATE );
2288 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002289
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002290 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2291 target_operation );
2292 if( status != PSA_SUCCESS )
2293 psa_hash_abort( target_operation );
2294
2295 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002296}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002297
2298
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002299/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002300/* MAC */
2301/****************************************************************/
2302
John Durkop6ba40d12020-11-10 08:50:04 -08002303#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002304static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002305{
Gilles Peskine2d277862018-06-18 15:41:12 +02002306 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002307 {
2308 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002309 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002310 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002311 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002312 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002313 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002314 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002315 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002316 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002317 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002318 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002319 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002320 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002321 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002322 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002323 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002324 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002325 return( 128 );
2326 default:
2327 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002328 }
2329}
John Durkop07cc04a2020-11-16 22:08:34 -08002330#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002331
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002332/* Initialize the MAC operation structure. Once this function has been
2333 * called, psa_mac_abort can run and will do the right thing. */
2334static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2335 psa_algorithm_t alg )
2336{
2337 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2338
Steven Cooreman15472f82021-03-02 16:16:22 +01002339 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002340 operation->key_set = 0;
2341 operation->iv_set = 0;
2342 operation->iv_required = 0;
2343 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002344 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002345
Ronald Cron3d471812021-03-18 13:40:31 +01002346#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002347 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002348 {
2349 operation->iv_required = 0;
2350 mbedtls_cipher_init( &operation->ctx.cmac );
2351 status = PSA_SUCCESS;
2352 }
2353 else
Ronald Cron3d471812021-03-18 13:40:31 +01002354#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002355#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002356 if( PSA_ALG_IS_HMAC( operation->alg ) )
2357 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002358 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002359 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002360 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002361 }
2362 else
John Durkopd0321952020-10-29 21:37:36 -07002363#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002364 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002365 if( ! PSA_ALG_IS_MAC( alg ) )
2366 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002367 }
2368
2369 if( status != PSA_SUCCESS )
2370 memset( operation, 0, sizeof( *operation ) );
2371 return( status );
2372}
2373
John Durkop6ba40d12020-11-10 08:50:04 -08002374#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002375static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2376{
Gilles Peskine3f108122018-12-07 18:14:53 +01002377 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002378 return( psa_hash_abort( &hmac->hash_ctx ) );
2379}
John Durkop6ba40d12020-11-10 08:50:04 -08002380#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002381
Gilles Peskine8c9def32018-02-08 10:02:12 +01002382psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2383{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002384 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002385 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002386 /* The object has (apparently) been initialized but it is not
2387 * in use. It's ok to call abort on such an object, and there's
2388 * nothing to do. */
2389 return( PSA_SUCCESS );
2390 }
2391 else
Ronald Cron3d471812021-03-18 13:40:31 +01002392#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002393 if( operation->alg == PSA_ALG_CMAC )
2394 {
2395 mbedtls_cipher_free( &operation->ctx.cmac );
2396 }
2397 else
Ronald Cron3d471812021-03-18 13:40:31 +01002398#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002399#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002400 if( PSA_ALG_IS_HMAC( operation->alg ) )
2401 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002402 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002403 }
2404 else
John Durkopd0321952020-10-29 21:37:36 -07002405#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002406 {
2407 /* Sanity check (shouldn't happen: operation->alg should
2408 * always have been initialized to a valid value). */
2409 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410 }
Moran Peker41deec42018-04-04 15:43:05 +03002411
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 operation->alg = 0;
2413 operation->key_set = 0;
2414 operation->iv_set = 0;
2415 operation->iv_required = 0;
2416 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002417 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002418
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002420
2421bad_state:
2422 /* If abort is called on an uninitialized object, we can't trust
2423 * anything. Wipe the object in case it contains confidential data.
2424 * This may result in a memory leak if a pointer gets overwritten,
2425 * but it's too late to do anything about this. */
2426 memset( operation, 0, sizeof( *operation ) );
2427 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002428}
2429
Ronald Cron3d471812021-03-18 13:40:31 +01002430#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002431static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2432 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002433{
Janos Follath24eed8d2019-11-22 13:21:35 +00002434 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002435 const mbedtls_cipher_info_t *cipher_info =
2436 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2437 slot->attr.type, slot->attr.bits,
2438 NULL );
2439 if( cipher_info == NULL )
2440 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002441
2442 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2443 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002444 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002445
2446 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002447 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002448 slot->attr.bits );
2449exit:
2450 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002451}
Ronald Cron3d471812021-03-18 13:40:31 +01002452#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002453
John Durkop6ba40d12020-11-10 08:50:04 -08002454#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002455static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2456 const uint8_t *key,
2457 size_t key_length,
2458 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002459{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002460 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002461 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002462 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002463 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002464 psa_status_t status;
2465
Steven Cooreman0e307642021-02-18 16:18:32 +01002466 hmac->alg = hash_alg;
2467
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002468 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2469 * overflow below. This should never trigger if the hash algorithm
2470 * is implemented correctly. */
2471 /* The size checks against the ipad and opad buffers cannot be written
2472 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2473 * because that triggers -Wlogical-op on GCC 7.3. */
2474 if( block_size > sizeof( ipad ) )
2475 return( PSA_ERROR_NOT_SUPPORTED );
2476 if( block_size > sizeof( hmac->opad ) )
2477 return( PSA_ERROR_NOT_SUPPORTED );
2478 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002479 return( PSA_ERROR_NOT_SUPPORTED );
2480
Gilles Peskined223b522018-06-11 18:12:58 +02002481 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002482 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002483 status = psa_hash_compute( hash_alg, key, key_length,
2484 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002485 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002486 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002487 }
Gilles Peskine96889972018-07-12 17:07:03 +02002488 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2489 * but it is permitted. It is common when HMAC is used in HKDF, for
2490 * example. Don't call `memcpy` in the 0-length because `key` could be
2491 * an invalid pointer which would make the behavior undefined. */
2492 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002493 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002494
Gilles Peskined223b522018-06-11 18:12:58 +02002495 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2496 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002497 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002498 ipad[i] ^= 0x36;
2499 memset( ipad + key_length, 0x36, block_size - key_length );
2500
2501 /* Copy the key material from ipad to opad, flipping the requisite bits,
2502 * and filling the rest of opad with the requisite constant. */
2503 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002504 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2505 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002506
Gilles Peskine01126fa2018-07-12 17:04:55 +02002507 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002508 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002509 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002510
Gilles Peskine01126fa2018-07-12 17:04:55 +02002511 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002512
2513cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002514 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002515
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002516 return( status );
2517}
John Durkop6ba40d12020-11-10 08:50:04 -08002518#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002519
Gilles Peskine89167cb2018-07-08 20:12:23 +02002520static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002521 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002522 psa_algorithm_t alg,
2523 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002524{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002525 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002526 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002527 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002528 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002529 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002531 /* A context must be freshly initialized before it can be set up. */
2532 if( operation->alg != 0 )
2533 {
2534 return( PSA_ERROR_BAD_STATE );
2535 }
2536
Steven Cooreman15472f82021-03-02 16:16:22 +01002537 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002538 if( status != PSA_SUCCESS )
2539 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002540 if( is_sign )
2541 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002542
Ronald Cron5c522922020-11-14 16:35:34 +01002543 status = psa_get_and_lock_transparent_key_slot_with_policy(
2544 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002545 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002546 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002547
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002548 /* Validate the combination of key type and algorithm */
2549 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002550 if( status != PSA_SUCCESS )
2551 goto exit;
2552
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002553 /* Get the output length for the algorithm and key combination. None of the
2554 * currently supported algorithms have an output length dependent on actual
2555 * key size, so setting it to a bogus value is currently OK. */
2556 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002557
2558 if( operation->mac_size < 4 )
2559 {
2560 /* A very short MAC is too short for security since it can be
2561 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2562 * so we make this our minimum, even though 32 bits is still
2563 * too small for security. */
2564 status = PSA_ERROR_NOT_SUPPORTED;
2565 goto exit;
2566 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002567
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002568 if( operation->mac_size >
2569 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2570 {
2571 /* It's impossible to "truncate" to a larger length than the full length
2572 * of the algorithm. */
2573 status = PSA_ERROR_INVALID_ARGUMENT;
2574 goto exit;
2575 }
2576
Ronald Cron3d471812021-03-18 13:40:31 +01002577#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002578 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002579 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002580 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002581 }
2582 else
Ronald Cron3d471812021-03-18 13:40:31 +01002583#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002584#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002585 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002586 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002587 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002588 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002589 {
2590 status = PSA_ERROR_NOT_SUPPORTED;
2591 goto exit;
2592 }
2593
Gilles Peskine8e338702019-07-30 20:06:31 +02002594 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002595 {
2596 status = PSA_ERROR_INVALID_ARGUMENT;
2597 goto exit;
2598 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002599
Gilles Peskine01126fa2018-07-12 17:04:55 +02002600 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002601 slot->key.data,
2602 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002603 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002604 }
2605 else
John Durkopd0321952020-10-29 21:37:36 -07002606#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002607 {
2608 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002609 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002610
Gilles Peskinefbfac682018-07-08 20:51:54 +02002611exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002612 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002613 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002614 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002615 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002616 else
2617 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002618 operation->key_set = 1;
2619 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002620
Ronald Cron5c522922020-11-14 16:35:34 +01002621 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002622
Ronald Cron5c522922020-11-14 16:35:34 +01002623 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002624}
2625
Gilles Peskine89167cb2018-07-08 20:12:23 +02002626psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002627 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002628 psa_algorithm_t alg )
2629{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002630 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002631}
2632
2633psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002634 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002635 psa_algorithm_t alg )
2636{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002637 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002638}
2639
Gilles Peskine8c9def32018-02-08 10:02:12 +01002640psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2641 const uint8_t *input,
2642 size_t input_length )
2643{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002644 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002645 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002646 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002648 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002649 operation->has_input = 1;
2650
Ronald Cron3d471812021-03-18 13:40:31 +01002651#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002652 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002653 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002654 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2655 input, input_length );
2656 status = mbedtls_to_psa_error( ret );
2657 }
2658 else
Ronald Cron3d471812021-03-18 13:40:31 +01002659#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002660#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002661 if( PSA_ALG_IS_HMAC( operation->alg ) )
2662 {
2663 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2664 input_length );
2665 }
2666 else
John Durkopd0321952020-10-29 21:37:36 -07002667#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002668 {
2669 /* This shouldn't happen if `operation` was initialized by
2670 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002671 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002672 }
2673
Gilles Peskinefbfac682018-07-08 20:51:54 +02002674 if( status != PSA_SUCCESS )
2675 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002676 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002677}
2678
John Durkop6ba40d12020-11-10 08:50:04 -08002679#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002680static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2681 uint8_t *mac,
2682 size_t mac_size )
2683{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002684 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002685 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002686 size_t hash_size = 0;
2687 size_t block_size = psa_get_hash_block_size( hash_alg );
2688 psa_status_t status;
2689
Gilles Peskine01126fa2018-07-12 17:04:55 +02002690 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2691 if( status != PSA_SUCCESS )
2692 return( status );
2693 /* From here on, tmp needs to be wiped. */
2694
2695 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2696 if( status != PSA_SUCCESS )
2697 goto exit;
2698
2699 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2700 if( status != PSA_SUCCESS )
2701 goto exit;
2702
2703 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2704 if( status != PSA_SUCCESS )
2705 goto exit;
2706
Gilles Peskined911eb72018-08-14 15:18:45 +02002707 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2708 if( status != PSA_SUCCESS )
2709 goto exit;
2710
2711 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002712
2713exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002714 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002715 return( status );
2716}
John Durkop6ba40d12020-11-10 08:50:04 -08002717#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002718
mohammad16036df908f2018-04-02 08:34:15 -07002719static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002720 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002721 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002722{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002723 if( ! operation->key_set )
2724 return( PSA_ERROR_BAD_STATE );
2725 if( operation->iv_required && ! operation->iv_set )
2726 return( PSA_ERROR_BAD_STATE );
2727
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728 if( mac_size < operation->mac_size )
2729 return( PSA_ERROR_BUFFER_TOO_SMALL );
2730
Ronald Cron3d471812021-03-18 13:40:31 +01002731#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002732 if( operation->alg == PSA_ALG_CMAC )
2733 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002734 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002735 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2736 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002737 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002738 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002739 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002741 else
Ronald Cron3d471812021-03-18 13:40:31 +01002742#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002743#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002744 if( PSA_ALG_IS_HMAC( operation->alg ) )
2745 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002746 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002747 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002748 }
2749 else
John Durkopd0321952020-10-29 21:37:36 -07002750#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002751 {
2752 /* This shouldn't happen if `operation` was initialized by
2753 * a setup function. */
2754 return( PSA_ERROR_BAD_STATE );
2755 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002756}
2757
Gilles Peskineacd4be32018-07-08 19:56:25 +02002758psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2759 uint8_t *mac,
2760 size_t mac_size,
2761 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002762{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002763 psa_status_t status;
2764
Jaeden Amero252ef282019-02-15 14:05:35 +00002765 if( operation->alg == 0 )
2766 {
2767 return( PSA_ERROR_BAD_STATE );
2768 }
2769
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002770 /* Fill the output buffer with something that isn't a valid mac
2771 * (barring an attack on the mac and deliberately-crafted input),
2772 * in case the caller doesn't check the return status properly. */
2773 *mac_length = mac_size;
2774 /* If mac_size is 0 then mac may be NULL and then the
2775 * call to memset would have undefined behavior. */
2776 if( mac_size != 0 )
2777 memset( mac, '!', mac_size );
2778
Gilles Peskine89167cb2018-07-08 20:12:23 +02002779 if( ! operation->is_sign )
2780 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002781 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002782 }
mohammad16036df908f2018-04-02 08:34:15 -07002783
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002784 status = psa_mac_finish_internal( operation, mac, mac_size );
2785
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002786 if( status == PSA_SUCCESS )
2787 {
2788 status = psa_mac_abort( operation );
2789 if( status == PSA_SUCCESS )
2790 *mac_length = operation->mac_size;
2791 else
2792 memset( mac, '!', mac_size );
2793 }
2794 else
2795 psa_mac_abort( operation );
2796 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002797}
2798
Gilles Peskineacd4be32018-07-08 19:56:25 +02002799psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2800 const uint8_t *mac,
2801 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002802{
Gilles Peskine828ed142018-06-18 23:25:51 +02002803 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002804 psa_status_t status;
2805
Jaeden Amero252ef282019-02-15 14:05:35 +00002806 if( operation->alg == 0 )
2807 {
2808 return( PSA_ERROR_BAD_STATE );
2809 }
2810
Gilles Peskine89167cb2018-07-08 20:12:23 +02002811 if( operation->is_sign )
2812 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002813 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002814 }
2815 if( operation->mac_size != mac_length )
2816 {
2817 status = PSA_ERROR_INVALID_SIGNATURE;
2818 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002819 }
mohammad16036df908f2018-04-02 08:34:15 -07002820
2821 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002822 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002823 if( status != PSA_SUCCESS )
2824 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002825
2826 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2827 status = PSA_ERROR_INVALID_SIGNATURE;
2828
2829cleanup:
2830 if( status == PSA_SUCCESS )
2831 status = psa_mac_abort( operation );
2832 else
2833 psa_mac_abort( operation );
2834
Gilles Peskine3f108122018-12-07 18:14:53 +01002835 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002836
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002837 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002838}
2839
2840
Gilles Peskine20035e32018-02-03 22:44:14 +01002841
Gilles Peskine20035e32018-02-03 22:44:14 +01002842/****************************************************************/
2843/* Asymmetric cryptography */
2844/****************************************************************/
2845
Ronald Cron67b1eb32020-12-08 17:37:27 +01002846psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002847 const psa_key_attributes_t *attributes,
2848 const uint8_t *key_buffer, size_t key_buffer_size,
2849 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2850 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002851{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002852 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002853 {
Ronald Cron4501c982021-03-19 20:09:32 +01002854 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2855 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002856 {
Ronald Cron4501c982021-03-19 20:09:32 +01002857#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2858 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2859 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002860 attributes,
2861 key_buffer, key_buffer_size,
2862 alg, hash, hash_length,
2863 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002864#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2865 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002866 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002867 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002868 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002870 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002871 }
2872 else
Ronald Cron4501c982021-03-19 20:09:32 +01002873 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2874 {
2875 if( PSA_ALG_IS_ECDSA( alg ) )
2876 {
2877#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2878 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2879 return( mbedtls_psa_ecdsa_sign_hash(
2880 attributes,
2881 key_buffer, key_buffer_size,
2882 alg, hash, hash_length,
2883 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002884#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2885 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002886 }
2887 else
2888 {
2889 return( PSA_ERROR_INVALID_ARGUMENT );
2890 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002891 }
Ronald Cron4501c982021-03-19 20:09:32 +01002892
2893 (void)key_buffer;
2894 (void)key_buffer_size;
2895 (void)hash;
2896 (void)hash_length;
2897 (void)signature;
2898 (void)signature_size;
2899 (void)signature_length;
2900
2901 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002902}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002903
2904psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2905 psa_algorithm_t alg,
2906 const uint8_t *hash,
2907 size_t hash_length,
2908 uint8_t *signature,
2909 size_t signature_size,
2910 size_t *signature_length )
2911{
2912 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2913 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2914 psa_key_slot_t *slot;
2915
2916 *signature_length = signature_size;
2917 /* Immediately reject a zero-length signature buffer. This guarantees
2918 * that signature must be a valid pointer. (On the other hand, the hash
2919 * buffer can in principle be empty since it doesn't actually have
2920 * to be a hash.) */
2921 if( signature_size == 0 )
2922 return( PSA_ERROR_BUFFER_TOO_SMALL );
2923
2924 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
2925 PSA_KEY_USAGE_SIGN_HASH,
2926 alg );
2927 if( status != PSA_SUCCESS )
2928 goto exit;
2929 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2930 {
2931 status = PSA_ERROR_INVALID_ARGUMENT;
2932 goto exit;
2933 }
2934
Ronald Cron9f17aa42020-12-08 17:07:25 +01002935 psa_key_attributes_t attributes = {
2936 .core = slot->attr
2937 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002938
Ronald Cron9f17aa42020-12-08 17:07:25 +01002939 status = psa_driver_wrapper_sign_hash(
2940 &attributes, slot->key.data, slot->key.bytes,
2941 alg, hash, hash_length,
2942 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002943
2944exit:
2945 /* Fill the unused part of the output buffer (the whole buffer on error,
2946 * the trailing part on success) with something that isn't a valid mac
2947 * (barring an attack on the mac and deliberately-crafted input),
2948 * in case the caller doesn't check the return status properly. */
2949 if( status == PSA_SUCCESS )
2950 memset( signature + *signature_length, '!',
2951 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02002952 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002953 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002954 /* If signature_size is 0 then we have nothing to do. We must not call
2955 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02002956
Ronald Cron5c522922020-11-14 16:35:34 +01002957 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002958
Ronald Cron5c522922020-11-14 16:35:34 +01002959 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03002960}
2961
Ronald Cron67b1eb32020-12-08 17:37:27 +01002962psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002963 const psa_key_attributes_t *attributes,
2964 const uint8_t *key_buffer, size_t key_buffer_size,
2965 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2966 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002967{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002968 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002969 {
Ronald Cron4501c982021-03-19 20:09:32 +01002970 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2971 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002972 {
Ronald Cron4501c982021-03-19 20:09:32 +01002973#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2974 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2975 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002976 attributes,
2977 key_buffer, key_buffer_size,
2978 alg, hash, hash_length,
2979 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002980#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2981 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002982 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002983 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002984 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002985 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002986 }
itayzafrir5c753392018-05-08 11:18:38 +03002987 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002988 else
Ronald Cron4501c982021-03-19 20:09:32 +01002989 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002990 {
Ronald Cron4501c982021-03-19 20:09:32 +01002991 if( PSA_ALG_IS_ECDSA( alg ) )
2992 {
2993#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2994 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2995 return( mbedtls_psa_ecdsa_verify_hash(
2996 attributes,
2997 key_buffer, key_buffer_size,
2998 alg, hash, hash_length,
2999 signature, signature_length ) );
3000#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3001 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3002 }
3003 else
3004 {
3005 return( PSA_ERROR_INVALID_ARGUMENT );
3006 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003007 }
Ronald Cron4501c982021-03-19 20:09:32 +01003008
3009 (void)key_buffer;
3010 (void)key_buffer_size;
3011 (void)hash;
3012 (void)hash_length;
3013 (void)signature;
3014 (void)signature_length;
3015
3016 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003017}
3018
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003019psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3020 psa_algorithm_t alg,
3021 const uint8_t *hash,
3022 size_t hash_length,
3023 const uint8_t *signature,
3024 size_t signature_length )
3025{
3026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3027 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003028 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003029
3030 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003031 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003032 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003033 if( status != PSA_SUCCESS )
3034 return( status );
3035
Ronald Cron9f17aa42020-12-08 17:07:25 +01003036 psa_key_attributes_t attributes = {
3037 .core = slot->attr
3038 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003039
Ronald Cron9f17aa42020-12-08 17:07:25 +01003040 status = psa_driver_wrapper_verify_hash(
3041 &attributes, slot->key.data, slot->key.bytes,
3042 alg, hash, hash_length,
3043 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003044
Ronald Cron5c522922020-11-14 16:35:34 +01003045 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003046
Ronald Cron5c522922020-11-14 16:35:34 +01003047 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003048}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003049
John Durkop0e005192020-10-31 22:06:54 -07003050#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003051static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3052 mbedtls_rsa_context *rsa )
3053{
3054 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3055 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3056 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3057 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3058}
John Durkop0e005192020-10-31 22:06:54 -07003059#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003060
Ronald Croncf56a0a2020-08-04 09:51:30 +02003061psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003062 psa_algorithm_t alg,
3063 const uint8_t *input,
3064 size_t input_length,
3065 const uint8_t *salt,
3066 size_t salt_length,
3067 uint8_t *output,
3068 size_t output_size,
3069 size_t *output_length )
3070{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003071 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003072 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003073 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003074
Darryl Green5cc689a2018-07-24 15:34:10 +01003075 (void) input;
3076 (void) input_length;
3077 (void) salt;
3078 (void) output;
3079 (void) output_size;
3080
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003081 *output_length = 0;
3082
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003083 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3084 return( PSA_ERROR_INVALID_ARGUMENT );
3085
Ronald Cron5c522922020-11-14 16:35:34 +01003086 status = psa_get_and_lock_transparent_key_slot_with_policy(
3087 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003088 if( status != PSA_SUCCESS )
3089 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003090 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3091 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003092 {
3093 status = PSA_ERROR_INVALID_ARGUMENT;
3094 goto exit;
3095 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096
John Durkop6ba40d12020-11-10 08:50:04 -08003097#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3098 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003099 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003101 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003102 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3103 slot->key.data,
3104 slot->key.bytes,
3105 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003106 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003107 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003108
3109 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003110 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003111 status = PSA_ERROR_BUFFER_TOO_SMALL;
3112 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003113 }
John Durkop0e005192020-10-31 22:06:54 -07003114#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3116 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003117 status = mbedtls_to_psa_error(
3118 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003119 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003120 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003121 MBEDTLS_RSA_PUBLIC,
3122 input_length,
3123 input,
3124 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003125 }
3126 else
John Durkop0e005192020-10-31 22:06:54 -07003127#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3128#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003129 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3130 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003131 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003132 status = mbedtls_to_psa_error(
3133 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003134 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003135 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003136 MBEDTLS_RSA_PUBLIC,
3137 salt, salt_length,
3138 input_length,
3139 input,
3140 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003141 }
3142 else
John Durkop0e005192020-10-31 22:06:54 -07003143#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003144 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003145 status = PSA_ERROR_INVALID_ARGUMENT;
3146 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003147 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003148rsa_exit:
3149 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003150 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003151
Steven Cooremana2371e52020-07-28 14:30:39 +02003152 mbedtls_rsa_free( rsa );
3153 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154 }
3155 else
John Durkop9814fa22020-11-04 12:28:15 -08003156#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003157 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003158 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003159 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003160 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003161
3162exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003163 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003164
Ronald Cron5c522922020-11-14 16:35:34 +01003165 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003166}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167
Ronald Croncf56a0a2020-08-04 09:51:30 +02003168psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003169 psa_algorithm_t alg,
3170 const uint8_t *input,
3171 size_t input_length,
3172 const uint8_t *salt,
3173 size_t salt_length,
3174 uint8_t *output,
3175 size_t output_size,
3176 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003177{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003178 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003179 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003180 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003181
Darryl Green5cc689a2018-07-24 15:34:10 +01003182 (void) input;
3183 (void) input_length;
3184 (void) salt;
3185 (void) output;
3186 (void) output_size;
3187
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003188 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003189
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003190 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3191 return( PSA_ERROR_INVALID_ARGUMENT );
3192
Ronald Cron5c522922020-11-14 16:35:34 +01003193 status = psa_get_and_lock_transparent_key_slot_with_policy(
3194 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003195 if( status != PSA_SUCCESS )
3196 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003197 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003198 {
3199 status = PSA_ERROR_INVALID_ARGUMENT;
3200 goto exit;
3201 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003202
John Durkop6ba40d12020-11-10 08:50:04 -08003203#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3204 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003205 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003206 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003207 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003208 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3209 slot->key.data,
3210 slot->key.bytes,
3211 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003212 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003213 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214
Steven Cooremana2371e52020-07-28 14:30:39 +02003215 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003216 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003217 status = PSA_ERROR_INVALID_ARGUMENT;
3218 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003219 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003220
John Durkop0e005192020-10-31 22:06:54 -07003221#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003222 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003223 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003224 status = mbedtls_to_psa_error(
3225 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003226 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003227 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003228 MBEDTLS_RSA_PRIVATE,
3229 output_length,
3230 input,
3231 output,
3232 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003233 }
3234 else
John Durkop0e005192020-10-31 22:06:54 -07003235#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3236#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003237 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003238 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003239 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003240 status = mbedtls_to_psa_error(
3241 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003242 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003243 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003244 MBEDTLS_RSA_PRIVATE,
3245 salt, salt_length,
3246 output_length,
3247 input,
3248 output,
3249 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003250 }
3251 else
John Durkop0e005192020-10-31 22:06:54 -07003252#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003253 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003254 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003255 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003256
Steven Cooreman4fed4552020-08-03 14:46:03 +02003257rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003258 mbedtls_rsa_free( rsa );
3259 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003260 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003261 else
John Durkop6ba40d12020-11-10 08:50:04 -08003262#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3263 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003264 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003265 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003266 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003267
3268exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003269 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003270
Ronald Cron5c522922020-11-14 16:35:34 +01003271 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003272}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003273
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003274
3275
mohammad1603503973b2018-03-12 15:59:30 +02003276/****************************************************************/
3277/* Symmetric cryptography */
3278/****************************************************************/
3279
Ronald Cronab99ac22020-10-01 16:38:28 +02003280static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3281 mbedtls_svc_key_id_t key,
3282 psa_algorithm_t alg,
3283 mbedtls_operation_t cipher_operation )
3284{
3285 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3286 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3287 psa_key_slot_t *slot;
3288 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3289 PSA_KEY_USAGE_ENCRYPT :
3290 PSA_KEY_USAGE_DECRYPT );
3291
3292 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003293 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003294 return( PSA_ERROR_BAD_STATE );
3295
3296 /* The requested algorithm must be one that can be processed by cipher. */
3297 if( ! PSA_ALG_IS_CIPHER( alg ) )
3298 return( PSA_ERROR_INVALID_ARGUMENT );
3299
3300 /* Fetch key material from key storage. */
3301 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3302 if( status != PSA_SUCCESS )
3303 goto exit;
3304
Ronald Cron49fafa92021-03-10 08:34:23 +01003305 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003306 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003307 * so we only set it (in the driver wrapper) after resources have been
3308 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003309 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003310 if( alg == PSA_ALG_ECB_NO_PADDING )
3311 operation->iv_required = 0;
3312 else
3313 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003314 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003315
Ronald Crona4af55f2020-12-14 14:36:06 +01003316 psa_key_attributes_t attributes = {
3317 .core = slot->attr
3318 };
3319
Ronald Cronab99ac22020-10-01 16:38:28 +02003320 /* Try doing the operation through a driver before using software fallback. */
3321 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003322 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3323 &attributes,
3324 slot->key.data,
3325 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003326 alg );
3327 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003328 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3329 &attributes,
3330 slot->key.data,
3331 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003332 alg );
3333
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003334exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003335 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003336 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003337
Ronald Cron5c522922020-11-14 16:35:34 +01003338 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003339
Ronald Cron5c522922020-11-14 16:35:34 +01003340 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003341}
3342
Gilles Peskinefe119512018-07-08 21:39:34 +02003343psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003344 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003345 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003346{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003347 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003348}
3349
Gilles Peskinefe119512018-07-08 21:39:34 +02003350psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003351 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003352 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003353{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003354 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003355}
3356
Gilles Peskinefe119512018-07-08 21:39:34 +02003357psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003358 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003359 size_t iv_size,
3360 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003361{
Ronald Cron6d051732020-10-01 14:10:20 +02003362 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003363
Ronald Cron5618a392021-03-26 09:52:26 +01003364 *iv_length = 0;
3365
Ronald Cron49fafa92021-03-10 08:34:23 +01003366 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003367 {
3368 return( PSA_ERROR_BAD_STATE );
3369 }
3370
Steven Cooreman7df02922020-09-09 15:28:49 +02003371 if( operation->iv_set || ! operation->iv_required )
3372 {
3373 return( PSA_ERROR_BAD_STATE );
3374 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003375
Ronald Cron5618a392021-03-26 09:52:26 +01003376 if( iv_size < operation->default_iv_length )
3377 {
3378 status = PSA_ERROR_BUFFER_TOO_SMALL;
3379 goto exit;
3380 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003381
Ronald Cron5618a392021-03-26 09:52:26 +01003382 status = psa_generate_random( iv, operation->default_iv_length );
3383 if( status != PSA_SUCCESS )
3384 goto exit;
3385
3386 status = psa_driver_wrapper_cipher_set_iv( operation,
3387 iv,
3388 operation->default_iv_length );
3389
3390exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003391 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003392 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003393 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003394 *iv_length = operation->default_iv_length;
3395 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003396 else
Moran Peker395db872018-05-31 14:07:14 +03003397 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003398
itayzafrir534bd7c2018-08-02 13:56:32 +03003399 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003400}
3401
Gilles Peskinefe119512018-07-08 21:39:34 +02003402psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003403 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003404 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003405{
Ronald Cron6d051732020-10-01 14:10:20 +02003406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003407
Ronald Cron49fafa92021-03-10 08:34:23 +01003408 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003409 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003410
Steven Cooreman7df02922020-09-09 15:28:49 +02003411 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003412 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003413
3414 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3415 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003416
Ronald Crondd24c9b2020-12-15 14:10:01 +01003417 status = psa_driver_wrapper_cipher_set_iv( operation,
3418 iv,
3419 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003420
itayzafrir534bd7c2018-08-02 13:56:32 +03003421 if( status == PSA_SUCCESS )
3422 operation->iv_set = 1;
3423 else
mohammad1603503973b2018-03-12 15:59:30 +02003424 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003425 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003426}
3427
Gilles Peskinee553c652018-06-04 16:22:46 +02003428psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3429 const uint8_t *input,
3430 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003431 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003432 size_t output_size,
3433 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003434{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003436
Ronald Cron49fafa92021-03-10 08:34:23 +01003437 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003438 {
3439 return( PSA_ERROR_BAD_STATE );
3440 }
3441 if( operation->iv_required && ! operation->iv_set )
3442 {
3443 return( PSA_ERROR_BAD_STATE );
3444 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003445
Ronald Crondd24c9b2020-12-15 14:10:01 +01003446 status = psa_driver_wrapper_cipher_update( operation,
3447 input,
3448 input_length,
3449 output,
3450 output_size,
3451 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003452 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003453 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003454
itayzafrir534bd7c2018-08-02 13:56:32 +03003455 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003456}
3457
Gilles Peskinee553c652018-06-04 16:22:46 +02003458psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3459 uint8_t *output,
3460 size_t output_size,
3461 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003462{
David Saadab4ecc272019-02-14 13:48:10 +02003463 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003464
Ronald Cron49fafa92021-03-10 08:34:23 +01003465 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003466 {
3467 return( PSA_ERROR_BAD_STATE );
3468 }
3469 if( operation->iv_required && ! operation->iv_set )
3470 {
3471 return( PSA_ERROR_BAD_STATE );
3472 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003473
Ronald Crondd24c9b2020-12-15 14:10:01 +01003474 status = psa_driver_wrapper_cipher_finish( operation,
3475 output,
3476 output_size,
3477 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003478 if( status == PSA_SUCCESS )
3479 return( psa_cipher_abort( operation ) );
3480 else
3481 {
3482 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003483 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003484
Steven Cooremanef8575e2020-09-11 11:44:50 +02003485 return( status );
3486 }
mohammad1603503973b2018-03-12 15:59:30 +02003487}
3488
Gilles Peskinee553c652018-06-04 16:22:46 +02003489psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3490{
Ronald Cron49fafa92021-03-10 08:34:23 +01003491 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003492 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003493 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003494 * in use. It's ok to call abort on such an object, and there's
3495 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003496 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003497 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003498
Ronald Crondd24c9b2020-12-15 14:10:01 +01003499 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003500
Ronald Cron49fafa92021-03-10 08:34:23 +01003501 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003502 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003503 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003504
Moran Peker395db872018-05-31 14:07:14 +03003505 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003506}
3507
mohammad16035955c982018-04-26 00:53:03 +03003508/****************************************************************/
3509/* AEAD */
3510/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003511
Ronald Cron215633c2021-03-16 17:15:37 +01003512psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
3513 psa_algorithm_t alg,
3514 const uint8_t *nonce,
3515 size_t nonce_length,
3516 const uint8_t *additional_data,
3517 size_t additional_data_length,
3518 const uint8_t *plaintext,
3519 size_t plaintext_length,
3520 uint8_t *ciphertext,
3521 size_t ciphertext_size,
3522 size_t *ciphertext_length )
3523{
3524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3525 psa_key_slot_t *slot;
3526
3527 *ciphertext_length = 0;
3528
Ronald Cron9a986162021-03-26 12:40:07 +01003529 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003530 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
3531 if( status != PSA_SUCCESS )
3532 return( status );
3533
3534 psa_key_attributes_t attributes = {
3535 .core = slot->attr
3536 };
3537
Ronald Cronde822812021-03-17 16:08:20 +01003538 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003539 &attributes, slot->key.data, slot->key.bytes,
3540 alg,
3541 nonce, nonce_length,
3542 additional_data, additional_data_length,
3543 plaintext, plaintext_length,
3544 ciphertext, ciphertext_size, ciphertext_length );
3545
3546 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3547 memset( ciphertext, 0, ciphertext_size );
3548
Ronald Cron9f310172021-03-16 16:36:37 +01003549 psa_unlock_key_slot( slot );
Ronald Cron7dbd8002021-03-16 16:30:42 +01003550
Gilles Peskineedf9a652018-08-17 18:11:56 +02003551 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003552}
3553
Ronald Cron215633c2021-03-16 17:15:37 +01003554psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
3555 psa_algorithm_t alg,
3556 const uint8_t *nonce,
3557 size_t nonce_length,
3558 const uint8_t *additional_data,
3559 size_t additional_data_length,
3560 const uint8_t *ciphertext,
3561 size_t ciphertext_length,
3562 uint8_t *plaintext,
3563 size_t plaintext_size,
3564 size_t *plaintext_length )
3565{
3566 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3567 psa_key_slot_t *slot;
3568
3569 *plaintext_length = 0;
3570
Ronald Cron9a986162021-03-26 12:40:07 +01003571 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003572 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
3573 if( status != PSA_SUCCESS )
3574 return( status );
3575
3576 psa_key_attributes_t attributes = {
3577 .core = slot->attr
3578 };
3579
Ronald Cronde822812021-03-17 16:08:20 +01003580 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003581 &attributes, slot->key.data, slot->key.bytes,
3582 alg,
3583 nonce, nonce_length,
3584 additional_data, additional_data_length,
3585 ciphertext, ciphertext_length,
3586 plaintext, plaintext_size, plaintext_length );
3587
3588 if( status != PSA_SUCCESS && plaintext_size != 0 )
3589 memset( plaintext, 0, plaintext_size );
3590
3591 psa_unlock_key_slot( slot );
3592
3593 return( status );
3594}
3595
Gilles Peskinee59236f2018-01-27 23:32:46 +01003596/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003597/* Generators */
3598/****************************************************************/
3599
John Durkop07cc04a2020-11-16 22:08:34 -08003600#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3601 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3602 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3603#define AT_LEAST_ONE_BUILTIN_KDF
3604#endif
3605
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 );
3635 status = psa_hmac_abort_internal( &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 {
Janos Follath6a1d2622019-06-11 10:37:28 +01003645 if( operation->ctx.tls12_prf.seed != NULL )
3646 {
3647 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3648 operation->ctx.tls12_prf.seed_length );
3649 mbedtls_free( operation->ctx.tls12_prf.seed );
3650 }
3651
3652 if( operation->ctx.tls12_prf.label != NULL )
3653 {
3654 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3655 operation->ctx.tls12_prf.label_length );
3656 mbedtls_free( operation->ctx.tls12_prf.label );
3657 }
3658
3659 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
3660
3661 /* We leave the fields Ai and output_block to be erased safely by the
3662 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003663 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003664 else
John Durkop07cc04a2020-11-16 22:08:34 -08003665#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3666 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003667 {
3668 status = PSA_ERROR_BAD_STATE;
3669 }
Janos Follath083036a2019-06-11 10:22:26 +01003670 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003671 return( status );
3672}
3673
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003674psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003675 size_t *capacity)
3676{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003677 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003678 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003679 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003680 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003681 }
3682
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003683 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003684 return( PSA_SUCCESS );
3685}
3686
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003687psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003688 size_t capacity )
3689{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003690 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003691 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003692 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003693 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003694 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003695 return( PSA_SUCCESS );
3696}
3697
John Durkopd0321952020-10-29 21:37:36 -07003698#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003699/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003700 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003701static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003702 psa_algorithm_t hash_alg,
3703 uint8_t *output,
3704 size_t output_length )
3705{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003706 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003707 psa_status_t status;
3708
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003709 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3710 return( PSA_ERROR_BAD_STATE );
3711 hkdf->state = HKDF_STATE_OUTPUT;
3712
Gilles Peskinebef7f142018-07-12 17:22:21 +02003713 while( output_length != 0 )
3714 {
3715 /* Copy what remains of the current block */
3716 uint8_t n = hash_length - hkdf->offset_in_block;
3717 if( n > output_length )
3718 n = (uint8_t) output_length;
3719 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3720 output += n;
3721 output_length -= n;
3722 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003723 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003724 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003725 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003726 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003727 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003728 * object was corrupted or if this function is called directly
3729 * inside the library. */
3730 if( hkdf->block_number == 0xff )
3731 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003732
3733 /* We need a new block */
3734 ++hkdf->block_number;
3735 hkdf->offset_in_block = 0;
3736 status = psa_hmac_setup_internal( &hkdf->hmac,
3737 hkdf->prk, hash_length,
3738 hash_alg );
3739 if( status != PSA_SUCCESS )
3740 return( status );
3741 if( hkdf->block_number != 1 )
3742 {
3743 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3744 hkdf->output_block,
3745 hash_length );
3746 if( status != PSA_SUCCESS )
3747 return( status );
3748 }
3749 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3750 hkdf->info,
3751 hkdf->info_length );
3752 if( status != PSA_SUCCESS )
3753 return( status );
3754 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3755 &hkdf->block_number, 1 );
3756 if( status != PSA_SUCCESS )
3757 return( status );
3758 status = psa_hmac_finish_internal( &hkdf->hmac,
3759 hkdf->output_block,
3760 sizeof( hkdf->output_block ) );
3761 if( status != PSA_SUCCESS )
3762 return( status );
3763 }
3764
3765 return( PSA_SUCCESS );
3766}
John Durkop07cc04a2020-11-16 22:08:34 -08003767#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003768
John Durkop07cc04a2020-11-16 22:08:34 -08003769#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3770 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003771static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3772 psa_tls12_prf_key_derivation_t *tls12_prf,
3773 psa_algorithm_t alg )
3774{
3775 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003776 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01003777 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
3778 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003779
Janos Follath7742fee2019-06-17 12:58:10 +01003780 /* We can't be wanting more output after block 0xff, otherwise
3781 * the capacity check in psa_key_derivation_output_bytes() would have
3782 * prevented this call. It could happen only if the operation
3783 * object was corrupted or if this function is called directly
3784 * inside the library. */
3785 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003786 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003787
3788 /* We need a new block */
3789 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003790 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003791
3792 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3793 *
3794 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3795 *
3796 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3797 * HMAC_hash(secret, A(2) + seed) +
3798 * HMAC_hash(secret, A(3) + seed) + ...
3799 *
3800 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003801 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003802 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003803 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003804 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003805 * is currently extracted as `output_block` and where i is
3806 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003807 */
3808
Janos Follathea29bfb2019-06-19 12:21:20 +01003809 /* Save the hash context before using it, to preserve the hash state with
3810 * only the inner padding in it. We need this, because inner padding depends
3811 * on the key (secret in the RFC's terminology). */
3812 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
3813 if( status != PSA_SUCCESS )
3814 goto cleanup;
3815
3816 /* Calculate A(i) where i = tls12_prf->block_number. */
3817 if( tls12_prf->block_number == 1 )
3818 {
3819 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3820 * the variable seed and in this instance means it in the context of the
3821 * P_hash function, where seed = label + seed.) */
3822 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3823 tls12_prf->label, tls12_prf->label_length );
3824 if( status != PSA_SUCCESS )
3825 goto cleanup;
3826 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3827 tls12_prf->seed, tls12_prf->seed_length );
3828 if( status != PSA_SUCCESS )
3829 goto cleanup;
3830 }
3831 else
3832 {
3833 /* A(i) = HMAC_hash(secret, A(i-1)) */
3834 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3835 tls12_prf->Ai, hash_length );
3836 if( status != PSA_SUCCESS )
3837 goto cleanup;
3838 }
3839
3840 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3841 tls12_prf->Ai, hash_length );
3842 if( status != PSA_SUCCESS )
3843 goto cleanup;
3844 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3845 if( status != PSA_SUCCESS )
3846 goto cleanup;
3847
3848 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
3849 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3850 tls12_prf->Ai, hash_length );
3851 if( status != PSA_SUCCESS )
3852 goto cleanup;
3853 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3854 tls12_prf->label, tls12_prf->label_length );
3855 if( status != PSA_SUCCESS )
3856 goto cleanup;
3857 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3858 tls12_prf->seed, tls12_prf->seed_length );
3859 if( status != PSA_SUCCESS )
3860 goto cleanup;
3861 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3862 tls12_prf->output_block, hash_length );
3863 if( status != PSA_SUCCESS )
3864 goto cleanup;
3865 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3866 if( status != PSA_SUCCESS )
3867 goto cleanup;
3868
Janos Follath7742fee2019-06-17 12:58:10 +01003869
3870cleanup:
3871
Janos Follathea29bfb2019-06-19 12:21:20 +01003872 cleanup_status = psa_hash_abort( &backup );
3873 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3874 status = cleanup_status;
3875
3876 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003877}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003878
Janos Follath844eb0e2019-06-19 12:10:49 +01003879static psa_status_t psa_key_derivation_tls12_prf_read(
3880 psa_tls12_prf_key_derivation_t *tls12_prf,
3881 psa_algorithm_t alg,
3882 uint8_t *output,
3883 size_t output_length )
3884{
3885 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003886 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003887 psa_status_t status;
3888 uint8_t offset, length;
3889
3890 while( output_length != 0 )
3891 {
3892 /* Check if we have fully processed the current block. */
3893 if( tls12_prf->left_in_block == 0 )
3894 {
3895 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3896 alg );
3897 if( status != PSA_SUCCESS )
3898 return( status );
3899
3900 continue;
3901 }
3902
3903 if( tls12_prf->left_in_block > output_length )
3904 length = (uint8_t) output_length;
3905 else
3906 length = tls12_prf->left_in_block;
3907
3908 offset = hash_length - tls12_prf->left_in_block;
3909 memcpy( output, tls12_prf->output_block + offset, length );
3910 output += length;
3911 output_length -= length;
3912 tls12_prf->left_in_block -= length;
3913 }
3914
3915 return( PSA_SUCCESS );
3916}
John Durkop07cc04a2020-11-16 22:08:34 -08003917#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3918 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003919
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003920psa_status_t psa_key_derivation_output_bytes(
3921 psa_key_derivation_operation_t *operation,
3922 uint8_t *output,
3923 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003924{
3925 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003926 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003927
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003928 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003929 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003930 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003931 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003932 }
3933
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003934 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003935 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003936 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003937 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003938 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003939 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003940 goto exit;
3941 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003942 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003943 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003944 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003945 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003946 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3947 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003948 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003949 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003950 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003951 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003952 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003953
John Durkopd0321952020-10-29 21:37:36 -07003954#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003955 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003956 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003957 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003958 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003959 output, output_length );
3960 }
Janos Follathadbec812019-06-14 11:05:39 +01003961 else
John Durkop07cc04a2020-11-16 22:08:34 -08003962#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3963#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3964 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003965 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003966 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003967 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003968 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003969 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003970 output_length );
3971 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003972 else
John Durkop07cc04a2020-11-16 22:08:34 -08003973#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3974 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003975 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003976 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003977 return( PSA_ERROR_BAD_STATE );
3978 }
3979
3980exit:
3981 if( status != PSA_SUCCESS )
3982 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003983 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003984 * This allows us to differentiate between exhausted operations and
3985 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3986 * operations. */
3987 psa_algorithm_t alg = operation->alg;
3988 psa_key_derivation_abort( operation );
3989 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003990 memset( output, '!', output_length );
3991 }
3992 return( status );
3993}
3994
David Brown7807bf72021-02-09 16:28:23 -07003995#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003996static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3997{
3998 if( data_size >= 8 )
3999 mbedtls_des_key_set_parity( data );
4000 if( data_size >= 16 )
4001 mbedtls_des_key_set_parity( data + 8 );
4002 if( data_size >= 24 )
4003 mbedtls_des_key_set_parity( data + 16 );
4004}
David Brown7807bf72021-02-09 16:28:23 -07004005#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004006
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004007static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004008 psa_key_slot_t *slot,
4009 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004010 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004011{
4012 uint8_t *data = NULL;
4013 size_t bytes = PSA_BITS_TO_BYTES( bits );
4014 psa_status_t status;
4015
Gilles Peskine8e338702019-07-30 20:06:31 +02004016 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004017 return( PSA_ERROR_INVALID_ARGUMENT );
4018 if( bits % 8 != 0 )
4019 return( PSA_ERROR_INVALID_ARGUMENT );
4020 data = mbedtls_calloc( 1, bytes );
4021 if( data == NULL )
4022 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4023
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004024 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004025 if( status != PSA_SUCCESS )
4026 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004027#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004028 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004029 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004030#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004031
4032 status = psa_allocate_buffer_to_slot( slot, bytes );
4033 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004034 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004035
Ronald Cronbf33c932020-11-28 18:06:53 +01004036 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004037 psa_key_attributes_t attributes = {
4038 .core = slot->attr
4039 };
4040
Ronald Cronbf33c932020-11-28 18:06:53 +01004041 status = psa_driver_wrapper_import_key( &attributes,
4042 data, bytes,
4043 slot->key.data,
4044 slot->key.bytes,
4045 &slot->key.bytes, &bits );
4046 if( bits != slot->attr.bits )
4047 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004048
4049exit:
4050 mbedtls_free( data );
4051 return( status );
4052}
4053
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004054psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004055 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004056 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004057{
4058 psa_status_t status;
4059 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004060 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004061
Ronald Cron81709fc2020-11-14 12:10:32 +01004062 *key = MBEDTLS_SVC_KEY_ID_INIT;
4063
Gilles Peskine0f84d622019-09-12 19:03:13 +02004064 /* Reject any attempt to create a zero-length key so that we don't
4065 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4066 if( psa_get_key_bits( attributes ) == 0 )
4067 return( PSA_ERROR_INVALID_ARGUMENT );
4068
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004069 if( ! operation->can_output_key )
4070 return( PSA_ERROR_NOT_PERMITTED );
4071
Ronald Cron81709fc2020-11-14 12:10:32 +01004072 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4073 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004074#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4075 if( driver != NULL )
4076 {
4077 /* Deriving a key in a secure element is not implemented yet. */
4078 status = PSA_ERROR_NOT_SUPPORTED;
4079 }
4080#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004081 if( status == PSA_SUCCESS )
4082 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004083 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004084 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004085 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004086 }
4087 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004088 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004089 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004090 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004091
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004092 return( status );
4093}
4094
Gilles Peskineeab56e42018-07-12 17:12:33 +02004095
4096
4097/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004098/* Key derivation */
4099/****************************************************************/
4100
Steven Cooreman932ffb72021-02-15 12:14:32 +01004101#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004102static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004103 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004104 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004105{
John Durkop07cc04a2020-11-16 22:08:34 -08004106 int is_kdf_alg_supported;
4107
Janos Follath5fe19732019-06-20 15:09:30 +01004108 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4109 * initialisers for this union leave some bytes unspecified.) */
4110 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4111
Gilles Peskine969c5d62019-01-16 15:53:06 +01004112 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004113#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004114 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4115 is_kdf_alg_supported = 1;
4116 else
4117#endif
4118#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4119 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4120 is_kdf_alg_supported = 1;
4121 else
4122#endif
4123#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4124 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4125 is_kdf_alg_supported = 1;
4126 else
4127#endif
4128 is_kdf_alg_supported = 0;
4129
4130 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004131 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004132 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004133 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004134 if( hash_size == 0 )
4135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004136 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4137 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004138 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004139 {
4140 return( PSA_ERROR_NOT_SUPPORTED );
4141 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004142 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004143 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004144 }
John Durkop07cc04a2020-11-16 22:08:34 -08004145
4146 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004147}
John Durkop07cc04a2020-11-16 22:08:34 -08004148#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004149
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004150psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004151 psa_algorithm_t alg )
4152{
4153 psa_status_t status;
4154
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004155 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004156 return( PSA_ERROR_BAD_STATE );
4157
Gilles Peskine6843c292019-01-18 16:44:49 +01004158 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4159 return( PSA_ERROR_INVALID_ARGUMENT );
4160 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004161 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004162#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004163 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004164 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004165#else
4166 return( PSA_ERROR_NOT_SUPPORTED );
4167#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004168 }
4169 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4170 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004171#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004172 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004173#else
4174 return( PSA_ERROR_NOT_SUPPORTED );
4175#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004176 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004177 else
4178 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004179
4180 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004181 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004182 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004183}
4184
John Durkopd0321952020-10-29 21:37:36 -07004185#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004186static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004187 psa_algorithm_t hash_alg,
4188 psa_key_derivation_step_t step,
4189 const uint8_t *data,
4190 size_t data_length )
4191{
4192 psa_status_t status;
4193 switch( step )
4194 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004195 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004196 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004197 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004198 status = psa_hmac_setup_internal( &hkdf->hmac,
4199 data, data_length,
4200 hash_alg );
4201 if( status != PSA_SUCCESS )
4202 return( status );
4203 hkdf->state = HKDF_STATE_STARTED;
4204 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004205 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004206 /* If no salt was provided, use an empty salt. */
4207 if( hkdf->state == HKDF_STATE_INIT )
4208 {
4209 status = psa_hmac_setup_internal( &hkdf->hmac,
4210 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004211 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004212 if( status != PSA_SUCCESS )
4213 return( status );
4214 hkdf->state = HKDF_STATE_STARTED;
4215 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004216 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004217 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004218 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4219 data, data_length );
4220 if( status != PSA_SUCCESS )
4221 return( status );
4222 status = psa_hmac_finish_internal( &hkdf->hmac,
4223 hkdf->prk,
4224 sizeof( hkdf->prk ) );
4225 if( status != PSA_SUCCESS )
4226 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004227 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004228 hkdf->block_number = 0;
4229 hkdf->state = HKDF_STATE_KEYED;
4230 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004231 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004232 if( hkdf->state == HKDF_STATE_OUTPUT )
4233 return( PSA_ERROR_BAD_STATE );
4234 if( hkdf->info_set )
4235 return( PSA_ERROR_BAD_STATE );
4236 hkdf->info_length = data_length;
4237 if( data_length != 0 )
4238 {
4239 hkdf->info = mbedtls_calloc( 1, data_length );
4240 if( hkdf->info == NULL )
4241 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4242 memcpy( hkdf->info, data, data_length );
4243 }
4244 hkdf->info_set = 1;
4245 return( PSA_SUCCESS );
4246 default:
4247 return( PSA_ERROR_INVALID_ARGUMENT );
4248 }
4249}
John Durkop07cc04a2020-11-16 22:08:34 -08004250#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004251
John Durkop07cc04a2020-11-16 22:08:34 -08004252#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4253 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004254static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4255 const uint8_t *data,
4256 size_t data_length )
4257{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004258 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004259 return( PSA_ERROR_BAD_STATE );
4260
Janos Follathd6dce9f2019-07-04 09:11:38 +01004261 if( data_length != 0 )
4262 {
4263 prf->seed = mbedtls_calloc( 1, data_length );
4264 if( prf->seed == NULL )
4265 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004266
Janos Follathd6dce9f2019-07-04 09:11:38 +01004267 memcpy( prf->seed, data, data_length );
4268 prf->seed_length = data_length;
4269 }
Janos Follathf08e2652019-06-13 09:05:41 +01004270
Gilles Peskine43f958b2020-12-13 14:55:14 +01004271 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004272
4273 return( PSA_SUCCESS );
4274}
4275
Janos Follath81550542019-06-13 14:26:34 +01004276static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4277 psa_algorithm_t hash_alg,
4278 const uint8_t *data,
4279 size_t data_length )
4280{
4281 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004282 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004283 return( PSA_ERROR_BAD_STATE );
4284
4285 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4286 if( status != PSA_SUCCESS )
4287 return( status );
4288
Gilles Peskine43f958b2020-12-13 14:55:14 +01004289 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004290
4291 return( PSA_SUCCESS );
4292}
4293
Janos Follath63028dd2019-06-13 09:15:47 +01004294static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4295 const uint8_t *data,
4296 size_t data_length )
4297{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004298 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004299 return( PSA_ERROR_BAD_STATE );
4300
Janos Follathd6dce9f2019-07-04 09:11:38 +01004301 if( data_length != 0 )
4302 {
4303 prf->label = mbedtls_calloc( 1, data_length );
4304 if( prf->label == NULL )
4305 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004306
Janos Follathd6dce9f2019-07-04 09:11:38 +01004307 memcpy( prf->label, data, data_length );
4308 prf->label_length = data_length;
4309 }
Janos Follath63028dd2019-06-13 09:15:47 +01004310
Gilles Peskine43f958b2020-12-13 14:55:14 +01004311 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004312
4313 return( PSA_SUCCESS );
4314}
4315
Janos Follathb03233e2019-06-11 15:30:30 +01004316static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4317 psa_algorithm_t hash_alg,
4318 psa_key_derivation_step_t step,
4319 const uint8_t *data,
4320 size_t data_length )
4321{
Janos Follathb03233e2019-06-11 15:30:30 +01004322 switch( step )
4323 {
Janos Follathf08e2652019-06-13 09:05:41 +01004324 case PSA_KEY_DERIVATION_INPUT_SEED:
4325 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004326 case PSA_KEY_DERIVATION_INPUT_SECRET:
4327 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004328 case PSA_KEY_DERIVATION_INPUT_LABEL:
4329 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004330 default:
4331 return( PSA_ERROR_INVALID_ARGUMENT );
4332 }
4333}
John Durkop07cc04a2020-11-16 22:08:34 -08004334#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4335 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4336
4337#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4338static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4339 psa_tls12_prf_key_derivation_t *prf,
4340 psa_algorithm_t hash_alg,
4341 const uint8_t *data,
4342 size_t data_length )
4343{
4344 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004345 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004346 uint8_t *cur = pms;
4347
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004348 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004349 return( PSA_ERROR_INVALID_ARGUMENT );
4350
4351 /* Quoting RFC 4279, Section 2:
4352 *
4353 * The premaster secret is formed as follows: if the PSK is N octets
4354 * long, concatenate a uint16 with the value N, N zero octets, a second
4355 * uint16 with the value N, and the PSK itself.
4356 */
4357
4358 *cur++ = ( data_length >> 8 ) & 0xff;
4359 *cur++ = ( data_length >> 0 ) & 0xff;
4360 memset( cur, 0, data_length );
4361 cur += data_length;
4362 *cur++ = pms[0];
4363 *cur++ = pms[1];
4364 memcpy( cur, data, data_length );
4365 cur += data_length;
4366
4367 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
4368
4369 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4370 return( status );
4371}
Janos Follath6660f0e2019-06-17 08:44:03 +01004372
4373static psa_status_t psa_tls12_prf_psk_to_ms_input(
4374 psa_tls12_prf_key_derivation_t *prf,
4375 psa_algorithm_t hash_alg,
4376 psa_key_derivation_step_t step,
4377 const uint8_t *data,
4378 size_t data_length )
4379{
4380 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004381 {
Janos Follath6660f0e2019-06-17 08:44:03 +01004382 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
4383 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004384 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004385
4386 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
4387}
John Durkop07cc04a2020-11-16 22:08:34 -08004388#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004389
Gilles Peskineb8965192019-09-24 16:21:10 +02004390/** Check whether the given key type is acceptable for the given
4391 * input step of a key derivation.
4392 *
4393 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4394 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4395 * Both secret and non-secret inputs can alternatively have the type
4396 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4397 * that the input was passed as a buffer rather than via a key object.
4398 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004399static int psa_key_derivation_check_input_type(
4400 psa_key_derivation_step_t step,
4401 psa_key_type_t key_type )
4402{
4403 switch( step )
4404 {
4405 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004406 if( key_type == PSA_KEY_TYPE_DERIVE )
4407 return( PSA_SUCCESS );
4408 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004409 return( PSA_SUCCESS );
4410 break;
4411 case PSA_KEY_DERIVATION_INPUT_LABEL:
4412 case PSA_KEY_DERIVATION_INPUT_SALT:
4413 case PSA_KEY_DERIVATION_INPUT_INFO:
4414 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004415 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4416 return( PSA_SUCCESS );
4417 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004418 return( PSA_SUCCESS );
4419 break;
4420 }
4421 return( PSA_ERROR_INVALID_ARGUMENT );
4422}
4423
Janos Follathb80a94e2019-06-12 15:54:46 +01004424static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004425 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004426 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004427 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004428 const uint8_t *data,
4429 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004430{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004431 psa_status_t status;
4432 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4433
4434 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004435 if( status != PSA_SUCCESS )
4436 goto exit;
4437
John Durkopd0321952020-10-29 21:37:36 -07004438#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004439 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004440 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004441 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004442 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004443 step, data, data_length );
4444 }
John Durkop07cc04a2020-11-16 22:08:34 -08004445 else
4446#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4447#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4448 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004449 {
Janos Follathb03233e2019-06-11 15:30:30 +01004450 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
4451 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4452 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004453 }
John Durkop07cc04a2020-11-16 22:08:34 -08004454 else
4455#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4456#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4457 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004458 {
4459 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
4460 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4461 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004462 }
4463 else
John Durkop07cc04a2020-11-16 22:08:34 -08004464#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004465 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004466 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004467 (void) data;
4468 (void) data_length;
4469 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004470 return( PSA_ERROR_BAD_STATE );
4471 }
4472
Gilles Peskine224b0d62019-09-23 18:13:17 +02004473exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004474 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004475 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004476 return( status );
4477}
4478
Janos Follath51f4a0f2019-06-14 11:35:55 +01004479psa_status_t psa_key_derivation_input_bytes(
4480 psa_key_derivation_operation_t *operation,
4481 psa_key_derivation_step_t step,
4482 const uint8_t *data,
4483 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004484{
Gilles Peskineb8965192019-09-24 16:21:10 +02004485 return( psa_key_derivation_input_internal( operation, step,
4486 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004487 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004488}
4489
Janos Follath51f4a0f2019-06-14 11:35:55 +01004490psa_status_t psa_key_derivation_input_key(
4491 psa_key_derivation_operation_t *operation,
4492 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004493 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004494{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004495 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004496 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004497 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004498
Ronald Cron5c522922020-11-14 16:35:34 +01004499 status = psa_get_and_lock_transparent_key_slot_with_policy(
4500 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004501 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004502 {
4503 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004504 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004505 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004506
4507 /* Passing a key object as a SECRET input unlocks the permission
4508 * to output to a key object. */
4509 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4510 operation->can_output_key = 1;
4511
Ronald Cronf95a2b12020-10-22 15:24:49 +02004512 status = psa_key_derivation_input_internal( operation,
4513 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004514 slot->key.data,
4515 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004516
Ronald Cron5c522922020-11-14 16:35:34 +01004517 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004518
Ronald Cron5c522922020-11-14 16:35:34 +01004519 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004520}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004521
4522
4523
4524/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004525/* Key agreement */
4526/****************************************************************/
4527
John Durkop6ba40d12020-11-10 08:50:04 -08004528#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004529static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4530 size_t peer_key_length,
4531 const mbedtls_ecp_keypair *our_key,
4532 uint8_t *shared_secret,
4533 size_t shared_secret_size,
4534 size_t *shared_secret_length )
4535{
Steven Cooremand4867872020-08-05 16:31:39 +02004536 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004537 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004538 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004539 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004540 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004541 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004542
Ronald Cron90857082020-11-25 14:58:33 +01004543 status = mbedtls_psa_ecp_load_representation(
4544 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004545 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004546 peer_key,
4547 peer_key_length,
4548 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004549 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004550 goto exit;
4551
Jaeden Amero97271b32019-01-10 19:38:51 +00004552 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004553 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004554 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004555 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004556 status = mbedtls_to_psa_error(
4557 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4558 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004559 goto exit;
4560
Jaeden Amero97271b32019-01-10 19:38:51 +00004561 status = mbedtls_to_psa_error(
4562 mbedtls_ecdh_calc_secret( &ecdh,
4563 shared_secret_length,
4564 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004565 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004566 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004567 if( status != PSA_SUCCESS )
4568 goto exit;
4569 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4570 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004571
4572exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004573 if( status != PSA_SUCCESS )
4574 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004575 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004576 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004577 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004578
Jaeden Amero97271b32019-01-10 19:38:51 +00004579 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004580}
John Durkop6ba40d12020-11-10 08:50:04 -08004581#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004582
Gilles Peskine01d718c2018-09-18 12:01:02 +02004583#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4584
Gilles Peskine0216fe12019-04-11 21:23:21 +02004585static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4586 psa_key_slot_t *private_key,
4587 const uint8_t *peer_key,
4588 size_t peer_key_length,
4589 uint8_t *shared_secret,
4590 size_t shared_secret_size,
4591 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004592{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004593 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004594 {
John Durkop6ba40d12020-11-10 08:50:04 -08004595#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004596 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004597 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004598 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004599 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004600 psa_status_t status = mbedtls_psa_ecp_load_representation(
4601 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004602 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004603 private_key->key.data,
4604 private_key->key.bytes,
4605 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004606 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004607 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004608 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004609 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004610 shared_secret, shared_secret_size,
4611 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004612 mbedtls_ecp_keypair_free( ecp );
4613 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004614 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004615#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004616 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004617 (void) private_key;
4618 (void) peer_key;
4619 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004620 (void) shared_secret;
4621 (void) shared_secret_size;
4622 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004623 return( PSA_ERROR_NOT_SUPPORTED );
4624 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004625}
4626
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004627/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004628 * to potentially free embedded data structures and wipe confidential data.
4629 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004630static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004631 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004632 psa_key_slot_t *private_key,
4633 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004634 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004635{
4636 psa_status_t status;
4637 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4638 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004639 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004640
4641 /* Step 1: run the secret agreement algorithm to generate the shared
4642 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004643 status = psa_key_agreement_raw_internal( ka_alg,
4644 private_key,
4645 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004646 shared_secret,
4647 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004648 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004649 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004650 goto exit;
4651
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004652 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004653 * the shared secret. A shared secret is permitted wherever a key
4654 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004655 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004656 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004657 shared_secret,
4658 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004659exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004660 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004661 return( status );
4662}
4663
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004664psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004665 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004666 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004667 const uint8_t *peer_key,
4668 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004669{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004670 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004671 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004672 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004673
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004674 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004675 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004676 status = psa_get_and_lock_transparent_key_slot_with_policy(
4677 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004678 if( status != PSA_SUCCESS )
4679 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004680 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004681 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004682 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004683 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004684 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004685 else
4686 {
4687 /* If a private key has been added as SECRET, we allow the derived
4688 * key material to be used as a key in PSA Crypto. */
4689 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4690 operation->can_output_key = 1;
4691 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004692
Ronald Cron5c522922020-11-14 16:35:34 +01004693 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004694
Ronald Cron5c522922020-11-14 16:35:34 +01004695 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004696}
4697
Gilles Peskinebe697d82019-05-16 18:00:41 +02004698psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004699 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004700 const uint8_t *peer_key,
4701 size_t peer_key_length,
4702 uint8_t *output,
4703 size_t output_size,
4704 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004705{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004707 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004708 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004709
4710 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4711 {
4712 status = PSA_ERROR_INVALID_ARGUMENT;
4713 goto exit;
4714 }
Ronald Cron5c522922020-11-14 16:35:34 +01004715 status = psa_get_and_lock_transparent_key_slot_with_policy(
4716 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004717 if( status != PSA_SUCCESS )
4718 goto exit;
4719
4720 status = psa_key_agreement_raw_internal( alg, slot,
4721 peer_key, peer_key_length,
4722 output, output_size,
4723 output_length );
4724
4725exit:
4726 if( status != PSA_SUCCESS )
4727 {
4728 /* If an error happens and is not handled properly, the output
4729 * may be used as a key to protect sensitive data. Arrange for such
4730 * a key to be random, which is likely to result in decryption or
4731 * verification errors. This is better than filling the buffer with
4732 * some constant data such as zeros, which would result in the data
4733 * being protected with a reproducible, easily knowable key.
4734 */
4735 psa_generate_random( output, output_size );
4736 *output_length = output_size;
4737 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004738
Ronald Cron5c522922020-11-14 16:35:34 +01004739 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004740
Ronald Cron5c522922020-11-14 16:35:34 +01004741 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004742}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004743
4744
Gilles Peskine30524eb2020-11-13 17:02:26 +01004745
Gilles Peskine86a440b2018-11-12 18:39:40 +01004746/****************************************************************/
4747/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004748/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004749
Gilles Peskine30524eb2020-11-13 17:02:26 +01004750/** Initialize the PSA random generator.
4751 */
4752static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4753{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004754#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4755 memset( rng, 0, sizeof( *rng ) );
4756#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4757
Gilles Peskine30524eb2020-11-13 17:02:26 +01004758 /* Set default configuration if
4759 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4760 if( rng->entropy_init == NULL )
4761 rng->entropy_init = mbedtls_entropy_init;
4762 if( rng->entropy_free == NULL )
4763 rng->entropy_free = mbedtls_entropy_free;
4764
4765 rng->entropy_init( &rng->entropy );
4766#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4767 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4768 /* The PSA entropy injection feature depends on using NV seed as an entropy
4769 * source. Add NV seed as an entropy source for PSA entropy injection. */
4770 mbedtls_entropy_add_source( &rng->entropy,
4771 mbedtls_nv_seed_poll, NULL,
4772 MBEDTLS_ENTROPY_BLOCK_SIZE,
4773 MBEDTLS_ENTROPY_SOURCE_STRONG );
4774#endif
4775
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004776 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004777#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004778}
4779
4780/** Deinitialize the PSA random generator.
4781 */
4782static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4783{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004784#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4785 memset( rng, 0, sizeof( *rng ) );
4786#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004787 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004788 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004789#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004790}
4791
4792/** Seed the PSA random generator.
4793 */
4794static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4795{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004796#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4797 /* Do nothing: the external RNG seeds itself. */
4798 (void) rng;
4799 return( PSA_SUCCESS );
4800#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004801 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004802 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4803 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004804 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004805#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004806}
4807
Gilles Peskinee59236f2018-01-27 23:32:46 +01004808psa_status_t psa_generate_random( uint8_t *output,
4809 size_t output_size )
4810{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004811 GUARD_MODULE_INITIALIZED;
4812
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004813#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4814
4815 size_t output_length = 0;
4816 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4817 output, output_size,
4818 &output_length );
4819 if( status != PSA_SUCCESS )
4820 return( status );
4821 /* Breaking up a request into smaller chunks is currently not supported
4822 * for the extrernal RNG interface. */
4823 if( output_length != output_size )
4824 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4825 return( PSA_SUCCESS );
4826
4827#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4828
Gilles Peskine71ddab92021-01-04 21:01:07 +01004829 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004830 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004831 size_t request_size =
4832 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4833 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4834 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004835 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4836 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004837 if( ret != 0 )
4838 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004839 output_size -= request_size;
4840 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004841 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004842 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004843#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004844}
4845
Gilles Peskine8814fc42020-12-14 15:33:44 +01004846/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004847 *
4848 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4849 * `psa_generate_random(...)`. The state parameter is ignored since the
4850 * PSA API doesn't support passing an explicit state.
4851 *
4852 * In the non-external case, psa_generate_random() calls an
4853 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4854 * and semantics as mbedtls_psa_get_random(). As an optimization,
4855 * instead of doing this back-and-forth between the PSA API and the
4856 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4857 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004858 */
4859#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4860int mbedtls_psa_get_random( void *p_rng,
4861 unsigned char *output,
4862 size_t output_size )
4863{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004864 /* This function takes a pointer to the RNG state because that's what
4865 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4866 * its own state internally and doesn't let the caller access that state.
4867 * So we just ignore the state parameter, and in practice we'll pass
4868 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004869 (void) p_rng;
4870 psa_status_t status = psa_generate_random( output, output_size );
4871 if( status == PSA_SUCCESS )
4872 return( 0 );
4873 else
4874 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4875}
4876#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4877
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004878#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
4879#include "mbedtls/entropy_poll.h"
4880
Gilles Peskine7228da22019-07-15 11:06:15 +02004881psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004882 size_t seed_size )
4883{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004884 if( global_data.initialized )
4885 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004886
4887 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4888 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4889 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4890 return( PSA_ERROR_INVALID_ARGUMENT );
4891
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004892 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004893}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004894#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004895
Ronald Cron3772afe2021-02-08 16:10:05 +01004896/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004897 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004898 * \param type The key type
4899 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004900 *
4901 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004902 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004903 * \retval #PSA_ERROR_INVALID_ARGUMENT
4904 * The size in bits of the key is not valid.
4905 * \retval #PSA_ERROR_NOT_SUPPORTED
4906 * The type and/or the size in bits of the key or the combination of
4907 * the two is not supported.
4908 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004909static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4910 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004911{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004912 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004913
Gilles Peskinee59236f2018-01-27 23:32:46 +01004914 if( key_type_is_raw_bytes( type ) )
4915 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004916 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004917 if( status != PSA_SUCCESS )
4918 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004919 }
4920 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004921#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004922 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4923 {
4924 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4925 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004926
Ronald Cron01b2aba2020-10-05 09:42:02 +02004927 /* Accept only byte-aligned keys, for the same reasons as
4928 * in psa_import_rsa_key(). */
4929 if( bits % 8 != 0 )
4930 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004931 }
4932 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004933#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004934
Ronald Cron5c4d3862020-12-07 11:07:24 +01004935#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004936 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4937 {
Ronald Crond81ab562021-02-16 09:01:16 +01004938 /* To avoid empty block, return successfully here. */
4939 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004940 }
4941 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004942#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004943 {
4944 return( PSA_ERROR_NOT_SUPPORTED );
4945 }
4946
4947 return( PSA_SUCCESS );
4948}
4949
Ronald Cron55ed0592020-10-05 10:30:40 +02004950psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004951 const psa_key_attributes_t *attributes,
4952 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004953{
4954 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004955 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004956
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004957 if( ( attributes->domain_parameters == NULL ) &&
4958 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004959 return( PSA_ERROR_INVALID_ARGUMENT );
4960
Ronald Cron01b2aba2020-10-05 09:42:02 +02004961 if( key_type_is_raw_bytes( type ) )
4962 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004963 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004964 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004965 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004966
David Brown12ca5032021-02-11 11:02:00 -07004967#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004968 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004969 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004970#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004971 }
4972 else
4973
John Durkop07cc04a2020-11-16 22:08:34 -08004974#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004975 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004976 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004977 return( mbedtls_psa_rsa_generate_key( attributes,
4978 key_buffer,
4979 key_buffer_size,
4980 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004981 }
4982 else
John Durkop07cc04a2020-11-16 22:08:34 -08004983#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004984
John Durkop9814fa22020-11-04 12:28:15 -08004985#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004986 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004987 {
Ronald Cron7023db52020-11-20 18:17:42 +01004988 return( mbedtls_psa_ecp_generate_key( attributes,
4989 key_buffer,
4990 key_buffer_size,
4991 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004992 }
4993 else
John Durkop9814fa22020-11-04 12:28:15 -08004994#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004995 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004996 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004997 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004998 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004999
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005000 return( PSA_SUCCESS );
5001}
Darryl Green0c6575a2018-11-07 16:05:30 +00005002
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005003psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005004 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005005{
5006 psa_status_t status;
5007 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005008 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005009 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005010
Ronald Cron81709fc2020-11-14 12:10:32 +01005011 *key = MBEDTLS_SVC_KEY_ID_INIT;
5012
Gilles Peskine0f84d622019-09-12 19:03:13 +02005013 /* Reject any attempt to create a zero-length key so that we don't
5014 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5015 if( psa_get_key_bits( attributes ) == 0 )
5016 return( PSA_ERROR_INVALID_ARGUMENT );
5017
Ronald Cron81709fc2020-11-14 12:10:32 +01005018 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5019 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005020 if( status != PSA_SUCCESS )
5021 goto exit;
5022
Ronald Cron977c2472020-10-13 08:32:21 +02005023 /* In the case of a transparent key or an opaque key stored in local
5024 * storage (thus not in the case of generating a key in a secure element
5025 * or cryptoprocessor with storage), we have to allocate a buffer to
5026 * hold the generated key material. */
5027 if( slot->key.data == NULL )
5028 {
5029 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5030 PSA_KEY_LOCATION_LOCAL_STORAGE )
5031 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005032 status = psa_validate_key_type_and_size_for_key_generation(
5033 attributes->core.type, attributes->core.bits );
5034 if( status != PSA_SUCCESS )
5035 goto exit;
5036
5037 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5038 attributes->core.type,
5039 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005040 }
5041 else
5042 {
5043 status = psa_driver_wrapper_get_key_buffer_size(
5044 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005045 if( status != PSA_SUCCESS )
5046 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005047 }
Ronald Cron977c2472020-10-13 08:32:21 +02005048
5049 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5050 if( status != PSA_SUCCESS )
5051 goto exit;
5052 }
5053
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005054 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005055 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005056
Ronald Cron2b56bc82020-10-05 10:02:26 +02005057 if( status != PSA_SUCCESS )
5058 psa_remove_key_data_from_memory( slot );
5059
Gilles Peskine11792082019-08-06 18:36:36 +02005060exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005061 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005062 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005063 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005064 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005065
Darryl Green0c6575a2018-11-07 16:05:30 +00005066 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005067}
5068
Gilles Peskinee59236f2018-01-27 23:32:46 +01005069/****************************************************************/
5070/* Module setup */
5071/****************************************************************/
5072
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005073#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005074psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5075 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5076 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5077{
5078 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5079 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005080 global_data.rng.entropy_init = entropy_init;
5081 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005082 return( PSA_SUCCESS );
5083}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005084#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005085
Gilles Peskinee59236f2018-01-27 23:32:46 +01005086void mbedtls_psa_crypto_free( void )
5087{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005088 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005089 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5090 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005091 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005092 }
5093 /* Wipe all remaining data, including configuration.
5094 * In particular, this sets all state indicator to the value
5095 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005096 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005097#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005098 /* Unregister all secure element drivers, so that we restart from
5099 * a pristine state. */
5100 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005101#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005102}
5103
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005104#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5105/** Recover a transaction that was interrupted by a power failure.
5106 *
5107 * This function is called during initialization, before psa_crypto_init()
5108 * returns. If this function returns a failure status, the initialization
5109 * fails.
5110 */
5111static psa_status_t psa_crypto_recover_transaction(
5112 const psa_crypto_transaction_t *transaction )
5113{
5114 switch( transaction->unknown.type )
5115 {
5116 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5117 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005118 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005119 * is implemented.
5120 * https://github.com/ARMmbed/mbed-crypto/issues/218
5121 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005122 default:
5123 /* We found an unsupported transaction in the storage.
5124 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005125 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005126 }
5127}
5128#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5129
Gilles Peskinee59236f2018-01-27 23:32:46 +01005130psa_status_t psa_crypto_init( void )
5131{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005132 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005133
Gilles Peskinec6b69072018-11-20 21:42:52 +01005134 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005135 if( global_data.initialized != 0 )
5136 return( PSA_SUCCESS );
5137
Gilles Peskine30524eb2020-11-13 17:02:26 +01005138 /* Initialize and seed the random generator. */
5139 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005140 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005141 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005142 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005143 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005144 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005145
Gilles Peskine66fb1262018-12-10 16:29:04 +01005146 status = psa_initialize_key_slots( );
5147 if( status != PSA_SUCCESS )
5148 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005149
Gilles Peskined9348f22019-10-01 15:22:29 +02005150#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5151 status = psa_init_all_se_drivers( );
5152 if( status != PSA_SUCCESS )
5153 goto exit;
5154#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5155
Gilles Peskine4b734222019-07-24 15:56:31 +02005156#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005157 status = psa_crypto_load_transaction( );
5158 if( status == PSA_SUCCESS )
5159 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005160 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5161 if( status != PSA_SUCCESS )
5162 goto exit;
5163 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005164 }
5165 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5166 {
5167 /* There's no transaction to complete. It's all good. */
5168 status = PSA_SUCCESS;
5169 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005170#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005171
Gilles Peskinec6b69072018-11-20 21:42:52 +01005172 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005173 global_data.initialized = 1;
5174
5175exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005176 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005177 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005178 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005179}
5180
5181#endif /* MBEDTLS_PSA_CRYPTO_C */