blob: 22dce5d7fc8fe0aab9d3bd6071ac3b8097cda8a5 [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;
David Browne04acc22021-01-26 11:39:16 -0700527#if defined(MBEDTLS_PSA_BUILTIN_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
David Browne04acc22021-01-26 11:39:16 -0700533#if defined(MBEDTLS_PSA_BUILTIN_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
David Browne04acc22021-01-26 11:39:16 -0700539#if defined(MBEDTLS_PSA_BUILTIN_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
David Browne04acc22021-01-26 11:39:16 -0700545#if defined(MBEDTLS_PSA_BUILTIN_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
David Brown1bfe4d72021-02-16 12:54:35 -0700551#if defined(MBEDTLS_PSA_BUILTIN_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
Gilles Peskineb46bef22019-07-30 21:32:04 +0200566/** Return the size of the key in the given slot, in bits.
567 *
568 * \param[in] slot A key slot.
569 *
570 * \return The key size in bits, read from the metadata in the slot.
571 */
572static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
573{
574 return( slot->attr.bits );
575}
576
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100577/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100578 *
Steven Cooremancd640932021-03-08 12:00:27 +0100579 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
580 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100581 *
582 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100583 * \param[in] key_type The key type of the key to be used with the
584 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100585 *
586 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100587 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100588 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100589 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100590 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100591MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100592 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100593 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100594{
Steven Cooremancd640932021-03-08 12:00:27 +0100595 if( PSA_ALG_IS_HMAC( algorithm ) )
596 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100597 if( key_type == PSA_KEY_TYPE_HMAC )
598 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100599 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100600
601 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100602 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100603 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
604 * key. */
605 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
606 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
607 {
608 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
609 * the block length (larger than 1) for block ciphers. */
610 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
611 return( PSA_SUCCESS );
612 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100613 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100614
615 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100616}
617
Steven Cooreman75b74362020-07-28 14:30:13 +0200618/** Try to allocate a buffer to an empty key slot.
619 *
620 * \param[in,out] slot Key slot to attach buffer to.
621 * \param[in] buffer_length Requested size of the buffer.
622 *
623 * \retval #PSA_SUCCESS
624 * The buffer has been successfully allocated.
625 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
626 * Not enough memory was available for allocation.
627 * \retval #PSA_ERROR_ALREADY_EXISTS
628 * Trying to allocate a buffer to a non-empty key slot.
629 */
630static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
631 size_t buffer_length )
632{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100633 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200634 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200635
Ronald Cronea0f8a62020-11-25 17:52:23 +0100636 slot->key.data = mbedtls_calloc( 1, buffer_length );
637 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200638 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200639
Ronald Cronea0f8a62020-11-25 17:52:23 +0100640 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200641 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200642}
643
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200644psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
645 const uint8_t* data,
646 size_t data_length )
647{
648 psa_status_t status = psa_allocate_buffer_to_slot( slot,
649 data_length );
650 if( status != PSA_SUCCESS )
651 return( status );
652
Ronald Cronea0f8a62020-11-25 17:52:23 +0100653 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200654 return( PSA_SUCCESS );
655}
656
Ronald Crona0fe59f2020-11-29 11:14:53 +0100657psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100658 const psa_key_attributes_t *attributes,
659 const uint8_t *data, size_t data_length,
660 uint8_t *key_buffer, size_t key_buffer_size,
661 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100662{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100663 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
664 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100665
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200666 /* zero-length keys are never supported. */
667 if( data_length == 0 )
668 return( PSA_ERROR_NOT_SUPPORTED );
669
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100670 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100671 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100672 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200673
Steven Cooreman75b74362020-07-28 14:30:13 +0200674 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
675 if( data_length > SIZE_MAX / 8 )
676 return( PSA_ERROR_NOT_SUPPORTED );
677
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200678 /* Enforce a size limit, and in particular ensure that the bit
679 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100680 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200681 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200682
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200684 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200685 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200686
Ronald Crondd04d422020-11-28 15:14:42 +0100687 /* Copy the key material. */
688 memcpy( key_buffer, data, data_length );
689 *key_buffer_length = data_length;
690 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200691
Steven Cooreman40120f62020-10-29 11:42:22 +0100692 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100693 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100694 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200695 {
John Durkop9814fa22020-11-04 12:28:15 -0800696#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
697 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100698 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200699 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100700 return( mbedtls_psa_ecp_import_key( attributes,
701 data, data_length,
702 key_buffer, key_buffer_size,
703 key_buffer_length,
704 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100705 }
John Durkop9814fa22020-11-04 12:28:15 -0800706#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
707 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700708#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
709 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100710 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200711 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100712 return( mbedtls_psa_rsa_import_key( attributes,
713 data, data_length,
714 key_buffer, key_buffer_size,
715 key_buffer_length,
716 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200717 }
John Durkop9814fa22020-11-04 12:28:15 -0800718#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
719 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100720 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100721
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100722 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100723}
724
Gilles Peskinef603c712019-01-19 13:40:11 +0100725/** Calculate the intersection of two algorithm usage policies.
726 *
727 * Return 0 (which allows no operation) on incompatibility.
728 */
729static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100730 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100731 psa_algorithm_t alg1,
732 psa_algorithm_t alg2 )
733{
Gilles Peskine549ea862019-05-22 11:45:59 +0200734 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100735 if( alg1 == alg2 )
736 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100737 /* If the policies are from the same hash-and-sign family, check
738 * if one is a wildcard. If so the other has the specific algorithm. */
739 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
740 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
741 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100742 {
Steven Cooreman03488022021-02-18 12:07:20 +0100743 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
744 return( alg2 );
745 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
746 return( alg1 );
747 }
748 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100749 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100750 * restrictive tag length. */
751 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
752 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
753 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
754 {
755 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
756 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100757 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100758
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100759 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100760 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
761 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100762 {
Steven Cooremancd640932021-03-08 12:00:27 +0100763 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
764 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100765 }
766 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100767 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100768 ( alg1_len <= alg2_len ) )
769 {
770 return( alg2 );
771 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100772 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100773 ( alg2_len <= alg1_len ) )
774 {
775 return( alg1 );
776 }
777 }
778 /* If the policies are from the same MAC family, check whether one
779 * of them is a minimum-MAC-length policy. Calculate the most
780 * restrictive tag length. */
781 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
782 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
783 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
784 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100785 /* Validate the combination of key type and algorithm. Since the base
786 * algorithm of alg1 and alg2 are the same, we only need this once. */
787 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100788 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100789
Steven Cooreman31a876d2021-03-03 20:47:40 +0100790 /* Get the (exact or at-least) output lengths for both sides of the
791 * requested intersection. None of the currently supported algorithms
792 * have an output length dependent on the actual key size, so setting it
793 * to a bogus value of 0 is currently OK.
794 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100795 * Note that for at-least-this-length wildcard algorithms, the output
796 * length is set to the shortest allowed length, which allows us to
797 * calculate the most restrictive tag length for the intersection. */
798 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
799 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100800 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100801
Steven Cooremana1d83222021-02-25 10:20:29 +0100802 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100803 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
804 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100805 {
Steven Cooremancd640932021-03-08 12:00:27 +0100806 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100807 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100808
809 /* If only one is an at-least-this-length policy, the intersection would
810 * be the other (fixed-length) policy as long as said fixed length is
811 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100812 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100813 {
Steven Cooremancd640932021-03-08 12:00:27 +0100814 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100815 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100816 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100817 {
Steven Cooremancd640932021-03-08 12:00:27 +0100818 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100819 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100820
Steven Cooremancd640932021-03-08 12:00:27 +0100821 /* If none of them are wildcards, check whether they define the same tag
822 * length. This is still possible here when one is default-length and
823 * the other specific-length. Ensure to always return the
824 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100825 if( alg1_len == alg2_len )
826 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100827 }
828 /* If the policies are incompatible, allow nothing. */
829 return( 0 );
830}
831
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100832static int psa_key_algorithm_permits( psa_key_type_t key_type,
833 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200834 psa_algorithm_t requested_alg )
835{
Gilles Peskine549ea862019-05-22 11:45:59 +0200836 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200837 if( requested_alg == policy_alg )
838 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100839 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
840 * and requested_alg is the same hash-and-sign family with any hash,
841 * then requested_alg is compliant with policy_alg. */
842 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
843 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200844 {
Steven Cooreman03488022021-02-18 12:07:20 +0100845 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
846 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
847 }
848 /* If policy_alg is a wildcard AEAD algorithm of the same base as
849 * the requested algorithm, check the requested tag length to be
850 * equal-length or longer than the wildcard-specified length. */
851 if( PSA_ALG_IS_AEAD( policy_alg ) &&
852 PSA_ALG_IS_AEAD( requested_alg ) &&
853 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
854 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100855 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100856 {
857 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
858 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
859 }
Steven Cooremancd640932021-03-08 12:00:27 +0100860 /* If policy_alg is a MAC algorithm of the same base as the requested
861 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100862 if( PSA_ALG_IS_MAC( policy_alg ) &&
863 PSA_ALG_IS_MAC( requested_alg ) &&
864 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100865 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100866 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100867 /* Validate the combination of key type and algorithm. Since the policy
868 * and requested algorithms are the same, we only need this once. */
869 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100870 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100871
Steven Cooreman31a876d2021-03-03 20:47:40 +0100872 /* Get both the requested output length for the algorithm which is to be
873 * verified, and the default output length for the base algorithm.
874 * Note that none of the currently supported algorithms have an output
875 * length dependent on actual key size, so setting it to a bogus value
876 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100877 size_t requested_output_length = PSA_MAC_LENGTH(
878 key_type, 0, requested_alg );
879 size_t default_output_length = PSA_MAC_LENGTH(
880 key_type, 0,
881 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100882
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100883 /* If the policy is default-length, only allow an algorithm with
884 * a declared exact-length matching the default. */
885 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100886 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100887
888 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100889 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100890 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
891 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
892 {
893 return( 1 );
894 }
895
Steven Cooremancd640932021-03-08 12:00:27 +0100896 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
897 * check for the requested MAC length to be equal to or longer than the
898 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100899 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
900 {
901 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100902 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100903 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200904 }
Steven Cooremance48e852020-10-05 16:02:45 +0200905 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200906 * a key derivation with that key agreement should also be allowed. This
907 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200908 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
909 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
910 {
911 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
912 policy_alg );
913 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100914 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200915 return( 0 );
916}
917
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100918/** Test whether a policy permits an algorithm.
919 *
920 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100921 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100922 * \note This function requires providing the key type for which the policy is
923 * being validated, since some algorithm policy definitions (e.g. MAC)
924 * have different properties depending on what kind of cipher it is
925 * combined with.
926 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100927 * \retval PSA_SUCCESS When \p alg is a specific algorithm
928 * allowed by the \p policy.
929 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
930 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
931 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100932 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100933static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100934 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100935 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100936{
Steven Cooremand788fab2021-02-25 11:29:17 +0100937 /* '0' is not a valid algorithm */
938 if( alg == 0 )
939 return( PSA_ERROR_INVALID_ARGUMENT );
940
Steven Cooreman7e39f052021-02-23 14:18:32 +0100941 /* A requested algorithm cannot be a wildcard. */
942 if( PSA_ALG_IS_WILDCARD( alg ) )
943 return( PSA_ERROR_INVALID_ARGUMENT );
944
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100945 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
946 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100947 return( PSA_SUCCESS );
948 else
949 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100950}
951
Gilles Peskinef603c712019-01-19 13:40:11 +0100952/** Restrict a key policy based on a constraint.
953 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100954 * \note This function requires providing the key type for which the policy is
955 * being restricted, since some algorithm policy definitions (e.g. MAC)
956 * have different properties depending on what kind of cipher it is
957 * combined with.
958 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100959 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100960 * \param[in,out] policy The policy to restrict.
961 * \param[in] constraint The policy constraint to apply.
962 *
963 * \retval #PSA_SUCCESS
964 * \c *policy contains the intersection of the original value of
965 * \c *policy and \c *constraint.
966 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100967 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100968 * \c *policy is unchanged.
969 */
970static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100971 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100972 psa_key_policy_t *policy,
973 const psa_key_policy_t *constraint )
974{
975 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100976 psa_key_policy_algorithm_intersection( key_type, policy->alg,
977 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200978 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100979 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
980 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100981 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
982 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200983 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
984 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100985 policy->usage &= constraint->usage;
986 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200987 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100988 return( PSA_SUCCESS );
989}
990
Ronald Cron5c522922020-11-14 16:35:34 +0100991/** Get the description of a key given its identifier and policy constraints
992 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200993 *
Ronald Cron5c522922020-11-14 16:35:34 +0100994 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100995 * nonzero, the key must allow operations with this algorithm. If \p alg is
996 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100997 *
Ronald Cron5c522922020-11-14 16:35:34 +0100998 * In case of a persistent key, the function loads the description of the key
999 * into a key slot if not already done.
1000 *
1001 * On success, the returned key slot is locked. It is the responsibility of
1002 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001003 */
Ronald Cron5c522922020-11-14 16:35:34 +01001004static psa_status_t psa_get_and_lock_key_slot_with_policy(
1005 mbedtls_svc_key_id_t key,
1006 psa_key_slot_t **p_slot,
1007 psa_key_usage_t usage,
1008 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +01001009{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001010 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1011 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001012
Ronald Cron5c522922020-11-14 16:35:34 +01001013 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001014 if( status != PSA_SUCCESS )
1015 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001016 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001017
1018 /* Enforce that usage policy for the key slot contains all the flags
1019 * required by the usage parameter. There is one exception: public
1020 * keys can always be exported, so we treat public key objects as
1021 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001022 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001023 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001024
Gilles Peskine8e338702019-07-30 20:06:31 +02001025 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +01001026 {
1027 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001028 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001029 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001030
1031 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001032 if( alg != 0 )
1033 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001034 status = psa_key_policy_permits( &slot->attr.policy,
1035 slot->attr.type,
1036 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001037 if( status != PSA_SUCCESS )
1038 goto error;
1039 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001040
Darryl Green06fd18d2018-07-16 11:21:11 +01001041 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001042
1043error:
1044 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001045 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001046
1047 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001048}
Darryl Green940d72c2018-07-13 13:18:51 +01001049
Ronald Cron5c522922020-11-14 16:35:34 +01001050/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001051 *
1052 * A transparent key is a key for which the key material is directly
1053 * available, as opposed to a key in a secure element.
1054 *
Ronald Cron5c522922020-11-14 16:35:34 +01001055 * This is a temporary function to use instead of
1056 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1057 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001058 *
Ronald Cron5c522922020-11-14 16:35:34 +01001059 * On success, the returned key slot is locked. It is the responsibility of the
1060 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001061 */
1062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001063static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1064 mbedtls_svc_key_id_t key,
1065 psa_key_slot_t **p_slot,
1066 psa_key_usage_t usage,
1067 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001068{
Ronald Cron5c522922020-11-14 16:35:34 +01001069 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1070 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001071 if( status != PSA_SUCCESS )
1072 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001073
Gilles Peskineadad8132019-07-25 11:31:23 +02001074 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001075 {
Ronald Cron5c522922020-11-14 16:35:34 +01001076 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001077 *p_slot = NULL;
1078 return( PSA_ERROR_NOT_SUPPORTED );
1079 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001080
Gilles Peskine28f8f302019-07-24 13:30:31 +02001081 return( PSA_SUCCESS );
1082}
1083#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1084/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001085#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1086 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001087#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1088
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001089/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001090static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001091{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001092 /* Data pointer will always be either a valid pointer or NULL in an
1093 * initialized slot, so we can just free it. */
1094 if( slot->key.data != NULL )
1095 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1096
1097 mbedtls_free( slot->key.data );
1098 slot->key.data = NULL;
1099 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001100
1101 return( PSA_SUCCESS );
1102}
1103
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001104/** Completely wipe a slot in memory, including its policy.
1105 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001106psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001107{
1108 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001109
1110 /*
1111 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001112 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001113 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1114 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001115 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001116 */
Ronald Cron5c522922020-11-14 16:35:34 +01001117 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001118 {
1119#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001120 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001121#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001122 status = PSA_ERROR_CORRUPTION_DETECTED;
1123 }
1124
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001125 /* Multipart operations may still be using the key. This is safe
1126 * because all multipart operation objects are independent from
1127 * the key slot: if they need to access the key after the setup
1128 * phase, they have a copy of the key. Note that this means that
1129 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001130 /* At this point, key material and other type-specific content has
1131 * been wiped. Clear remaining metadata. We can call memset and not
1132 * zeroize because the metadata is not particularly sensitive. */
1133 memset( slot, 0, sizeof( *slot ) );
1134 return( status );
1135}
1136
Ronald Croncf56a0a2020-08-04 09:51:30 +02001137psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001138{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001139 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 psa_status_t status; /* status of the last operation */
1141 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001142#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1143 psa_se_drv_table_entry_t *driver;
1144#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001145
Ronald Croncf56a0a2020-08-04 09:51:30 +02001146 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001147 return( PSA_SUCCESS );
1148
Ronald Cronf2911112020-10-29 17:51:10 +01001149 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001150 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001151 * key, this will load the key description from persistent memory if not
1152 * done yet. We cannot avoid this loading as without it we don't know if
1153 * the key is operated by an SE or not and this information is needed by
1154 * the current implementation.
1155 */
Ronald Cron5c522922020-11-14 16:35:34 +01001156 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001157 if( status != PSA_SUCCESS )
1158 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001159
Ronald Cronf2911112020-10-29 17:51:10 +01001160 /*
1161 * If the key slot containing the key description is under access by the
1162 * library (apart from the present access), the key cannot be destroyed
1163 * yet. For the time being, just return in error. Eventually (to be
1164 * implemented), the key should be destroyed when all accesses have
1165 * stopped.
1166 */
Ronald Cron5c522922020-11-14 16:35:34 +01001167 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001168 {
Ronald Cron5c522922020-11-14 16:35:34 +01001169 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001170 return( PSA_ERROR_GENERIC_ERROR );
1171 }
1172
Gilles Peskine354f7672019-07-12 23:46:38 +02001173#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001174 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001175 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001176 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001177 /* For a key in a secure element, we need to do three things:
1178 * remove the key file in internal storage, destroy the
1179 * key inside the secure element, and update the driver's
1180 * persistent data. Start a transaction that will encompass these
1181 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001182 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001183 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001184 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001185 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001186 status = psa_crypto_save_transaction( );
1187 if( status != PSA_SUCCESS )
1188 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001189 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001190 /* We should still try to destroy the key in the secure
1191 * element and the key metadata in storage. This is especially
1192 * important if the error is that the storage is full.
1193 * But how to do it exactly without risking an inconsistent
1194 * state after a reset?
1195 * https://github.com/ARMmbed/mbed-crypto/issues/215
1196 */
1197 overall_status = status;
1198 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001199 }
1200
Ronald Cronea0f8a62020-11-25 17:52:23 +01001201 status = psa_destroy_se_key( driver,
1202 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001203 if( overall_status == PSA_SUCCESS )
1204 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001205 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001206#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1207
Darryl Greend49a4992018-06-18 17:27:26 +01001208#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001209 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001210 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001211 status = psa_destroy_persistent_key( slot->attr.id );
1212 if( overall_status == PSA_SUCCESS )
1213 overall_status = status;
1214
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001215 /* TODO: other slots may have a copy of the same key. We should
1216 * invalidate them.
1217 * https://github.com/ARMmbed/mbed-crypto/issues/214
1218 */
Darryl Greend49a4992018-06-18 17:27:26 +01001219 }
1220#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001221
Gilles Peskinefc762652019-07-22 19:30:34 +02001222#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1223 if( driver != NULL )
1224 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001225 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001226 if( overall_status == PSA_SUCCESS )
1227 overall_status = status;
1228 status = psa_crypto_stop_transaction( );
1229 if( overall_status == PSA_SUCCESS )
1230 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001231 }
1232#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1233
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001234#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1235exit:
1236#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001237 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001238 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1239 if( overall_status == PSA_SUCCESS )
1240 overall_status = status;
1241 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001242}
1243
John Durkop07cc04a2020-11-16 22:08:34 -08001244#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001245 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001246static psa_status_t psa_get_rsa_public_exponent(
1247 const mbedtls_rsa_context *rsa,
1248 psa_key_attributes_t *attributes )
1249{
1250 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001252 uint8_t *buffer = NULL;
1253 size_t buflen;
1254 mbedtls_mpi_init( &mpi );
1255
1256 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1257 if( ret != 0 )
1258 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001259 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1260 {
1261 /* It's the default value, which is reported as an empty string,
1262 * so there's nothing to do. */
1263 goto exit;
1264 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001265
1266 buflen = mbedtls_mpi_size( &mpi );
1267 buffer = mbedtls_calloc( 1, buflen );
1268 if( buffer == NULL )
1269 {
1270 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1271 goto exit;
1272 }
1273 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1274 if( ret != 0 )
1275 goto exit;
1276 attributes->domain_parameters = buffer;
1277 attributes->domain_parameters_size = buflen;
1278
1279exit:
1280 mbedtls_mpi_free( &mpi );
1281 if( ret != 0 )
1282 mbedtls_free( buffer );
1283 return( mbedtls_to_psa_error( ret ) );
1284}
John Durkop07cc04a2020-11-16 22:08:34 -08001285#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001286 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001287
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001288/** Retrieve all the publicly-accessible attributes of a key.
1289 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001290psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001291 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001292{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001293 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001294 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001295 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001296
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001297 psa_reset_key_attributes( attributes );
1298
Ronald Cron5c522922020-11-14 16:35:34 +01001299 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001300 if( status != PSA_SUCCESS )
1301 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001302
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001303 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001304 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1305 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1306
1307#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1308 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001309 psa_set_key_slot_number( attributes,
1310 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001311#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001312
Gilles Peskine8e338702019-07-30 20:06:31 +02001313 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001314 {
John Durkop07cc04a2020-11-16 22:08:34 -08001315#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001316 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001317 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001318 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001319#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001320 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001321 * is not yet implemented.
1322 * https://github.com/ARMmbed/mbed-crypto/issues/216
1323 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001324 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001325 break;
1326#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001327 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001328 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001329
Ronald Cron90857082020-11-25 14:58:33 +01001330 status = mbedtls_psa_rsa_load_representation(
1331 slot->attr.type,
1332 slot->key.data,
1333 slot->key.bytes,
1334 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001335 if( status != PSA_SUCCESS )
1336 break;
1337
Steven Cooremana2371e52020-07-28 14:30:39 +02001338 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001339 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001340 mbedtls_rsa_free( rsa );
1341 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001342 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001343 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001344#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001345 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001346 default:
1347 /* Nothing else to do. */
1348 break;
1349 }
1350
1351 if( status != PSA_SUCCESS )
1352 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001353
Ronald Cron5c522922020-11-14 16:35:34 +01001354 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001355
Ronald Cron5c522922020-11-14 16:35:34 +01001356 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001357}
1358
Gilles Peskinec8000c02019-08-02 20:15:51 +02001359#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1360psa_status_t psa_get_key_slot_number(
1361 const psa_key_attributes_t *attributes,
1362 psa_key_slot_number_t *slot_number )
1363{
1364 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1365 {
1366 *slot_number = attributes->slot_number;
1367 return( PSA_SUCCESS );
1368 }
1369 else
1370 return( PSA_ERROR_INVALID_ARGUMENT );
1371}
1372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1373
Ronald Crond18b5f82020-11-25 16:46:05 +01001374static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1375 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001376 uint8_t *data,
1377 size_t data_size,
1378 size_t *data_length )
1379{
Ronald Crond18b5f82020-11-25 16:46:05 +01001380 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001381 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001382 memcpy( data, key_buffer, key_buffer_size );
1383 memset( data + key_buffer_size, 0,
1384 data_size - key_buffer_size );
1385 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001386 return( PSA_SUCCESS );
1387}
1388
Ronald Cron7285cda2020-11-26 14:46:37 +01001389psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001390 const psa_key_attributes_t *attributes,
1391 const uint8_t *key_buffer, size_t key_buffer_size,
1392 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001393{
Ronald Crond18b5f82020-11-25 16:46:05 +01001394 psa_key_type_t type = attributes->core.type;
1395
Ronald Crond18b5f82020-11-25 16:46:05 +01001396 if( key_type_is_raw_bytes( type ) ||
1397 PSA_KEY_TYPE_IS_RSA( type ) ||
1398 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001399 {
1400 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001401 key_buffer, key_buffer_size,
1402 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001403 }
1404 else
1405 {
1406 /* This shouldn't happen in the reference implementation, but
1407 it is valid for a special-purpose implementation to omit
1408 support for exporting certain key types. */
1409 return( PSA_ERROR_NOT_SUPPORTED );
1410 }
1411}
1412
1413psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1414 uint8_t *data,
1415 size_t data_size,
1416 size_t *data_length )
1417{
1418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1419 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1420 psa_key_slot_t *slot;
1421
Ronald Crone907e552021-01-18 13:22:38 +01001422 /* Reject a zero-length output buffer now, since this can never be a
1423 * valid key representation. This way we know that data must be a valid
1424 * pointer and we can do things like memset(data, ..., data_size). */
1425 if( data_size == 0 )
1426 return( PSA_ERROR_BUFFER_TOO_SMALL );
1427
Ronald Cron9486f9d2020-11-26 13:36:23 +01001428 /* Set the key to empty now, so that even when there are errors, we always
1429 * set data_length to a value between 0 and data_size. On error, setting
1430 * the key to empty is a good choice because an empty key representation is
1431 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001432 *data_length = 0;
1433
Ronald Cron9486f9d2020-11-26 13:36:23 +01001434 /* Export requires the EXPORT flag. There is an exception for public keys,
1435 * which don't require any flag, but
1436 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1437 */
1438 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1439 PSA_KEY_USAGE_EXPORT, 0 );
1440 if( status != PSA_SUCCESS )
1441 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001442
Ronald Crond18b5f82020-11-25 16:46:05 +01001443 psa_key_attributes_t attributes = {
1444 .core = slot->attr
1445 };
Ronald Cron67227982020-11-26 15:16:05 +01001446 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001447 slot->key.data, slot->key.bytes,
1448 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001449
Ronald Cron9486f9d2020-11-26 13:36:23 +01001450 unlock_status = psa_unlock_key_slot( slot );
1451
1452 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1453}
1454
Ronald Cron7285cda2020-11-26 14:46:37 +01001455psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001456 const psa_key_attributes_t *attributes,
1457 const uint8_t *key_buffer,
1458 size_t key_buffer_size,
1459 uint8_t *data,
1460 size_t data_size,
1461 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001462{
Ronald Crond18b5f82020-11-25 16:46:05 +01001463 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001464
Ronald Crond18b5f82020-11-25 16:46:05 +01001465 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001466 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001467 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001468 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001469 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001470 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001471 key_buffer, key_buffer_size,
1472 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001473 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001474
Ronald Crond18b5f82020-11-25 16:46:05 +01001475 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001476 {
John Durkop0e005192020-10-31 22:06:54 -07001477#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1478 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001479 return( mbedtls_psa_rsa_export_public_key( attributes,
1480 key_buffer,
1481 key_buffer_size,
1482 data,
1483 data_size,
1484 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001485#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001486 /* We don't know how to convert a private RSA key to public. */
1487 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001488#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1489 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001490 }
1491 else
Moran Pekera998bc62018-04-16 18:16:20 +03001492 {
John Durkop6ba40d12020-11-10 08:50:04 -08001493#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1494 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001495 return( mbedtls_psa_ecp_export_public_key( attributes,
1496 key_buffer,
1497 key_buffer_size,
1498 data,
1499 data_size,
1500 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001501#else
1502 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001503 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001504#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1505 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001506 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001507 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001508 else
1509 {
1510 /* This shouldn't happen in the reference implementation, but
1511 it is valid for a special-purpose implementation to omit
1512 support for exporting certain key types. */
1513 return( PSA_ERROR_NOT_SUPPORTED );
1514 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001515}
Ronald Crond18b5f82020-11-25 16:46:05 +01001516
Ronald Croncf56a0a2020-08-04 09:51:30 +02001517psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001518 uint8_t *data,
1519 size_t data_size,
1520 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001521{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001522 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001523 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001524 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001525
Ronald Crone907e552021-01-18 13:22:38 +01001526 /* Reject a zero-length output buffer now, since this can never be a
1527 * valid key representation. This way we know that data must be a valid
1528 * pointer and we can do things like memset(data, ..., data_size). */
1529 if( data_size == 0 )
1530 return( PSA_ERROR_BUFFER_TOO_SMALL );
1531
Darryl Greendd8fb772018-11-07 16:00:44 +00001532 /* Set the key to empty now, so that even when there are errors, we always
1533 * set data_length to a value between 0 and data_size. On error, setting
1534 * the key to empty is a good choice because an empty key representation is
1535 * unlikely to be accepted anywhere. */
1536 *data_length = 0;
1537
1538 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001539 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001540 if( status != PSA_SUCCESS )
1541 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001542
Ronald Cron9486f9d2020-11-26 13:36:23 +01001543 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1544 {
1545 status = PSA_ERROR_INVALID_ARGUMENT;
1546 goto exit;
1547 }
1548
Ronald Crond18b5f82020-11-25 16:46:05 +01001549 psa_key_attributes_t attributes = {
1550 .core = slot->attr
1551 };
Ronald Cron67227982020-11-26 15:16:05 +01001552 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001553 &attributes, slot->key.data, slot->key.bytes,
1554 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001555
1556exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001557 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001558
Ronald Cron5c522922020-11-14 16:35:34 +01001559 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001560}
1561
Gilles Peskine91e8c332019-08-02 19:19:39 +02001562#if defined(static_assert)
1563static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1564 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001565static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001566 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001567static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001568 "One or more key attribute flag is listed as both internal-only and external-only" );
1569#endif
1570
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001571/** Validate that a key policy is internally well-formed.
1572 *
1573 * This function only rejects invalid policies. It does not validate the
1574 * consistency of the policy with respect to other attributes of the key
1575 * such as the key type.
1576 */
1577static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001578{
1579 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001580 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001581 PSA_KEY_USAGE_ENCRYPT |
1582 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001583 PSA_KEY_USAGE_SIGN_HASH |
1584 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001585 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1586 return( PSA_ERROR_INVALID_ARGUMENT );
1587
Gilles Peskine4747d192019-04-17 15:05:45 +02001588 return( PSA_SUCCESS );
1589}
1590
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001591/** Validate the internal consistency of key attributes.
1592 *
1593 * This function only rejects invalid attribute values. If does not
1594 * validate the consistency of the attributes with any key data that may
1595 * be involved in the creation of the key.
1596 *
1597 * Call this function early in the key creation process.
1598 *
1599 * \param[in] attributes Key attributes for the new key.
1600 * \param[out] p_drv On any return, the driver for the key, if any.
1601 * NULL for a transparent key.
1602 *
1603 */
1604static psa_status_t psa_validate_key_attributes(
1605 const psa_key_attributes_t *attributes,
1606 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001607{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001608 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001609 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001610 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001611
Ronald Cron54b90082020-10-29 15:26:43 +01001612 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001613 if( status != PSA_SUCCESS )
1614 return( status );
1615
Ronald Crond2ed4812020-07-17 16:11:30 +02001616 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001617 if( status != PSA_SUCCESS )
1618 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001619
Ronald Cron65f38a32020-10-23 17:11:13 +02001620 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1621 {
1622 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1623 return( PSA_ERROR_INVALID_ARGUMENT );
1624 }
1625 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001626 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001627 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001628 if( status != PSA_SUCCESS )
1629 return( status );
1630 }
1631
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001632 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001633 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001634 return( status );
1635
1636 /* Refuse to create overly large keys.
1637 * Note that this doesn't trigger on import if the attributes don't
1638 * explicitly specify a size (so psa_get_key_bits returns 0), so
1639 * psa_import_key() needs its own checks. */
1640 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1641 return( PSA_ERROR_NOT_SUPPORTED );
1642
Gilles Peskine91e8c332019-08-02 19:19:39 +02001643 /* Reject invalid flags. These should not be reachable through the API. */
1644 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1645 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1646 return( PSA_ERROR_INVALID_ARGUMENT );
1647
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001648 return( PSA_SUCCESS );
1649}
1650
Gilles Peskine4747d192019-04-17 15:05:45 +02001651/** Prepare a key slot to receive key material.
1652 *
1653 * This function allocates a key slot and sets its metadata.
1654 *
1655 * If this function fails, call psa_fail_key_creation().
1656 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001657 * This function is intended to be used as follows:
1658 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001659 * it with the specified attributes, and in case of a volatile key assign it
1660 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001661 * -# Populate the slot with the key material.
1662 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1663 * In case of failure at any step, stop the sequence and call
1664 * psa_fail_key_creation().
1665 *
Ronald Cron5c522922020-11-14 16:35:34 +01001666 * On success, the key slot is locked. It is the responsibility of the caller
1667 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001668 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001669 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001670 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001671 * \param[out] p_slot On success, a pointer to the prepared slot.
1672 * \param[out] p_drv On any return, the driver for the key, if any.
1673 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001674 *
1675 * \retval #PSA_SUCCESS
1676 * The key slot is ready to receive key material.
1677 * \return If this function fails, the key slot is an invalid state.
1678 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001679 */
1680static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001681 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001682 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001683 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001684 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001685{
1686 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001687 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001688 psa_key_slot_t *slot;
1689
Gilles Peskinedf179142019-07-15 22:02:14 +02001690 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001691 *p_drv = NULL;
1692
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001693 status = psa_validate_key_attributes( attributes, p_drv );
1694 if( status != PSA_SUCCESS )
1695 return( status );
1696
Ronald Cronc4d1b512020-07-31 11:26:37 +02001697 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001698 if( status != PSA_SUCCESS )
1699 return( status );
1700 slot = *p_slot;
1701
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001702 /* We're storing the declared bit-size of the key. It's up to each
1703 * creation mechanism to verify that this information is correct.
1704 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001705 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001706 * is optional (import, copy). In case of a volatile key, assign it the
1707 * volatile key identifier associated to the slot returned to contain its
1708 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001709
1710 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001711 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1712 {
1713#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1714 slot->attr.id = volatile_key_id;
1715#else
1716 slot->attr.id.key_id = volatile_key_id;
1717#endif
1718 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001719
Gilles Peskine91e8c332019-08-02 19:19:39 +02001720 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001721 * external-only flags, query `attributes`. Thanks to the check
1722 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001723 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001724 * may have set. */
1725 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001726
Gilles Peskinecbaff462019-07-12 23:46:04 +02001727#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001728 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001729 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001730 * create the key file in internal storage, create the
1731 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001732 * persistent data. This is done by starting a transaction that will
1733 * encompass these three actions.
1734 * For registering a volatile key, we just need to find an appropriate
1735 * slot number inside the SE. Since the key is designated volatile, creating
1736 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001737 /* The first thing to do is to find a slot number for the new key.
1738 * We save the slot number in persistent storage as part of the
1739 * transaction data. It will be needed to recover if the power
1740 * fails during the key creation process, to clean up on the secure
1741 * element side after restarting. Obtaining a slot number from the
1742 * secure element driver updates its persistent state, but we do not yet
1743 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001744 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001745 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001746 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001747 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001748 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001750 if( status != PSA_SUCCESS )
1751 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001752
1753 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001754 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001755 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1756 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001757 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001758 psa_crypto_transaction.key.id = slot->attr.id;
1759 status = psa_crypto_save_transaction( );
1760 if( status != PSA_SUCCESS )
1761 {
1762 (void) psa_crypto_stop_transaction( );
1763 return( status );
1764 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001765 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001766
1767 status = psa_copy_key_material_into_slot(
1768 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001769 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001770
1771 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1772 {
1773 /* Key registration only makes sense with a secure element. */
1774 return( PSA_ERROR_INVALID_ARGUMENT );
1775 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001776#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1777
Ronald Cronc4d1b512020-07-31 11:26:37 +02001778 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001779}
Gilles Peskine4747d192019-04-17 15:05:45 +02001780
1781/** Finalize the creation of a key once its key material has been set.
1782 *
1783 * This entails writing the key to persistent storage.
1784 *
1785 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001786 * See the documentation of psa_start_key_creation() for the intended use
1787 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 *
Ronald Cron5c522922020-11-14 16:35:34 +01001789 * If the finalization succeeds, the function unlocks the key slot (it was
1790 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1791 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001792 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001793 * \param[in,out] slot Pointer to the slot with key material.
1794 * \param[in] driver The secure element driver for the key,
1795 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001796 * \param[out] key On success, identifier of the key. Note that the
1797 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001798 *
1799 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001800 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001801 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1802 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1803 * \retval #PSA_ERROR_ALREADY_EXISTS
1804 * \retval #PSA_ERROR_DATA_INVALID
1805 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001806 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001807 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001808 * \return If this function fails, the key slot is an invalid state.
1809 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001810 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001811static psa_status_t psa_finish_key_creation(
1812 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001813 psa_se_drv_table_entry_t *driver,
1814 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001815{
1816 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001817 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001818 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001819
1820#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001821 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001822 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001823#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1824 if( driver != NULL )
1825 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001826 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001827 psa_key_slot_number_t slot_number =
1828 psa_key_slot_get_slot_number( slot ) ;
1829
Gilles Peskineb46bef22019-07-30 21:32:04 +02001830#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001831 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001832 sizeof( data.slot_number ),
1833 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001834#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001835 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001836 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001837 (uint8_t*) &data,
1838 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001839 }
1840 else
1841#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1842 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001843 /* Key material is saved in export representation in the slot, so
1844 * just pass the slot buffer for storage. */
1845 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001846 slot->key.data,
1847 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001848 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001849 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001850#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1851
Gilles Peskinecbaff462019-07-12 23:46:04 +02001852#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001853 /* Finish the transaction for a key creation. This does not
1854 * happen when registering an existing key. Detect this case
1855 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001856 * creation of a persistent key in a secure element requires a transaction,
1857 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001858 if( driver != NULL &&
1859 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001860 {
1861 status = psa_save_se_persistent_data( driver );
1862 if( status != PSA_SUCCESS )
1863 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001864 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001865 return( status );
1866 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001867 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001868 }
1869#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1870
Ronald Cron50972942020-11-14 11:28:25 +01001871 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001872 {
1873 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001874 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001875 if( status != PSA_SUCCESS )
1876 *key = MBEDTLS_SVC_KEY_ID_INIT;
1877 }
Ronald Cron50972942020-11-14 11:28:25 +01001878
Gilles Peskine4747d192019-04-17 15:05:45 +02001879 return( status );
1880}
1881
1882/** Abort the creation of a key.
1883 *
1884 * You may call this function after calling psa_start_key_creation(),
1885 * or after psa_finish_key_creation() fails. In other circumstances, this
1886 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001887 * See the documentation of psa_start_key_creation() for the intended use
1888 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001889 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001890 * \param[in,out] slot Pointer to the slot with key material.
1891 * \param[in] driver The secure element driver for the key,
1892 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001893 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001894static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001895 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001896{
Gilles Peskine011e4282019-06-26 18:34:38 +02001897 (void) driver;
1898
Gilles Peskine4747d192019-04-17 15:05:45 +02001899 if( slot == NULL )
1900 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001901
1902#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001903 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001904 * element, and the failure happened later (when saving metadata
1905 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001906 * element.
1907 * https://github.com/ARMmbed/mbed-crypto/issues/217
1908 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001909
Gilles Peskined7729582019-08-05 15:55:54 +02001910 /* Abort the ongoing transaction if any (there may not be one if
1911 * the creation process failed before starting one, or if the
1912 * key creation is a registration of a key in a secure element).
1913 * Earlier functions must already have done what it takes to undo any
1914 * partial creation. All that's left is to update the transaction data
1915 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001916 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001917#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1918
Gilles Peskine4747d192019-04-17 15:05:45 +02001919 psa_wipe_key_slot( slot );
1920}
1921
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001922/** Validate optional attributes during key creation.
1923 *
1924 * Some key attributes are optional during key creation. If they are
1925 * specified in the attributes structure, check that they are consistent
1926 * with the data in the slot.
1927 *
1928 * This function should be called near the end of key creation, after
1929 * the slot in memory is fully populated but before saving persistent data.
1930 */
1931static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001932 const psa_key_slot_t *slot,
1933 const psa_key_attributes_t *attributes )
1934{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001935 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001936 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001937 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001938 return( PSA_ERROR_INVALID_ARGUMENT );
1939 }
1940
1941 if( attributes->domain_parameters_size != 0 )
1942 {
John Durkop0e005192020-10-31 22:06:54 -07001943#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1944 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001945 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001947 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001948 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001949 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001950
Ronald Cron90857082020-11-25 14:58:33 +01001951 psa_status_t status = mbedtls_psa_rsa_load_representation(
1952 slot->attr.type,
1953 slot->key.data,
1954 slot->key.bytes,
1955 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001956 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001957 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001958
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001959 mbedtls_mpi_init( &actual );
1960 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001961 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001962 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001963 mbedtls_rsa_free( rsa );
1964 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001965 if( ret != 0 )
1966 goto rsa_exit;
1967 ret = mbedtls_mpi_read_binary( &required,
1968 attributes->domain_parameters,
1969 attributes->domain_parameters_size );
1970 if( ret != 0 )
1971 goto rsa_exit;
1972 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1973 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1974 rsa_exit:
1975 mbedtls_mpi_free( &actual );
1976 mbedtls_mpi_free( &required );
1977 if( ret != 0)
1978 return( mbedtls_to_psa_error( ret ) );
1979 }
1980 else
John Durkop9814fa22020-11-04 12:28:15 -08001981#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1982 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001983 {
1984 return( PSA_ERROR_INVALID_ARGUMENT );
1985 }
1986 }
1987
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001988 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001989 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001990 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001991 return( PSA_ERROR_INVALID_ARGUMENT );
1992 }
1993
1994 return( PSA_SUCCESS );
1995}
1996
Gilles Peskine4747d192019-04-17 15:05:45 +02001997psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001998 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001999 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002000 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002001{
2002 psa_status_t status;
2003 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002004 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002005 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006
Ronald Cron81709fc2020-11-14 12:10:32 +01002007 *key = MBEDTLS_SVC_KEY_ID_INIT;
2008
Gilles Peskine0f84d622019-09-12 19:03:13 +02002009 /* Reject zero-length symmetric keys (including raw data key objects).
2010 * This also rejects any key which might be encoded as an empty string,
2011 * which is never valid. */
2012 if( data_length == 0 )
2013 return( PSA_ERROR_INVALID_ARGUMENT );
2014
Gilles Peskinedf179142019-07-15 22:02:14 +02002015 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 if( status != PSA_SUCCESS )
2018 goto exit;
2019
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002020 /* In the case of a transparent key or an opaque key stored in local
2021 * storage (thus not in the case of generating a key in a secure element
2022 * or cryptoprocessor with storage), we have to allocate a buffer to
2023 * hold the generated key material. */
2024 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02002025 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002026 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002027 if( status != PSA_SUCCESS )
2028 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002029 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002030
2031 bits = slot->attr.bits;
2032 status = psa_driver_wrapper_import_key( attributes,
2033 data, data_length,
2034 slot->key.data,
2035 slot->key.bytes,
2036 &slot->key.bytes, &bits );
2037 if( status != PSA_SUCCESS )
2038 goto exit;
2039
2040 if( slot->attr.bits == 0 )
2041 slot->attr.bits = (psa_key_bits_t) bits;
2042 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002043 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002044 status = PSA_ERROR_INVALID_ARGUMENT;
2045 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002046 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002047
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002048 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002049 if( status != PSA_SUCCESS )
2050 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002051
Ronald Cron81709fc2020-11-14 12:10:32 +01002052 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002053exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002054 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002055 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002056
Gilles Peskine4747d192019-04-17 15:05:45 +02002057 return( status );
2058}
2059
Gilles Peskined7729582019-08-05 15:55:54 +02002060#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2061psa_status_t mbedtls_psa_register_se_key(
2062 const psa_key_attributes_t *attributes )
2063{
2064 psa_status_t status;
2065 psa_key_slot_t *slot = NULL;
2066 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002067 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002068
2069 /* Leaving attributes unspecified is not currently supported.
2070 * It could make sense to query the key type and size from the
2071 * secure element, but not all secure elements support this
2072 * and the driver HAL doesn't currently support it. */
2073 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2074 return( PSA_ERROR_NOT_SUPPORTED );
2075 if( psa_get_key_bits( attributes ) == 0 )
2076 return( PSA_ERROR_NOT_SUPPORTED );
2077
2078 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002079 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002080 if( status != PSA_SUCCESS )
2081 goto exit;
2082
Ronald Cron81709fc2020-11-14 12:10:32 +01002083 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002084
2085exit:
2086 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002087 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002088
Gilles Peskined7729582019-08-05 15:55:54 +02002089 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002090 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002091 return( status );
2092}
2093#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2094
Gilles Peskinef603c712019-01-19 13:40:11 +01002095static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002096 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002097{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002098 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002099 source->key.data,
2100 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002101 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002102 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002103
Steven Cooreman398aee52020-10-13 14:35:45 +02002104 target->attr.type = source->attr.type;
2105 target->attr.bits = source->attr.bits;
2106
2107 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002108}
2109
Ronald Croncf56a0a2020-08-04 09:51:30 +02002110psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002111 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002112 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002113{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002114 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002115 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002116 psa_key_slot_t *source_slot = NULL;
2117 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002118 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002119 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002120
Ronald Cron81709fc2020-11-14 12:10:32 +01002121 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2122
Ronald Cron5c522922020-11-14 16:35:34 +01002123 status = psa_get_and_lock_transparent_key_slot_with_policy(
2124 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002125 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002126 goto exit;
2127
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002128 status = psa_validate_optional_attributes( source_slot,
2129 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002130 if( status != PSA_SUCCESS )
2131 goto exit;
2132
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002133 status = psa_restrict_key_policy( source_slot->attr.type,
2134 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002135 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002136 if( status != PSA_SUCCESS )
2137 goto exit;
2138
Ronald Cron81709fc2020-11-14 12:10:32 +01002139 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2140 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002141 if( status != PSA_SUCCESS )
2142 goto exit;
2143
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002144#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2145 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002146 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002147 /* Copying to a secure element is not implemented yet. */
2148 status = PSA_ERROR_NOT_SUPPORTED;
2149 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002150 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002151#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002152
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002153 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002154 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002155 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002156
Ronald Cron81709fc2020-11-14 12:10:32 +01002157 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002158exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002159 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002160 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002161
Ronald Cron5c522922020-11-14 16:35:34 +01002162 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002163
Ronald Cron5c522922020-11-14 16:35:34 +01002164 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002165}
2166
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002167
2168
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002169/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002170/* Message digests */
2171/****************************************************************/
2172
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2174{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002175 /* Aborting a non-active operation is allowed */
2176 if( operation->id == 0 )
2177 return( PSA_SUCCESS );
2178
2179 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2180 operation->id = 0;
2181
2182 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183}
2184
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002185psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002186 psa_algorithm_t alg )
2187{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002188 /* A context must be freshly initialized before it can be set up. */
2189 if( operation->id != 0 )
2190 return( PSA_ERROR_BAD_STATE );
2191
2192 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002193 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002194
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002195 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2196 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002197 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2198
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002199 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002200}
2201
2202psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2203 const uint8_t *input,
2204 size_t input_length )
2205{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002206 if( operation->id == 0 )
2207 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002208
Steven Cooremanc8288352021-03-04 14:02:19 +01002209 /* Don't require hash implementations to behave correctly on a
2210 * zero-length input, which may have an invalid pointer. */
2211 if( input_length == 0 )
2212 return( PSA_SUCCESS );
2213
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002214 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2215 input, input_length );
2216 if( status != PSA_SUCCESS )
2217 psa_hash_abort( operation );
2218
2219 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002220}
2221
2222psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2223 uint8_t *hash,
2224 size_t hash_size,
2225 size_t *hash_length )
2226{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002227 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002228 if( operation->id == 0 )
2229 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002230
Steven Cooreman1e582352021-02-18 17:24:37 +01002231 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002233 psa_hash_abort( operation );
2234 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002235}
2236
Gilles Peskine2d277862018-06-18 15:41:12 +02002237psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2238 const uint8_t *hash,
2239 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240{
2241 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2242 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002243 psa_status_t status = psa_hash_finish(
2244 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002245 actual_hash, sizeof( actual_hash ),
2246 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002247 if( status != PSA_SUCCESS )
2248 return( status );
2249 if( actual_hash_length != hash_length )
2250 return( PSA_ERROR_INVALID_SIGNATURE );
2251 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2252 return( PSA_ERROR_INVALID_SIGNATURE );
2253 return( PSA_SUCCESS );
2254}
2255
Gilles Peskine0a749c82019-11-28 19:33:58 +01002256psa_status_t psa_hash_compute( psa_algorithm_t alg,
2257 const uint8_t *input, size_t input_length,
2258 uint8_t *hash, size_t hash_size,
2259 size_t *hash_length )
2260{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002261 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002262 if( !PSA_ALG_IS_HASH( alg ) )
2263 return( PSA_ERROR_INVALID_ARGUMENT );
2264
Steven Cooreman1e582352021-02-18 17:24:37 +01002265 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2266 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002267}
2268
2269psa_status_t psa_hash_compare( psa_algorithm_t alg,
2270 const uint8_t *input, size_t input_length,
2271 const uint8_t *hash, size_t hash_length )
2272{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002273 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2274 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002275
2276 if( !PSA_ALG_IS_HASH( alg ) )
2277 return( PSA_ERROR_INVALID_ARGUMENT );
2278
Steven Cooreman1e582352021-02-18 17:24:37 +01002279 psa_status_t status = psa_driver_wrapper_hash_compute(
2280 alg, input, input_length,
2281 actual_hash, sizeof(actual_hash),
2282 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002283 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002284 return( status );
2285 if( actual_hash_length != hash_length )
2286 return( PSA_ERROR_INVALID_SIGNATURE );
2287 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2288 return( PSA_ERROR_INVALID_SIGNATURE );
2289 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002290}
2291
Gilles Peskineeb35d782019-01-22 17:56:16 +01002292psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2293 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002294{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002295 if( source_operation->id == 0 ||
2296 target_operation->id != 0 )
2297 {
2298 return( PSA_ERROR_BAD_STATE );
2299 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002300
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002301 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2302 target_operation );
2303 if( status != PSA_SUCCESS )
2304 psa_hash_abort( target_operation );
2305
2306 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002307}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002308
2309
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002310/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002311/* MAC */
2312/****************************************************************/
2313
Ronald Cron7986f7e2021-03-09 10:03:08 +01002314const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002315 psa_algorithm_t alg,
2316 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002317 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002318 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002319{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002321 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002322
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002323 if( PSA_ALG_IS_AEAD( alg ) )
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002324 alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002325
Gilles Peskine8c9def32018-02-08 10:02:12 +01002326 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2327 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002328 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002329 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002330 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002331 mode = MBEDTLS_MODE_STREAM;
2332 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002333 case PSA_ALG_CTR:
2334 mode = MBEDTLS_MODE_CTR;
2335 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002336 case PSA_ALG_CFB:
2337 mode = MBEDTLS_MODE_CFB;
2338 break;
2339 case PSA_ALG_OFB:
2340 mode = MBEDTLS_MODE_OFB;
2341 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002342 case PSA_ALG_ECB_NO_PADDING:
2343 mode = MBEDTLS_MODE_ECB;
2344 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002345 case PSA_ALG_CBC_NO_PADDING:
2346 mode = MBEDTLS_MODE_CBC;
2347 break;
2348 case PSA_ALG_CBC_PKCS7:
2349 mode = MBEDTLS_MODE_CBC;
2350 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002351 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002352 mode = MBEDTLS_MODE_CCM;
2353 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002354 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355 mode = MBEDTLS_MODE_GCM;
2356 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002357 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02002358 mode = MBEDTLS_MODE_CHACHAPOLY;
2359 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002360 default:
2361 return( NULL );
2362 }
2363 }
2364 else if( alg == PSA_ALG_CMAC )
2365 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002366 else
2367 return( NULL );
2368
2369 switch( key_type )
2370 {
2371 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002372 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373 break;
2374 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002375 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2376 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002377 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002378 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002379 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002380 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002381 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2382 * but two-key Triple-DES is functionally three-key Triple-DES
2383 * with K1=K3, so that's how we present it to mbedtls. */
2384 if( key_bits == 128 )
2385 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002386 break;
2387 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002388 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002389 break;
2390 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002391 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002392 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002393 case PSA_KEY_TYPE_CHACHA20:
2394 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2395 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002396 default:
2397 return( NULL );
2398 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002399 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002400 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002401
Jaeden Amero23bbb752018-06-26 14:16:54 +01002402 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2403 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002404}
2405
John Durkop6ba40d12020-11-10 08:50:04 -08002406#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002407static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002408{
Gilles Peskine2d277862018-06-18 15:41:12 +02002409 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002410 {
2411 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002412 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002413 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002414 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002415 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002416 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002417 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002418 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002419 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002420 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002421 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002422 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002423 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002424 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002425 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002426 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002427 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002428 return( 128 );
2429 default:
2430 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002431 }
2432}
John Durkop07cc04a2020-11-16 22:08:34 -08002433#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002434
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002435/* Initialize the MAC operation structure. Once this function has been
2436 * called, psa_mac_abort can run and will do the right thing. */
2437static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2438 psa_algorithm_t alg )
2439{
2440 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2441
Steven Cooreman15472f82021-03-02 16:16:22 +01002442 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002443 operation->key_set = 0;
2444 operation->iv_set = 0;
2445 operation->iv_required = 0;
2446 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002447 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002448
Ronald Cron3d471812021-03-18 13:40:31 +01002449#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002450 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002451 {
2452 operation->iv_required = 0;
2453 mbedtls_cipher_init( &operation->ctx.cmac );
2454 status = PSA_SUCCESS;
2455 }
2456 else
Ronald Cron3d471812021-03-18 13:40:31 +01002457#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002458#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002459 if( PSA_ALG_IS_HMAC( operation->alg ) )
2460 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002461 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002462 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002463 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002464 }
2465 else
John Durkopd0321952020-10-29 21:37:36 -07002466#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002467 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002468 if( ! PSA_ALG_IS_MAC( alg ) )
2469 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002470 }
2471
2472 if( status != PSA_SUCCESS )
2473 memset( operation, 0, sizeof( *operation ) );
2474 return( status );
2475}
2476
John Durkop6ba40d12020-11-10 08:50:04 -08002477#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002478static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2479{
Gilles Peskine3f108122018-12-07 18:14:53 +01002480 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002481 return( psa_hash_abort( &hmac->hash_ctx ) );
2482}
John Durkop6ba40d12020-11-10 08:50:04 -08002483#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002484
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2486{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002487 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002488 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002489 /* The object has (apparently) been initialized but it is not
2490 * in use. It's ok to call abort on such an object, and there's
2491 * nothing to do. */
2492 return( PSA_SUCCESS );
2493 }
2494 else
Ronald Cron3d471812021-03-18 13:40:31 +01002495#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002496 if( operation->alg == PSA_ALG_CMAC )
2497 {
2498 mbedtls_cipher_free( &operation->ctx.cmac );
2499 }
2500 else
Ronald Cron3d471812021-03-18 13:40:31 +01002501#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002502#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002503 if( PSA_ALG_IS_HMAC( operation->alg ) )
2504 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002505 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002506 }
2507 else
John Durkopd0321952020-10-29 21:37:36 -07002508#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002509 {
2510 /* Sanity check (shouldn't happen: operation->alg should
2511 * always have been initialized to a valid value). */
2512 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002513 }
Moran Peker41deec42018-04-04 15:43:05 +03002514
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515 operation->alg = 0;
2516 operation->key_set = 0;
2517 operation->iv_set = 0;
2518 operation->iv_required = 0;
2519 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002520 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002521
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002523
2524bad_state:
2525 /* If abort is called on an uninitialized object, we can't trust
2526 * anything. Wipe the object in case it contains confidential data.
2527 * This may result in a memory leak if a pointer gets overwritten,
2528 * but it's too late to do anything about this. */
2529 memset( operation, 0, sizeof( *operation ) );
2530 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531}
2532
Ronald Cron3d471812021-03-18 13:40:31 +01002533#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002534static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2535 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002536{
Janos Follath24eed8d2019-11-22 13:21:35 +00002537 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002538 const mbedtls_cipher_info_t *cipher_info =
2539 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2540 slot->attr.type, slot->attr.bits,
2541 NULL );
2542 if( cipher_info == NULL )
2543 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002544
2545 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2546 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002547 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002548
2549 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002550 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002551 slot->attr.bits );
2552exit:
2553 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002554}
Ronald Cron3d471812021-03-18 13:40:31 +01002555#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002556
John Durkop6ba40d12020-11-10 08:50:04 -08002557#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002558static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2559 const uint8_t *key,
2560 size_t key_length,
2561 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002562{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002563 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002564 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002565 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002566 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002567 psa_status_t status;
2568
Steven Cooreman0e307642021-02-18 16:18:32 +01002569 hmac->alg = hash_alg;
2570
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002571 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2572 * overflow below. This should never trigger if the hash algorithm
2573 * is implemented correctly. */
2574 /* The size checks against the ipad and opad buffers cannot be written
2575 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2576 * because that triggers -Wlogical-op on GCC 7.3. */
2577 if( block_size > sizeof( ipad ) )
2578 return( PSA_ERROR_NOT_SUPPORTED );
2579 if( block_size > sizeof( hmac->opad ) )
2580 return( PSA_ERROR_NOT_SUPPORTED );
2581 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002582 return( PSA_ERROR_NOT_SUPPORTED );
2583
Gilles Peskined223b522018-06-11 18:12:58 +02002584 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002585 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002586 status = psa_hash_compute( hash_alg, key, key_length,
2587 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002588 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002589 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002590 }
Gilles Peskine96889972018-07-12 17:07:03 +02002591 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2592 * but it is permitted. It is common when HMAC is used in HKDF, for
2593 * example. Don't call `memcpy` in the 0-length because `key` could be
2594 * an invalid pointer which would make the behavior undefined. */
2595 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002596 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002597
Gilles Peskined223b522018-06-11 18:12:58 +02002598 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2599 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002600 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002601 ipad[i] ^= 0x36;
2602 memset( ipad + key_length, 0x36, block_size - key_length );
2603
2604 /* Copy the key material from ipad to opad, flipping the requisite bits,
2605 * and filling the rest of opad with the requisite constant. */
2606 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002607 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2608 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002609
Gilles Peskine01126fa2018-07-12 17:04:55 +02002610 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002611 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002612 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002613
Gilles Peskine01126fa2018-07-12 17:04:55 +02002614 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002615
2616cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002617 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002618
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002619 return( status );
2620}
John Durkop6ba40d12020-11-10 08:50:04 -08002621#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002622
Gilles Peskine89167cb2018-07-08 20:12:23 +02002623static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002624 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002625 psa_algorithm_t alg,
2626 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002627{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002629 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002630 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002631 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002632 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002633
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002634 /* A context must be freshly initialized before it can be set up. */
2635 if( operation->alg != 0 )
2636 {
2637 return( PSA_ERROR_BAD_STATE );
2638 }
2639
Steven Cooreman15472f82021-03-02 16:16:22 +01002640 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002641 if( status != PSA_SUCCESS )
2642 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002643 if( is_sign )
2644 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002645
Ronald Cron5c522922020-11-14 16:35:34 +01002646 status = psa_get_and_lock_transparent_key_slot_with_policy(
2647 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002648 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002649 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002650
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002651 /* Validate the combination of key type and algorithm */
2652 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002653 if( status != PSA_SUCCESS )
2654 goto exit;
2655
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002656 /* Get the output length for the algorithm and key combination. None of the
2657 * currently supported algorithms have an output length dependent on actual
2658 * key size, so setting it to a bogus value is currently OK. */
2659 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002660
2661 if( operation->mac_size < 4 )
2662 {
2663 /* A very short MAC is too short for security since it can be
2664 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2665 * so we make this our minimum, even though 32 bits is still
2666 * too small for security. */
2667 status = PSA_ERROR_NOT_SUPPORTED;
2668 goto exit;
2669 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002670
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002671 if( operation->mac_size >
2672 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2673 {
2674 /* It's impossible to "truncate" to a larger length than the full length
2675 * of the algorithm. */
2676 status = PSA_ERROR_INVALID_ARGUMENT;
2677 goto exit;
2678 }
2679
Ronald Cron3d471812021-03-18 13:40:31 +01002680#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002681 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002682 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002683 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002684 }
2685 else
Ronald Cron3d471812021-03-18 13:40:31 +01002686#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002687#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002688 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002689 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002690 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002691 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002692 {
2693 status = PSA_ERROR_NOT_SUPPORTED;
2694 goto exit;
2695 }
2696
Gilles Peskine8e338702019-07-30 20:06:31 +02002697 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002698 {
2699 status = PSA_ERROR_INVALID_ARGUMENT;
2700 goto exit;
2701 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002702
Gilles Peskine01126fa2018-07-12 17:04:55 +02002703 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002704 slot->key.data,
2705 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002706 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002707 }
2708 else
John Durkopd0321952020-10-29 21:37:36 -07002709#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002710 {
2711 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002712 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002713
Gilles Peskinefbfac682018-07-08 20:51:54 +02002714exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002715 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002716 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002717 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002718 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002719 else
2720 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002721 operation->key_set = 1;
2722 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002723
Ronald Cron5c522922020-11-14 16:35:34 +01002724 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002725
Ronald Cron5c522922020-11-14 16:35:34 +01002726 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727}
2728
Gilles Peskine89167cb2018-07-08 20:12:23 +02002729psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002730 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002731 psa_algorithm_t alg )
2732{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002733 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002734}
2735
2736psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002737 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002738 psa_algorithm_t alg )
2739{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002740 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002741}
2742
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2744 const uint8_t *input,
2745 size_t input_length )
2746{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002747 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002748 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002749 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002750 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002751 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002752 operation->has_input = 1;
2753
Ronald Cron3d471812021-03-18 13:40:31 +01002754#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002755 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002756 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002757 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2758 input, input_length );
2759 status = mbedtls_to_psa_error( ret );
2760 }
2761 else
Ronald Cron3d471812021-03-18 13:40:31 +01002762#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002763#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002764 if( PSA_ALG_IS_HMAC( operation->alg ) )
2765 {
2766 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2767 input_length );
2768 }
2769 else
John Durkopd0321952020-10-29 21:37:36 -07002770#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002771 {
2772 /* This shouldn't happen if `operation` was initialized by
2773 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002774 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002775 }
2776
Gilles Peskinefbfac682018-07-08 20:51:54 +02002777 if( status != PSA_SUCCESS )
2778 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002779 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002780}
2781
John Durkop6ba40d12020-11-10 08:50:04 -08002782#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002783static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2784 uint8_t *mac,
2785 size_t mac_size )
2786{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002787 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002788 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002789 size_t hash_size = 0;
2790 size_t block_size = psa_get_hash_block_size( hash_alg );
2791 psa_status_t status;
2792
Gilles Peskine01126fa2018-07-12 17:04:55 +02002793 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2794 if( status != PSA_SUCCESS )
2795 return( status );
2796 /* From here on, tmp needs to be wiped. */
2797
2798 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2799 if( status != PSA_SUCCESS )
2800 goto exit;
2801
2802 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2803 if( status != PSA_SUCCESS )
2804 goto exit;
2805
2806 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2807 if( status != PSA_SUCCESS )
2808 goto exit;
2809
Gilles Peskined911eb72018-08-14 15:18:45 +02002810 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2811 if( status != PSA_SUCCESS )
2812 goto exit;
2813
2814 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002815
2816exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002817 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002818 return( status );
2819}
John Durkop6ba40d12020-11-10 08:50:04 -08002820#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002821
mohammad16036df908f2018-04-02 08:34:15 -07002822static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002823 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002824 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002825{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002826 if( ! operation->key_set )
2827 return( PSA_ERROR_BAD_STATE );
2828 if( operation->iv_required && ! operation->iv_set )
2829 return( PSA_ERROR_BAD_STATE );
2830
Gilles Peskine8c9def32018-02-08 10:02:12 +01002831 if( mac_size < operation->mac_size )
2832 return( PSA_ERROR_BUFFER_TOO_SMALL );
2833
Ronald Cron3d471812021-03-18 13:40:31 +01002834#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002835 if( operation->alg == PSA_ALG_CMAC )
2836 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002837 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002838 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2839 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002840 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002841 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002842 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002843 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002844 else
Ronald Cron3d471812021-03-18 13:40:31 +01002845#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002846#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002847 if( PSA_ALG_IS_HMAC( operation->alg ) )
2848 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002849 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002850 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002851 }
2852 else
John Durkopd0321952020-10-29 21:37:36 -07002853#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002854 {
2855 /* This shouldn't happen if `operation` was initialized by
2856 * a setup function. */
2857 return( PSA_ERROR_BAD_STATE );
2858 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859}
2860
Gilles Peskineacd4be32018-07-08 19:56:25 +02002861psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2862 uint8_t *mac,
2863 size_t mac_size,
2864 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002865{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002866 psa_status_t status;
2867
Jaeden Amero252ef282019-02-15 14:05:35 +00002868 if( operation->alg == 0 )
2869 {
2870 return( PSA_ERROR_BAD_STATE );
2871 }
2872
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002873 /* Fill the output buffer with something that isn't a valid mac
2874 * (barring an attack on the mac and deliberately-crafted input),
2875 * in case the caller doesn't check the return status properly. */
2876 *mac_length = mac_size;
2877 /* If mac_size is 0 then mac may be NULL and then the
2878 * call to memset would have undefined behavior. */
2879 if( mac_size != 0 )
2880 memset( mac, '!', mac_size );
2881
Gilles Peskine89167cb2018-07-08 20:12:23 +02002882 if( ! operation->is_sign )
2883 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002884 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002885 }
mohammad16036df908f2018-04-02 08:34:15 -07002886
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002887 status = psa_mac_finish_internal( operation, mac, mac_size );
2888
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002889 if( status == PSA_SUCCESS )
2890 {
2891 status = psa_mac_abort( operation );
2892 if( status == PSA_SUCCESS )
2893 *mac_length = operation->mac_size;
2894 else
2895 memset( mac, '!', mac_size );
2896 }
2897 else
2898 psa_mac_abort( operation );
2899 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002900}
2901
Gilles Peskineacd4be32018-07-08 19:56:25 +02002902psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2903 const uint8_t *mac,
2904 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002905{
Gilles Peskine828ed142018-06-18 23:25:51 +02002906 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002907 psa_status_t status;
2908
Jaeden Amero252ef282019-02-15 14:05:35 +00002909 if( operation->alg == 0 )
2910 {
2911 return( PSA_ERROR_BAD_STATE );
2912 }
2913
Gilles Peskine89167cb2018-07-08 20:12:23 +02002914 if( operation->is_sign )
2915 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002916 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002917 }
2918 if( operation->mac_size != mac_length )
2919 {
2920 status = PSA_ERROR_INVALID_SIGNATURE;
2921 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002922 }
mohammad16036df908f2018-04-02 08:34:15 -07002923
2924 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002925 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002926 if( status != PSA_SUCCESS )
2927 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002928
2929 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2930 status = PSA_ERROR_INVALID_SIGNATURE;
2931
2932cleanup:
2933 if( status == PSA_SUCCESS )
2934 status = psa_mac_abort( operation );
2935 else
2936 psa_mac_abort( operation );
2937
Gilles Peskine3f108122018-12-07 18:14:53 +01002938 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002939
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002940 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941}
2942
2943
Gilles Peskine20035e32018-02-03 22:44:14 +01002944
Gilles Peskine20035e32018-02-03 22:44:14 +01002945/****************************************************************/
2946/* Asymmetric cryptography */
2947/****************************************************************/
2948
Ronald Cron67b1eb32020-12-08 17:37:27 +01002949psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002950 const psa_key_attributes_t *attributes,
2951 const uint8_t *key_buffer, size_t key_buffer_size,
2952 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2953 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002954{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002955 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002956 {
Ronald Cron4501c982021-03-19 20:09:32 +01002957 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2958 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002959 {
Ronald Cron4501c982021-03-19 20:09:32 +01002960#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2961 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2962 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002963 attributes,
2964 key_buffer, key_buffer_size,
2965 alg, hash, hash_length,
2966 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002967#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2968 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002969 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002970 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002971 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002972 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002973 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002974 }
2975 else
Ronald Cron4501c982021-03-19 20:09:32 +01002976 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2977 {
2978 if( PSA_ALG_IS_ECDSA( alg ) )
2979 {
2980#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2981 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2982 return( mbedtls_psa_ecdsa_sign_hash(
2983 attributes,
2984 key_buffer, key_buffer_size,
2985 alg, hash, hash_length,
2986 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002987#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2988 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002989 }
2990 else
2991 {
2992 return( PSA_ERROR_INVALID_ARGUMENT );
2993 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002994 }
Ronald Cron4501c982021-03-19 20:09:32 +01002995
2996 (void)key_buffer;
2997 (void)key_buffer_size;
2998 (void)hash;
2999 (void)hash_length;
3000 (void)signature;
3001 (void)signature_size;
3002 (void)signature_length;
3003
3004 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003005}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003006
3007psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
3008 psa_algorithm_t alg,
3009 const uint8_t *hash,
3010 size_t hash_length,
3011 uint8_t *signature,
3012 size_t signature_size,
3013 size_t *signature_length )
3014{
3015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3016 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3017 psa_key_slot_t *slot;
3018
3019 *signature_length = signature_size;
3020 /* Immediately reject a zero-length signature buffer. This guarantees
3021 * that signature must be a valid pointer. (On the other hand, the hash
3022 * buffer can in principle be empty since it doesn't actually have
3023 * to be a hash.) */
3024 if( signature_size == 0 )
3025 return( PSA_ERROR_BUFFER_TOO_SMALL );
3026
3027 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3028 PSA_KEY_USAGE_SIGN_HASH,
3029 alg );
3030 if( status != PSA_SUCCESS )
3031 goto exit;
3032 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
3033 {
3034 status = PSA_ERROR_INVALID_ARGUMENT;
3035 goto exit;
3036 }
3037
Ronald Cron9f17aa42020-12-08 17:07:25 +01003038 psa_key_attributes_t attributes = {
3039 .core = slot->attr
3040 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003041
Ronald Cron9f17aa42020-12-08 17:07:25 +01003042 status = psa_driver_wrapper_sign_hash(
3043 &attributes, slot->key.data, slot->key.bytes,
3044 alg, hash, hash_length,
3045 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003046
3047exit:
3048 /* Fill the unused part of the output buffer (the whole buffer on error,
3049 * the trailing part on success) with something that isn't a valid mac
3050 * (barring an attack on the mac and deliberately-crafted input),
3051 * in case the caller doesn't check the return status properly. */
3052 if( status == PSA_SUCCESS )
3053 memset( signature + *signature_length, '!',
3054 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003055 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003056 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003057 /* If signature_size is 0 then we have nothing to do. We must not call
3058 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003059
Ronald Cron5c522922020-11-14 16:35:34 +01003060 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003061
Ronald Cron5c522922020-11-14 16:35:34 +01003062 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003063}
3064
Ronald Cron67b1eb32020-12-08 17:37:27 +01003065psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01003066 const psa_key_attributes_t *attributes,
3067 const uint8_t *key_buffer, size_t key_buffer_size,
3068 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3069 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003070{
Ronald Cron99b8ed72021-02-17 10:33:32 +01003071 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003072 {
Ronald Cron4501c982021-03-19 20:09:32 +01003073 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
3074 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003075 {
Ronald Cron4501c982021-03-19 20:09:32 +01003076#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3077 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3078 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01003079 attributes,
3080 key_buffer, key_buffer_size,
3081 alg, hash, hash_length,
3082 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01003083#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3084 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02003085 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003086 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003087 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003088 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003089 }
itayzafrir5c753392018-05-08 11:18:38 +03003090 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003091 else
Ronald Cron4501c982021-03-19 20:09:32 +01003092 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003093 {
Ronald Cron4501c982021-03-19 20:09:32 +01003094 if( PSA_ALG_IS_ECDSA( alg ) )
3095 {
3096#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3097 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3098 return( mbedtls_psa_ecdsa_verify_hash(
3099 attributes,
3100 key_buffer, key_buffer_size,
3101 alg, hash, hash_length,
3102 signature, signature_length ) );
3103#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3104 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3105 }
3106 else
3107 {
3108 return( PSA_ERROR_INVALID_ARGUMENT );
3109 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003110 }
Ronald Cron4501c982021-03-19 20:09:32 +01003111
3112 (void)key_buffer;
3113 (void)key_buffer_size;
3114 (void)hash;
3115 (void)hash_length;
3116 (void)signature;
3117 (void)signature_length;
3118
3119 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003120}
3121
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003122psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3123 psa_algorithm_t alg,
3124 const uint8_t *hash,
3125 size_t hash_length,
3126 const uint8_t *signature,
3127 size_t signature_length )
3128{
3129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3130 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003131 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003132
3133 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003134 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003135 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003136 if( status != PSA_SUCCESS )
3137 return( status );
3138
Ronald Cron9f17aa42020-12-08 17:07:25 +01003139 psa_key_attributes_t attributes = {
3140 .core = slot->attr
3141 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003142
Ronald Cron9f17aa42020-12-08 17:07:25 +01003143 status = psa_driver_wrapper_verify_hash(
3144 &attributes, slot->key.data, slot->key.bytes,
3145 alg, hash, hash_length,
3146 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003147
Ronald Cron5c522922020-11-14 16:35:34 +01003148 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003149
Ronald Cron5c522922020-11-14 16:35:34 +01003150 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003151}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003152
John Durkop0e005192020-10-31 22:06:54 -07003153#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003154static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3155 mbedtls_rsa_context *rsa )
3156{
3157 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3158 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3159 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3160 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3161}
John Durkop0e005192020-10-31 22:06:54 -07003162#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003163
Ronald Croncf56a0a2020-08-04 09:51:30 +02003164psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003165 psa_algorithm_t alg,
3166 const uint8_t *input,
3167 size_t input_length,
3168 const uint8_t *salt,
3169 size_t salt_length,
3170 uint8_t *output,
3171 size_t output_size,
3172 size_t *output_length )
3173{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003174 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003175 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003176 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003177
Darryl Green5cc689a2018-07-24 15:34:10 +01003178 (void) input;
3179 (void) input_length;
3180 (void) salt;
3181 (void) output;
3182 (void) output_size;
3183
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003184 *output_length = 0;
3185
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003186 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3187 return( PSA_ERROR_INVALID_ARGUMENT );
3188
Ronald Cron5c522922020-11-14 16:35:34 +01003189 status = psa_get_and_lock_transparent_key_slot_with_policy(
3190 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003191 if( status != PSA_SUCCESS )
3192 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003193 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3194 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003195 {
3196 status = PSA_ERROR_INVALID_ARGUMENT;
3197 goto exit;
3198 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003199
John Durkop6ba40d12020-11-10 08:50:04 -08003200#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3201 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003202 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003203 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003204 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003205 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3206 slot->key.data,
3207 slot->key.bytes,
3208 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003209 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003210 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003211
3212 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003213 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003214 status = PSA_ERROR_BUFFER_TOO_SMALL;
3215 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003216 }
John Durkop0e005192020-10-31 22:06:54 -07003217#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003218 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3219 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003220 status = mbedtls_to_psa_error(
3221 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003222 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003223 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003224 MBEDTLS_RSA_PUBLIC,
3225 input_length,
3226 input,
3227 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003228 }
3229 else
John Durkop0e005192020-10-31 22:06:54 -07003230#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3231#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003232 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3233 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003234 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003235 status = mbedtls_to_psa_error(
3236 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003237 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003238 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003239 MBEDTLS_RSA_PUBLIC,
3240 salt, salt_length,
3241 input_length,
3242 input,
3243 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003244 }
3245 else
John Durkop0e005192020-10-31 22:06:54 -07003246#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003247 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003248 status = PSA_ERROR_INVALID_ARGUMENT;
3249 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003250 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003251rsa_exit:
3252 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003253 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003254
Steven Cooremana2371e52020-07-28 14:30:39 +02003255 mbedtls_rsa_free( rsa );
3256 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003257 }
3258 else
John Durkop9814fa22020-11-04 12:28:15 -08003259#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003260 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003261 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003262 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003263 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003264
3265exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003266 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003267
Ronald Cron5c522922020-11-14 16:35:34 +01003268 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003269}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003270
Ronald Croncf56a0a2020-08-04 09:51:30 +02003271psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003272 psa_algorithm_t alg,
3273 const uint8_t *input,
3274 size_t input_length,
3275 const uint8_t *salt,
3276 size_t salt_length,
3277 uint8_t *output,
3278 size_t output_size,
3279 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003280{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003281 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003282 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003283 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003284
Darryl Green5cc689a2018-07-24 15:34:10 +01003285 (void) input;
3286 (void) input_length;
3287 (void) salt;
3288 (void) output;
3289 (void) output_size;
3290
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003291 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003292
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003293 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3294 return( PSA_ERROR_INVALID_ARGUMENT );
3295
Ronald Cron5c522922020-11-14 16:35:34 +01003296 status = psa_get_and_lock_transparent_key_slot_with_policy(
3297 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003298 if( status != PSA_SUCCESS )
3299 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003300 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003301 {
3302 status = PSA_ERROR_INVALID_ARGUMENT;
3303 goto exit;
3304 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003305
John Durkop6ba40d12020-11-10 08:50:04 -08003306#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3307 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003308 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003309 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003310 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003311 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3312 slot->key.data,
3313 slot->key.bytes,
3314 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003315 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003316 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003317
Steven Cooremana2371e52020-07-28 14:30:39 +02003318 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003319 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003320 status = PSA_ERROR_INVALID_ARGUMENT;
3321 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003322 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003323
John Durkop0e005192020-10-31 22:06:54 -07003324#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003325 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003326 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003327 status = mbedtls_to_psa_error(
3328 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003329 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003330 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003331 MBEDTLS_RSA_PRIVATE,
3332 output_length,
3333 input,
3334 output,
3335 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003336 }
3337 else
John Durkop0e005192020-10-31 22:06:54 -07003338#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3339#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003340 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003341 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003342 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003343 status = mbedtls_to_psa_error(
3344 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003345 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003346 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003347 MBEDTLS_RSA_PRIVATE,
3348 salt, salt_length,
3349 output_length,
3350 input,
3351 output,
3352 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003353 }
3354 else
John Durkop0e005192020-10-31 22:06:54 -07003355#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003356 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003357 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003358 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003359
Steven Cooreman4fed4552020-08-03 14:46:03 +02003360rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003361 mbedtls_rsa_free( rsa );
3362 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003363 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003364 else
John Durkop6ba40d12020-11-10 08:50:04 -08003365#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3366 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003367 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003368 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003369 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003370
3371exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003372 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003373
Ronald Cron5c522922020-11-14 16:35:34 +01003374 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003375}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003376
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003377
3378
mohammad1603503973b2018-03-12 15:59:30 +02003379/****************************************************************/
3380/* Symmetric cryptography */
3381/****************************************************************/
3382
Ronald Cronab99ac22020-10-01 16:38:28 +02003383static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3384 mbedtls_svc_key_id_t key,
3385 psa_algorithm_t alg,
3386 mbedtls_operation_t cipher_operation )
3387{
3388 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3389 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3390 psa_key_slot_t *slot;
3391 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3392 PSA_KEY_USAGE_ENCRYPT :
3393 PSA_KEY_USAGE_DECRYPT );
3394
3395 /* A context must be freshly initialized before it can be set up. */
3396 if( operation->alg != 0 )
3397 return( PSA_ERROR_BAD_STATE );
3398
3399 /* The requested algorithm must be one that can be processed by cipher. */
3400 if( ! PSA_ALG_IS_CIPHER( alg ) )
3401 return( PSA_ERROR_INVALID_ARGUMENT );
3402
3403 /* Fetch key material from key storage. */
3404 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3405 if( status != PSA_SUCCESS )
3406 goto exit;
3407
3408 /* Initialize the operation struct members, except for alg. The alg member
3409 * is used to indicate to psa_cipher_abort that there are resources to free,
3410 * so we only set it after resources have been allocated/initialized. */
3411 operation->key_set = 0;
3412 operation->iv_set = 0;
3413 operation->mbedtls_in_use = 0;
3414 operation->iv_size = 0;
3415 operation->block_size = 0;
3416 if( alg == PSA_ALG_ECB_NO_PADDING )
3417 operation->iv_required = 0;
3418 else
3419 operation->iv_required = 1;
3420
Ronald Crona4af55f2020-12-14 14:36:06 +01003421 psa_key_attributes_t attributes = {
3422 .core = slot->attr
3423 };
3424
Ronald Cronab99ac22020-10-01 16:38:28 +02003425 /* Try doing the operation through a driver before using software fallback. */
3426 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003427 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3428 &attributes,
3429 slot->key.data,
3430 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003431 alg );
3432 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003433 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3434 &attributes,
3435 slot->key.data,
3436 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003437 alg );
3438
3439 if( status == PSA_SUCCESS )
3440 {
3441 /* Once the driver context is initialized, it needs to be freed using
3442 * psa_cipher_abort. Indicate this through setting alg. */
3443 operation->alg = alg;
3444 }
3445
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003446exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003447 if( status == PSA_SUCCESS )
3448 {
3449 /* Update operation flags for both driver and software implementations */
3450 operation->key_set = 1;
3451 }
3452 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003453 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003454
Ronald Cron5c522922020-11-14 16:35:34 +01003455 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003456
Ronald Cron5c522922020-11-14 16:35:34 +01003457 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003458}
3459
Gilles Peskinefe119512018-07-08 21:39:34 +02003460psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003461 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003462 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003463{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003464 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003465}
3466
Gilles Peskinefe119512018-07-08 21:39:34 +02003467psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003468 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003469 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003470{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003471 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003472}
3473
Gilles Peskinefe119512018-07-08 21:39:34 +02003474psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003475 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003476 size_t iv_size,
3477 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003478{
Ronald Cron6d051732020-10-01 14:10:20 +02003479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003480
3481 if( operation->alg == 0 )
3482 {
3483 return( PSA_ERROR_BAD_STATE );
3484 }
3485
Steven Cooreman7df02922020-09-09 15:28:49 +02003486 if( operation->iv_set || ! operation->iv_required )
3487 {
3488 return( PSA_ERROR_BAD_STATE );
3489 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003490
Ronald Crondd24c9b2020-12-15 14:10:01 +01003491 status = psa_driver_wrapper_cipher_generate_iv( operation,
3492 iv,
3493 iv_size,
3494 iv_length );
Gilles Peskinee553c652018-06-04 16:22:46 +02003495
Steven Cooreman7df02922020-09-09 15:28:49 +02003496 if( status == PSA_SUCCESS )
3497 operation->iv_set = 1;
3498 else
Moran Peker395db872018-05-31 14:07:14 +03003499 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003500
itayzafrir534bd7c2018-08-02 13:56:32 +03003501 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003502}
3503
Gilles Peskinefe119512018-07-08 21:39:34 +02003504psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003505 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003506 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003507{
Ronald Cron6d051732020-10-01 14:10:20 +02003508 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003509
3510 if( operation->alg == 0 )
3511 {
3512 return( PSA_ERROR_BAD_STATE );
3513 }
3514
Steven Cooreman7df02922020-09-09 15:28:49 +02003515 if( operation->iv_set || ! operation->iv_required )
3516 {
3517 return( PSA_ERROR_BAD_STATE );
3518 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003519
Ronald Crondd24c9b2020-12-15 14:10:01 +01003520 status = psa_driver_wrapper_cipher_set_iv( operation,
3521 iv,
3522 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003523
itayzafrir534bd7c2018-08-02 13:56:32 +03003524 if( status == PSA_SUCCESS )
3525 operation->iv_set = 1;
3526 else
mohammad1603503973b2018-03-12 15:59:30 +02003527 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003528 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003529}
3530
Gilles Peskinee553c652018-06-04 16:22:46 +02003531psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3532 const uint8_t *input,
3533 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003534 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003535 size_t output_size,
3536 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003537{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003539
Steven Cooreman7df02922020-09-09 15:28:49 +02003540 if( operation->alg == 0 )
3541 {
3542 return( PSA_ERROR_BAD_STATE );
3543 }
3544 if( operation->iv_required && ! operation->iv_set )
3545 {
3546 return( PSA_ERROR_BAD_STATE );
3547 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003548
Ronald Crondd24c9b2020-12-15 14:10:01 +01003549 status = psa_driver_wrapper_cipher_update( operation,
3550 input,
3551 input_length,
3552 output,
3553 output_size,
3554 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003555 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003556 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003557
itayzafrir534bd7c2018-08-02 13:56:32 +03003558 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003559}
3560
Gilles Peskinee553c652018-06-04 16:22:46 +02003561psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3562 uint8_t *output,
3563 size_t output_size,
3564 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003565{
David Saadab4ecc272019-02-14 13:48:10 +02003566 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003567
Steven Cooreman7df02922020-09-09 15:28:49 +02003568 if( operation->alg == 0 )
3569 {
3570 return( PSA_ERROR_BAD_STATE );
3571 }
3572 if( operation->iv_required && ! operation->iv_set )
3573 {
3574 return( PSA_ERROR_BAD_STATE );
3575 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003576
Ronald Crondd24c9b2020-12-15 14:10:01 +01003577 status = psa_driver_wrapper_cipher_finish( operation,
3578 output,
3579 output_size,
3580 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003581 if( status == PSA_SUCCESS )
3582 return( psa_cipher_abort( operation ) );
3583 else
3584 {
3585 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003586 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003587
Steven Cooremanef8575e2020-09-11 11:44:50 +02003588 return( status );
3589 }
mohammad1603503973b2018-03-12 15:59:30 +02003590}
3591
Gilles Peskinee553c652018-06-04 16:22:46 +02003592psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3593{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003594 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003595 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003596 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003597 * in use. It's ok to call abort on such an object, and there's
3598 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003599 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003600 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003601
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003602 /* Sanity check (shouldn't happen: operation->alg should
3603 * always have been initialized to a valid value). */
3604 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3605 return( PSA_ERROR_BAD_STATE );
3606
Ronald Crondd24c9b2020-12-15 14:10:01 +01003607 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003608
Moran Peker41deec42018-04-04 15:43:05 +03003609 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003610 operation->key_set = 0;
3611 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003612 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003613 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003614 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003615 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003616
Moran Peker395db872018-05-31 14:07:14 +03003617 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003618}
3619
mohammad16035955c982018-04-26 00:53:03 +03003620/****************************************************************/
3621/* AEAD */
3622/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003623
Gilles Peskineedf9a652018-08-17 18:11:56 +02003624typedef struct
3625{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003626 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003627 const mbedtls_cipher_info_t *cipher_info;
3628 union
3629 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003630 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Ronald Cron3d471812021-03-18 13:40:31 +01003631#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003632 mbedtls_ccm_context ccm;
Ronald Cron3d471812021-03-18 13:40:31 +01003633#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3634#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003635 mbedtls_gcm_context gcm;
Ronald Cron3d471812021-03-18 13:40:31 +01003636#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3637#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Gilles Peskine26869f22019-05-06 15:25:00 +02003638 mbedtls_chachapoly_context chachapoly;
Ronald Cron3d471812021-03-18 13:40:31 +01003639#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003640 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003641 psa_algorithm_t core_alg;
3642 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003643 uint8_t tag_length;
3644} aead_operation_t;
3645
Ronald Cronf95a2b12020-10-22 15:24:49 +02003646#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
3647
Gilles Peskine30a9e412019-01-14 18:36:12 +01003648static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003649{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003650 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003651 {
Ronald Cron3d471812021-03-18 13:40:31 +01003652#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003653 case PSA_ALG_CCM:
3654 mbedtls_ccm_free( &operation->ctx.ccm );
3655 break;
Ronald Cron3d471812021-03-18 13:40:31 +01003656#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3657#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003658 case PSA_ALG_GCM:
3659 mbedtls_gcm_free( &operation->ctx.gcm );
3660 break;
Ronald Cron3d471812021-03-18 13:40:31 +01003661#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003662 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003663
Ronald Cron5c522922020-11-14 16:35:34 +01003664 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003665}
3666
3667static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003668 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003669 psa_key_usage_t usage,
3670 psa_algorithm_t alg )
3671{
3672 psa_status_t status;
3673 size_t key_bits;
3674 mbedtls_cipher_id_t cipher_id;
3675
Ronald Cron5c522922020-11-14 16:35:34 +01003676 status = psa_get_and_lock_transparent_key_slot_with_policy(
3677 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003678 if( status != PSA_SUCCESS )
3679 return( status );
3680
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003681 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003682
3683 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003684 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003685 &cipher_id );
3686 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003687 {
3688 status = PSA_ERROR_NOT_SUPPORTED;
3689 goto cleanup;
3690 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003691
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003692 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003693 {
Ronald Cron3d471812021-03-18 13:40:31 +01003694#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003695 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003696 operation->core_alg = PSA_ALG_CCM;
3697 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003698 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3699 * The call to mbedtls_ccm_encrypt_and_tag or
3700 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003701 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003702 {
3703 status = PSA_ERROR_INVALID_ARGUMENT;
3704 goto cleanup;
3705 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003706 mbedtls_ccm_init( &operation->ctx.ccm );
3707 status = mbedtls_to_psa_error(
3708 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003709 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003710 (unsigned int) key_bits ) );
3711 if( status != 0 )
3712 goto cleanup;
3713 break;
Ronald Cron3d471812021-03-18 13:40:31 +01003714#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003715
Ronald Cron3d471812021-03-18 13:40:31 +01003716#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003717 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003718 operation->core_alg = PSA_ALG_GCM;
3719 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003720 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3721 * The call to mbedtls_gcm_crypt_and_tag or
3722 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003723 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003724 {
3725 status = PSA_ERROR_INVALID_ARGUMENT;
3726 goto cleanup;
3727 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003728 mbedtls_gcm_init( &operation->ctx.gcm );
3729 status = mbedtls_to_psa_error(
3730 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003731 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003732 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003733 if( status != 0 )
3734 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003735 break;
Ronald Cron3d471812021-03-18 13:40:31 +01003736#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003737
Ronald Cron3d471812021-03-18 13:40:31 +01003738#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003739 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02003740 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3741 operation->full_tag_length = 16;
3742 /* We only support the default tag length. */
3743 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003744 {
3745 status = PSA_ERROR_NOT_SUPPORTED;
3746 goto cleanup;
3747 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003748 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
3749 status = mbedtls_to_psa_error(
3750 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003751 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02003752 if( status != 0 )
3753 goto cleanup;
3754 break;
Ronald Cron3d471812021-03-18 13:40:31 +01003755#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
Gilles Peskine26869f22019-05-06 15:25:00 +02003756
Gilles Peskineedf9a652018-08-17 18:11:56 +02003757 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02003758 status = PSA_ERROR_NOT_SUPPORTED;
3759 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003760 }
3761
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003762 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
3763 {
3764 status = PSA_ERROR_INVALID_ARGUMENT;
3765 goto cleanup;
3766 }
3767 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003768
Gilles Peskineedf9a652018-08-17 18:11:56 +02003769 return( PSA_SUCCESS );
3770
3771cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01003772 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003773 return( status );
3774}
3775
Ronald Croncf56a0a2020-08-04 09:51:30 +02003776psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003777 psa_algorithm_t alg,
3778 const uint8_t *nonce,
3779 size_t nonce_length,
3780 const uint8_t *additional_data,
3781 size_t additional_data_length,
3782 const uint8_t *plaintext,
3783 size_t plaintext_length,
3784 uint8_t *ciphertext,
3785 size_t ciphertext_size,
3786 size_t *ciphertext_length )
3787{
mohammad16035955c982018-04-26 00:53:03 +03003788 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02003789 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03003790 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02003791
mohammad1603f08a5502018-06-03 15:05:47 +03003792 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003793
Ronald Croncf56a0a2020-08-04 09:51:30 +02003794 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003795 if( status != PSA_SUCCESS )
3796 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003797
Gilles Peskineedf9a652018-08-17 18:11:56 +02003798 /* For all currently supported modes, the tag is at the end of the
3799 * ciphertext. */
3800 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
3801 {
3802 status = PSA_ERROR_BUFFER_TOO_SMALL;
3803 goto exit;
3804 }
3805 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03003806
Ronald Cron3d471812021-03-18 13:40:31 +01003807#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003808 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03003809 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003810 status = mbedtls_to_psa_error(
3811 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
3812 MBEDTLS_GCM_ENCRYPT,
3813 plaintext_length,
3814 nonce, nonce_length,
3815 additional_data, additional_data_length,
3816 plaintext, ciphertext,
3817 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03003818 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003819 else
Ronald Cron3d471812021-03-18 13:40:31 +01003820#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3821#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003822 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03003823 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003824 status = mbedtls_to_psa_error(
3825 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
3826 plaintext_length,
3827 nonce, nonce_length,
3828 additional_data,
3829 additional_data_length,
3830 plaintext, ciphertext,
3831 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03003832 }
mohammad16035c8845f2018-05-09 05:40:09 -07003833 else
Ronald Cron3d471812021-03-18 13:40:31 +01003834#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3835#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Gilles Peskine26869f22019-05-06 15:25:00 +02003836 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
3837 {
3838 if( nonce_length != 12 || operation.tag_length != 16 )
3839 {
3840 status = PSA_ERROR_NOT_SUPPORTED;
3841 goto exit;
3842 }
3843 status = mbedtls_to_psa_error(
3844 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
3845 plaintext_length,
3846 nonce,
3847 additional_data,
3848 additional_data_length,
3849 plaintext,
3850 ciphertext,
3851 tag ) );
3852 }
3853 else
Ronald Cron3d471812021-03-18 13:40:31 +01003854#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
mohammad16035c8845f2018-05-09 05:40:09 -07003855 {
Steven Cooreman7196fef2021-02-10 17:13:28 +01003856 (void) tag;
mohammad1603554faad2018-06-03 15:07:38 +03003857 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07003858 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003859
Gilles Peskineedf9a652018-08-17 18:11:56 +02003860 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3861 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003862
Gilles Peskineedf9a652018-08-17 18:11:56 +02003863exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01003864 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003865 if( status == PSA_SUCCESS )
3866 *ciphertext_length = plaintext_length + operation.tag_length;
3867 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003868}
3869
Gilles Peskineee652a32018-06-01 19:23:52 +02003870/* Locate the tag in a ciphertext buffer containing the encrypted data
3871 * followed by the tag. Return the length of the part preceding the tag in
3872 * *plaintext_length. This is the size of the plaintext in modes where
3873 * the encrypted data has the same size as the plaintext, such as
3874 * CCM and GCM. */
3875static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
3876 const uint8_t *ciphertext,
3877 size_t ciphertext_length,
3878 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02003879 const uint8_t **p_tag )
3880{
3881 size_t payload_length;
3882 if( tag_length > ciphertext_length )
3883 return( PSA_ERROR_INVALID_ARGUMENT );
3884 payload_length = ciphertext_length - tag_length;
3885 if( payload_length > plaintext_size )
3886 return( PSA_ERROR_BUFFER_TOO_SMALL );
3887 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02003888 return( PSA_SUCCESS );
3889}
3890
Ronald Croncf56a0a2020-08-04 09:51:30 +02003891psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003892 psa_algorithm_t alg,
3893 const uint8_t *nonce,
3894 size_t nonce_length,
3895 const uint8_t *additional_data,
3896 size_t additional_data_length,
3897 const uint8_t *ciphertext,
3898 size_t ciphertext_length,
3899 uint8_t *plaintext,
3900 size_t plaintext_size,
3901 size_t *plaintext_length )
3902{
mohammad16035955c982018-04-26 00:53:03 +03003903 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02003904 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003905 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02003906
Gilles Peskineee652a32018-06-01 19:23:52 +02003907 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003908
Ronald Croncf56a0a2020-08-04 09:51:30 +02003909 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003910 if( status != PSA_SUCCESS )
3911 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003912
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003913 status = psa_aead_unpadded_locate_tag( operation.tag_length,
3914 ciphertext, ciphertext_length,
3915 plaintext_size, &tag );
3916 if( status != PSA_SUCCESS )
3917 goto exit;
3918
Ronald Cron3d471812021-03-18 13:40:31 +01003919#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003920 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03003921 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003922 status = mbedtls_to_psa_error(
3923 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
3924 ciphertext_length - operation.tag_length,
3925 nonce, nonce_length,
3926 additional_data,
3927 additional_data_length,
3928 tag, operation.tag_length,
3929 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03003930 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003931 else
Ronald Cron3d471812021-03-18 13:40:31 +01003932#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3933#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003934 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03003935 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02003936 status = mbedtls_to_psa_error(
3937 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
3938 ciphertext_length - operation.tag_length,
3939 nonce, nonce_length,
3940 additional_data,
3941 additional_data_length,
3942 ciphertext, plaintext,
3943 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03003944 }
mohammad160339574652018-06-01 04:39:53 -07003945 else
Ronald Cron3d471812021-03-18 13:40:31 +01003946#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3947#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
Gilles Peskine26869f22019-05-06 15:25:00 +02003948 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
3949 {
3950 if( nonce_length != 12 || operation.tag_length != 16 )
3951 {
3952 status = PSA_ERROR_NOT_SUPPORTED;
3953 goto exit;
3954 }
3955 status = mbedtls_to_psa_error(
3956 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
3957 ciphertext_length - operation.tag_length,
3958 nonce,
3959 additional_data,
3960 additional_data_length,
3961 tag,
3962 ciphertext,
3963 plaintext ) );
3964 }
3965 else
Ronald Cron3d471812021-03-18 13:40:31 +01003966#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
mohammad160339574652018-06-01 04:39:53 -07003967 {
mohammad1603554faad2018-06-03 15:07:38 +03003968 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07003969 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02003970
Gilles Peskineedf9a652018-08-17 18:11:56 +02003971 if( status != PSA_SUCCESS && plaintext_size != 0 )
3972 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003973
Gilles Peskineedf9a652018-08-17 18:11:56 +02003974exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01003975 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003976 if( status == PSA_SUCCESS )
3977 *plaintext_length = ciphertext_length - operation.tag_length;
3978 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003979}
3980
Gilles Peskinea0655c32018-04-30 17:06:50 +02003981
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003982
Gilles Peskinee59236f2018-01-27 23:32:46 +01003983/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003984/* Generators */
3985/****************************************************************/
3986
John Durkop07cc04a2020-11-16 22:08:34 -08003987#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3988 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3989 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3990#define AT_LEAST_ONE_BUILTIN_KDF
3991#endif
3992
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003993#define HKDF_STATE_INIT 0 /* no input yet */
3994#define HKDF_STATE_STARTED 1 /* got salt */
3995#define HKDF_STATE_KEYED 2 /* got key */
3996#define HKDF_STATE_OUTPUT 3 /* output started */
3997
Gilles Peskinecbe66502019-05-16 16:59:18 +02003998static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003999 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004000{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004001 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4002 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004003 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004004 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004005}
4006
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004007psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004008{
4009 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004010 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004011 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004012 {
4013 /* The object has (apparently) been initialized but it is not
4014 * in use. It's ok to call abort on such an object, and there's
4015 * nothing to do. */
4016 }
4017 else
John Durkopd0321952020-10-29 21:37:36 -07004018#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004019 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004020 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004021 mbedtls_free( operation->ctx.hkdf.info );
4022 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004023 }
John Durkop07cc04a2020-11-16 22:08:34 -08004024 else
4025#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4026#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4027 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4028 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004029 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004030 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004031 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004032 if( operation->ctx.tls12_prf.seed != NULL )
4033 {
4034 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4035 operation->ctx.tls12_prf.seed_length );
4036 mbedtls_free( operation->ctx.tls12_prf.seed );
4037 }
4038
4039 if( operation->ctx.tls12_prf.label != NULL )
4040 {
4041 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4042 operation->ctx.tls12_prf.label_length );
4043 mbedtls_free( operation->ctx.tls12_prf.label );
4044 }
4045
4046 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4047
4048 /* We leave the fields Ai and output_block to be erased safely by the
4049 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004050 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004051 else
John Durkop07cc04a2020-11-16 22:08:34 -08004052#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4053 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004054 {
4055 status = PSA_ERROR_BAD_STATE;
4056 }
Janos Follath083036a2019-06-11 10:22:26 +01004057 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004058 return( status );
4059}
4060
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004061psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004062 size_t *capacity)
4063{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004064 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004065 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004066 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004067 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004068 }
4069
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004070 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004071 return( PSA_SUCCESS );
4072}
4073
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004074psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004075 size_t capacity )
4076{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004077 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004078 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004079 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004080 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004081 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004082 return( PSA_SUCCESS );
4083}
4084
John Durkopd0321952020-10-29 21:37:36 -07004085#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004086/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004087 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004088static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004089 psa_algorithm_t hash_alg,
4090 uint8_t *output,
4091 size_t output_length )
4092{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004093 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004094 psa_status_t status;
4095
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004096 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4097 return( PSA_ERROR_BAD_STATE );
4098 hkdf->state = HKDF_STATE_OUTPUT;
4099
Gilles Peskinebef7f142018-07-12 17:22:21 +02004100 while( output_length != 0 )
4101 {
4102 /* Copy what remains of the current block */
4103 uint8_t n = hash_length - hkdf->offset_in_block;
4104 if( n > output_length )
4105 n = (uint8_t) output_length;
4106 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4107 output += n;
4108 output_length -= n;
4109 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004110 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004111 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004112 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004113 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004114 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004115 * object was corrupted or if this function is called directly
4116 * inside the library. */
4117 if( hkdf->block_number == 0xff )
4118 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004119
4120 /* We need a new block */
4121 ++hkdf->block_number;
4122 hkdf->offset_in_block = 0;
4123 status = psa_hmac_setup_internal( &hkdf->hmac,
4124 hkdf->prk, hash_length,
4125 hash_alg );
4126 if( status != PSA_SUCCESS )
4127 return( status );
4128 if( hkdf->block_number != 1 )
4129 {
4130 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4131 hkdf->output_block,
4132 hash_length );
4133 if( status != PSA_SUCCESS )
4134 return( status );
4135 }
4136 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4137 hkdf->info,
4138 hkdf->info_length );
4139 if( status != PSA_SUCCESS )
4140 return( status );
4141 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4142 &hkdf->block_number, 1 );
4143 if( status != PSA_SUCCESS )
4144 return( status );
4145 status = psa_hmac_finish_internal( &hkdf->hmac,
4146 hkdf->output_block,
4147 sizeof( hkdf->output_block ) );
4148 if( status != PSA_SUCCESS )
4149 return( status );
4150 }
4151
4152 return( PSA_SUCCESS );
4153}
John Durkop07cc04a2020-11-16 22:08:34 -08004154#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004155
John Durkop07cc04a2020-11-16 22:08:34 -08004156#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4157 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004158static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4159 psa_tls12_prf_key_derivation_t *tls12_prf,
4160 psa_algorithm_t alg )
4161{
4162 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004163 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004164 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4165 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004166
Janos Follath7742fee2019-06-17 12:58:10 +01004167 /* We can't be wanting more output after block 0xff, otherwise
4168 * the capacity check in psa_key_derivation_output_bytes() would have
4169 * prevented this call. It could happen only if the operation
4170 * object was corrupted or if this function is called directly
4171 * inside the library. */
4172 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004173 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004174
4175 /* We need a new block */
4176 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004177 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004178
4179 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4180 *
4181 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4182 *
4183 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4184 * HMAC_hash(secret, A(2) + seed) +
4185 * HMAC_hash(secret, A(3) + seed) + ...
4186 *
4187 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004188 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004189 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004190 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004191 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004192 * is currently extracted as `output_block` and where i is
4193 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004194 */
4195
Janos Follathea29bfb2019-06-19 12:21:20 +01004196 /* Save the hash context before using it, to preserve the hash state with
4197 * only the inner padding in it. We need this, because inner padding depends
4198 * on the key (secret in the RFC's terminology). */
4199 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4200 if( status != PSA_SUCCESS )
4201 goto cleanup;
4202
4203 /* Calculate A(i) where i = tls12_prf->block_number. */
4204 if( tls12_prf->block_number == 1 )
4205 {
4206 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4207 * the variable seed and in this instance means it in the context of the
4208 * P_hash function, where seed = label + seed.) */
4209 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4210 tls12_prf->label, tls12_prf->label_length );
4211 if( status != PSA_SUCCESS )
4212 goto cleanup;
4213 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4214 tls12_prf->seed, tls12_prf->seed_length );
4215 if( status != PSA_SUCCESS )
4216 goto cleanup;
4217 }
4218 else
4219 {
4220 /* A(i) = HMAC_hash(secret, A(i-1)) */
4221 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4222 tls12_prf->Ai, hash_length );
4223 if( status != PSA_SUCCESS )
4224 goto cleanup;
4225 }
4226
4227 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4228 tls12_prf->Ai, hash_length );
4229 if( status != PSA_SUCCESS )
4230 goto cleanup;
4231 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4232 if( status != PSA_SUCCESS )
4233 goto cleanup;
4234
4235 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4236 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4237 tls12_prf->Ai, hash_length );
4238 if( status != PSA_SUCCESS )
4239 goto cleanup;
4240 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4241 tls12_prf->label, tls12_prf->label_length );
4242 if( status != PSA_SUCCESS )
4243 goto cleanup;
4244 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4245 tls12_prf->seed, tls12_prf->seed_length );
4246 if( status != PSA_SUCCESS )
4247 goto cleanup;
4248 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4249 tls12_prf->output_block, hash_length );
4250 if( status != PSA_SUCCESS )
4251 goto cleanup;
4252 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4253 if( status != PSA_SUCCESS )
4254 goto cleanup;
4255
Janos Follath7742fee2019-06-17 12:58:10 +01004256
4257cleanup:
4258
Janos Follathea29bfb2019-06-19 12:21:20 +01004259 cleanup_status = psa_hash_abort( &backup );
4260 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4261 status = cleanup_status;
4262
4263 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004264}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004265
Janos Follath844eb0e2019-06-19 12:10:49 +01004266static psa_status_t psa_key_derivation_tls12_prf_read(
4267 psa_tls12_prf_key_derivation_t *tls12_prf,
4268 psa_algorithm_t alg,
4269 uint8_t *output,
4270 size_t output_length )
4271{
4272 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004273 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004274 psa_status_t status;
4275 uint8_t offset, length;
4276
4277 while( output_length != 0 )
4278 {
4279 /* Check if we have fully processed the current block. */
4280 if( tls12_prf->left_in_block == 0 )
4281 {
4282 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4283 alg );
4284 if( status != PSA_SUCCESS )
4285 return( status );
4286
4287 continue;
4288 }
4289
4290 if( tls12_prf->left_in_block > output_length )
4291 length = (uint8_t) output_length;
4292 else
4293 length = tls12_prf->left_in_block;
4294
4295 offset = hash_length - tls12_prf->left_in_block;
4296 memcpy( output, tls12_prf->output_block + offset, length );
4297 output += length;
4298 output_length -= length;
4299 tls12_prf->left_in_block -= length;
4300 }
4301
4302 return( PSA_SUCCESS );
4303}
John Durkop07cc04a2020-11-16 22:08:34 -08004304#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4305 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004306
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004307psa_status_t psa_key_derivation_output_bytes(
4308 psa_key_derivation_operation_t *operation,
4309 uint8_t *output,
4310 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004311{
4312 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004313 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004314
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004315 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004316 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004317 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004318 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004319 }
4320
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004321 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004322 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004323 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004324 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004325 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004326 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004327 goto exit;
4328 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004329 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004330 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004331 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004332 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004333 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4334 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004335 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004336 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004337 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004338 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004339 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004340
John Durkopd0321952020-10-29 21:37:36 -07004341#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004342 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004343 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004344 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004345 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004346 output, output_length );
4347 }
Janos Follathadbec812019-06-14 11:05:39 +01004348 else
John Durkop07cc04a2020-11-16 22:08:34 -08004349#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4350#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4351 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004352 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004353 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004354 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004355 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004356 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004357 output_length );
4358 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004359 else
John Durkop07cc04a2020-11-16 22:08:34 -08004360#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4361 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004362 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004363 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004364 return( PSA_ERROR_BAD_STATE );
4365 }
4366
4367exit:
4368 if( status != PSA_SUCCESS )
4369 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004370 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004371 * This allows us to differentiate between exhausted operations and
4372 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4373 * operations. */
4374 psa_algorithm_t alg = operation->alg;
4375 psa_key_derivation_abort( operation );
4376 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004377 memset( output, '!', output_length );
4378 }
4379 return( status );
4380}
4381
David Brown7807bf72021-02-09 16:28:23 -07004382#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004383static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4384{
4385 if( data_size >= 8 )
4386 mbedtls_des_key_set_parity( data );
4387 if( data_size >= 16 )
4388 mbedtls_des_key_set_parity( data + 8 );
4389 if( data_size >= 24 )
4390 mbedtls_des_key_set_parity( data + 16 );
4391}
David Brown7807bf72021-02-09 16:28:23 -07004392#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004393
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004394static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004395 psa_key_slot_t *slot,
4396 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004397 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004398{
4399 uint8_t *data = NULL;
4400 size_t bytes = PSA_BITS_TO_BYTES( bits );
4401 psa_status_t status;
4402
Gilles Peskine8e338702019-07-30 20:06:31 +02004403 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004404 return( PSA_ERROR_INVALID_ARGUMENT );
4405 if( bits % 8 != 0 )
4406 return( PSA_ERROR_INVALID_ARGUMENT );
4407 data = mbedtls_calloc( 1, bytes );
4408 if( data == NULL )
4409 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4410
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004411 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004412 if( status != PSA_SUCCESS )
4413 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004414#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004415 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004416 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004417#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004418
4419 status = psa_allocate_buffer_to_slot( slot, bytes );
4420 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004421 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004422
Ronald Cronbf33c932020-11-28 18:06:53 +01004423 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004424 psa_key_attributes_t attributes = {
4425 .core = slot->attr
4426 };
4427
Ronald Cronbf33c932020-11-28 18:06:53 +01004428 status = psa_driver_wrapper_import_key( &attributes,
4429 data, bytes,
4430 slot->key.data,
4431 slot->key.bytes,
4432 &slot->key.bytes, &bits );
4433 if( bits != slot->attr.bits )
4434 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004435
4436exit:
4437 mbedtls_free( data );
4438 return( status );
4439}
4440
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004441psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004442 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004443 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004444{
4445 psa_status_t status;
4446 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004447 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004448
Ronald Cron81709fc2020-11-14 12:10:32 +01004449 *key = MBEDTLS_SVC_KEY_ID_INIT;
4450
Gilles Peskine0f84d622019-09-12 19:03:13 +02004451 /* Reject any attempt to create a zero-length key so that we don't
4452 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4453 if( psa_get_key_bits( attributes ) == 0 )
4454 return( PSA_ERROR_INVALID_ARGUMENT );
4455
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004456 if( ! operation->can_output_key )
4457 return( PSA_ERROR_NOT_PERMITTED );
4458
Ronald Cron81709fc2020-11-14 12:10:32 +01004459 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4460 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004461#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4462 if( driver != NULL )
4463 {
4464 /* Deriving a key in a secure element is not implemented yet. */
4465 status = PSA_ERROR_NOT_SUPPORTED;
4466 }
4467#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004468 if( status == PSA_SUCCESS )
4469 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004470 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004471 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004472 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004473 }
4474 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004475 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004476 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004477 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004478
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004479 return( status );
4480}
4481
Gilles Peskineeab56e42018-07-12 17:12:33 +02004482
4483
4484/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004485/* Key derivation */
4486/****************************************************************/
4487
Steven Cooreman932ffb72021-02-15 12:14:32 +01004488#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004489static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004490 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004491 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004492{
John Durkop07cc04a2020-11-16 22:08:34 -08004493 int is_kdf_alg_supported;
4494
Janos Follath5fe19732019-06-20 15:09:30 +01004495 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4496 * initialisers for this union leave some bytes unspecified.) */
4497 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4498
Gilles Peskine969c5d62019-01-16 15:53:06 +01004499 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004500#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004501 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4502 is_kdf_alg_supported = 1;
4503 else
4504#endif
4505#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4506 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4507 is_kdf_alg_supported = 1;
4508 else
4509#endif
4510#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4511 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4512 is_kdf_alg_supported = 1;
4513 else
4514#endif
4515 is_kdf_alg_supported = 0;
4516
4517 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004518 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004519 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004520 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004521 if( hash_size == 0 )
4522 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004523 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4524 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004525 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004526 {
4527 return( PSA_ERROR_NOT_SUPPORTED );
4528 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004529 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004530 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004531 }
John Durkop07cc04a2020-11-16 22:08:34 -08004532
4533 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004534}
John Durkop07cc04a2020-11-16 22:08:34 -08004535#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004536
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004537psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004538 psa_algorithm_t alg )
4539{
4540 psa_status_t status;
4541
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004542 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004543 return( PSA_ERROR_BAD_STATE );
4544
Gilles Peskine6843c292019-01-18 16:44:49 +01004545 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4546 return( PSA_ERROR_INVALID_ARGUMENT );
4547 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004548 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004549#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004550 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004551 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004552#else
4553 return( PSA_ERROR_NOT_SUPPORTED );
4554#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004555 }
4556 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4557 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004558#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004559 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004560#else
4561 return( PSA_ERROR_NOT_SUPPORTED );
4562#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004563 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004564 else
4565 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004566
4567 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004568 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004569 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004570}
4571
John Durkopd0321952020-10-29 21:37:36 -07004572#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004573static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004574 psa_algorithm_t hash_alg,
4575 psa_key_derivation_step_t step,
4576 const uint8_t *data,
4577 size_t data_length )
4578{
4579 psa_status_t status;
4580 switch( step )
4581 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004582 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004583 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004584 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004585 status = psa_hmac_setup_internal( &hkdf->hmac,
4586 data, data_length,
4587 hash_alg );
4588 if( status != PSA_SUCCESS )
4589 return( status );
4590 hkdf->state = HKDF_STATE_STARTED;
4591 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004592 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004593 /* If no salt was provided, use an empty salt. */
4594 if( hkdf->state == HKDF_STATE_INIT )
4595 {
4596 status = psa_hmac_setup_internal( &hkdf->hmac,
4597 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004598 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004599 if( status != PSA_SUCCESS )
4600 return( status );
4601 hkdf->state = HKDF_STATE_STARTED;
4602 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004603 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004604 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004605 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4606 data, data_length );
4607 if( status != PSA_SUCCESS )
4608 return( status );
4609 status = psa_hmac_finish_internal( &hkdf->hmac,
4610 hkdf->prk,
4611 sizeof( hkdf->prk ) );
4612 if( status != PSA_SUCCESS )
4613 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004614 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004615 hkdf->block_number = 0;
4616 hkdf->state = HKDF_STATE_KEYED;
4617 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004618 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004619 if( hkdf->state == HKDF_STATE_OUTPUT )
4620 return( PSA_ERROR_BAD_STATE );
4621 if( hkdf->info_set )
4622 return( PSA_ERROR_BAD_STATE );
4623 hkdf->info_length = data_length;
4624 if( data_length != 0 )
4625 {
4626 hkdf->info = mbedtls_calloc( 1, data_length );
4627 if( hkdf->info == NULL )
4628 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4629 memcpy( hkdf->info, data, data_length );
4630 }
4631 hkdf->info_set = 1;
4632 return( PSA_SUCCESS );
4633 default:
4634 return( PSA_ERROR_INVALID_ARGUMENT );
4635 }
4636}
John Durkop07cc04a2020-11-16 22:08:34 -08004637#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004638
John Durkop07cc04a2020-11-16 22:08:34 -08004639#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4640 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004641static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4642 const uint8_t *data,
4643 size_t data_length )
4644{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004645 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004646 return( PSA_ERROR_BAD_STATE );
4647
Janos Follathd6dce9f2019-07-04 09:11:38 +01004648 if( data_length != 0 )
4649 {
4650 prf->seed = mbedtls_calloc( 1, data_length );
4651 if( prf->seed == NULL )
4652 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004653
Janos Follathd6dce9f2019-07-04 09:11:38 +01004654 memcpy( prf->seed, data, data_length );
4655 prf->seed_length = data_length;
4656 }
Janos Follathf08e2652019-06-13 09:05:41 +01004657
Gilles Peskine43f958b2020-12-13 14:55:14 +01004658 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004659
4660 return( PSA_SUCCESS );
4661}
4662
Janos Follath81550542019-06-13 14:26:34 +01004663static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4664 psa_algorithm_t hash_alg,
4665 const uint8_t *data,
4666 size_t data_length )
4667{
4668 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004669 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004670 return( PSA_ERROR_BAD_STATE );
4671
4672 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4673 if( status != PSA_SUCCESS )
4674 return( status );
4675
Gilles Peskine43f958b2020-12-13 14:55:14 +01004676 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004677
4678 return( PSA_SUCCESS );
4679}
4680
Janos Follath63028dd2019-06-13 09:15:47 +01004681static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4682 const uint8_t *data,
4683 size_t data_length )
4684{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004685 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004686 return( PSA_ERROR_BAD_STATE );
4687
Janos Follathd6dce9f2019-07-04 09:11:38 +01004688 if( data_length != 0 )
4689 {
4690 prf->label = mbedtls_calloc( 1, data_length );
4691 if( prf->label == NULL )
4692 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004693
Janos Follathd6dce9f2019-07-04 09:11:38 +01004694 memcpy( prf->label, data, data_length );
4695 prf->label_length = data_length;
4696 }
Janos Follath63028dd2019-06-13 09:15:47 +01004697
Gilles Peskine43f958b2020-12-13 14:55:14 +01004698 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004699
4700 return( PSA_SUCCESS );
4701}
4702
Janos Follathb03233e2019-06-11 15:30:30 +01004703static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4704 psa_algorithm_t hash_alg,
4705 psa_key_derivation_step_t step,
4706 const uint8_t *data,
4707 size_t data_length )
4708{
Janos Follathb03233e2019-06-11 15:30:30 +01004709 switch( step )
4710 {
Janos Follathf08e2652019-06-13 09:05:41 +01004711 case PSA_KEY_DERIVATION_INPUT_SEED:
4712 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004713 case PSA_KEY_DERIVATION_INPUT_SECRET:
4714 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004715 case PSA_KEY_DERIVATION_INPUT_LABEL:
4716 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004717 default:
4718 return( PSA_ERROR_INVALID_ARGUMENT );
4719 }
4720}
John Durkop07cc04a2020-11-16 22:08:34 -08004721#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4722 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4723
4724#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4725static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4726 psa_tls12_prf_key_derivation_t *prf,
4727 psa_algorithm_t hash_alg,
4728 const uint8_t *data,
4729 size_t data_length )
4730{
4731 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004732 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004733 uint8_t *cur = pms;
4734
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004735 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004736 return( PSA_ERROR_INVALID_ARGUMENT );
4737
4738 /* Quoting RFC 4279, Section 2:
4739 *
4740 * The premaster secret is formed as follows: if the PSK is N octets
4741 * long, concatenate a uint16 with the value N, N zero octets, a second
4742 * uint16 with the value N, and the PSK itself.
4743 */
4744
4745 *cur++ = ( data_length >> 8 ) & 0xff;
4746 *cur++ = ( data_length >> 0 ) & 0xff;
4747 memset( cur, 0, data_length );
4748 cur += data_length;
4749 *cur++ = pms[0];
4750 *cur++ = pms[1];
4751 memcpy( cur, data, data_length );
4752 cur += data_length;
4753
4754 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
4755
4756 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4757 return( status );
4758}
Janos Follath6660f0e2019-06-17 08:44:03 +01004759
4760static psa_status_t psa_tls12_prf_psk_to_ms_input(
4761 psa_tls12_prf_key_derivation_t *prf,
4762 psa_algorithm_t hash_alg,
4763 psa_key_derivation_step_t step,
4764 const uint8_t *data,
4765 size_t data_length )
4766{
4767 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004768 {
Janos Follath6660f0e2019-06-17 08:44:03 +01004769 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
4770 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004771 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004772
4773 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
4774}
John Durkop07cc04a2020-11-16 22:08:34 -08004775#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004776
Gilles Peskineb8965192019-09-24 16:21:10 +02004777/** Check whether the given key type is acceptable for the given
4778 * input step of a key derivation.
4779 *
4780 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4781 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4782 * Both secret and non-secret inputs can alternatively have the type
4783 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4784 * that the input was passed as a buffer rather than via a key object.
4785 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004786static int psa_key_derivation_check_input_type(
4787 psa_key_derivation_step_t step,
4788 psa_key_type_t key_type )
4789{
4790 switch( step )
4791 {
4792 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004793 if( key_type == PSA_KEY_TYPE_DERIVE )
4794 return( PSA_SUCCESS );
4795 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004796 return( PSA_SUCCESS );
4797 break;
4798 case PSA_KEY_DERIVATION_INPUT_LABEL:
4799 case PSA_KEY_DERIVATION_INPUT_SALT:
4800 case PSA_KEY_DERIVATION_INPUT_INFO:
4801 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004802 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4803 return( PSA_SUCCESS );
4804 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004805 return( PSA_SUCCESS );
4806 break;
4807 }
4808 return( PSA_ERROR_INVALID_ARGUMENT );
4809}
4810
Janos Follathb80a94e2019-06-12 15:54:46 +01004811static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004812 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004813 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004814 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004815 const uint8_t *data,
4816 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004817{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004818 psa_status_t status;
4819 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4820
4821 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004822 if( status != PSA_SUCCESS )
4823 goto exit;
4824
John Durkopd0321952020-10-29 21:37:36 -07004825#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004826 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004827 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004828 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004829 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004830 step, data, data_length );
4831 }
John Durkop07cc04a2020-11-16 22:08:34 -08004832 else
4833#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4834#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4835 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004836 {
Janos Follathb03233e2019-06-11 15:30:30 +01004837 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
4838 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4839 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004840 }
John Durkop07cc04a2020-11-16 22:08:34 -08004841 else
4842#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4843#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4844 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004845 {
4846 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
4847 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4848 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004849 }
4850 else
John Durkop07cc04a2020-11-16 22:08:34 -08004851#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004852 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004854 (void) data;
4855 (void) data_length;
4856 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004857 return( PSA_ERROR_BAD_STATE );
4858 }
4859
Gilles Peskine224b0d62019-09-23 18:13:17 +02004860exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004861 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004862 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004863 return( status );
4864}
4865
Janos Follath51f4a0f2019-06-14 11:35:55 +01004866psa_status_t psa_key_derivation_input_bytes(
4867 psa_key_derivation_operation_t *operation,
4868 psa_key_derivation_step_t step,
4869 const uint8_t *data,
4870 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004871{
Gilles Peskineb8965192019-09-24 16:21:10 +02004872 return( psa_key_derivation_input_internal( operation, step,
4873 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004874 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004875}
4876
Janos Follath51f4a0f2019-06-14 11:35:55 +01004877psa_status_t psa_key_derivation_input_key(
4878 psa_key_derivation_operation_t *operation,
4879 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004880 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004881{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004883 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004884 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004885
Ronald Cron5c522922020-11-14 16:35:34 +01004886 status = psa_get_and_lock_transparent_key_slot_with_policy(
4887 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004888 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004889 {
4890 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004891 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004892 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004893
4894 /* Passing a key object as a SECRET input unlocks the permission
4895 * to output to a key object. */
4896 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4897 operation->can_output_key = 1;
4898
Ronald Cronf95a2b12020-10-22 15:24:49 +02004899 status = psa_key_derivation_input_internal( operation,
4900 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004901 slot->key.data,
4902 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004903
Ronald Cron5c522922020-11-14 16:35:34 +01004904 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004905
Ronald Cron5c522922020-11-14 16:35:34 +01004906 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004907}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004908
4909
4910
4911/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004912/* Key agreement */
4913/****************************************************************/
4914
John Durkop6ba40d12020-11-10 08:50:04 -08004915#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004916static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4917 size_t peer_key_length,
4918 const mbedtls_ecp_keypair *our_key,
4919 uint8_t *shared_secret,
4920 size_t shared_secret_size,
4921 size_t *shared_secret_length )
4922{
Steven Cooremand4867872020-08-05 16:31:39 +02004923 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004924 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004925 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004926 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004927 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004928 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004929
Ronald Cron90857082020-11-25 14:58:33 +01004930 status = mbedtls_psa_ecp_load_representation(
4931 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004932 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004933 peer_key,
4934 peer_key_length,
4935 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004936 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004937 goto exit;
4938
Jaeden Amero97271b32019-01-10 19:38:51 +00004939 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004940 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004941 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004942 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004943 status = mbedtls_to_psa_error(
4944 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4945 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004946 goto exit;
4947
Jaeden Amero97271b32019-01-10 19:38:51 +00004948 status = mbedtls_to_psa_error(
4949 mbedtls_ecdh_calc_secret( &ecdh,
4950 shared_secret_length,
4951 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004952 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004953 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004954 if( status != PSA_SUCCESS )
4955 goto exit;
4956 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4957 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004958
4959exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004960 if( status != PSA_SUCCESS )
4961 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004962 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004963 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004964 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004965
Jaeden Amero97271b32019-01-10 19:38:51 +00004966 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004967}
John Durkop6ba40d12020-11-10 08:50:04 -08004968#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004969
Gilles Peskine01d718c2018-09-18 12:01:02 +02004970#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4971
Gilles Peskine0216fe12019-04-11 21:23:21 +02004972static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4973 psa_key_slot_t *private_key,
4974 const uint8_t *peer_key,
4975 size_t peer_key_length,
4976 uint8_t *shared_secret,
4977 size_t shared_secret_size,
4978 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004979{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004980 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004981 {
John Durkop6ba40d12020-11-10 08:50:04 -08004982#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004983 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004984 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004985 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004986 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004987 psa_status_t status = mbedtls_psa_ecp_load_representation(
4988 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004989 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004990 private_key->key.data,
4991 private_key->key.bytes,
4992 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004993 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004994 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004995 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004996 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004997 shared_secret, shared_secret_size,
4998 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004999 mbedtls_ecp_keypair_free( ecp );
5000 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005001 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005002#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005003 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005004 (void) private_key;
5005 (void) peer_key;
5006 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005007 (void) shared_secret;
5008 (void) shared_secret_size;
5009 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005010 return( PSA_ERROR_NOT_SUPPORTED );
5011 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005012}
5013
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005014/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005015 * to potentially free embedded data structures and wipe confidential data.
5016 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005017static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005018 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005019 psa_key_slot_t *private_key,
5020 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005021 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005022{
5023 psa_status_t status;
5024 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5025 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005026 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005027
5028 /* Step 1: run the secret agreement algorithm to generate the shared
5029 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005030 status = psa_key_agreement_raw_internal( ka_alg,
5031 private_key,
5032 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005033 shared_secret,
5034 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005035 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005036 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005037 goto exit;
5038
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005039 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005040 * the shared secret. A shared secret is permitted wherever a key
5041 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005042 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005043 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005044 shared_secret,
5045 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005046exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005047 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005048 return( status );
5049}
5050
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005051psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005052 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005053 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005054 const uint8_t *peer_key,
5055 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005056{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005058 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005059 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005060
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005061 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005062 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005063 status = psa_get_and_lock_transparent_key_slot_with_policy(
5064 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005065 if( status != PSA_SUCCESS )
5066 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005067 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005068 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005069 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005070 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005071 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005072 else
5073 {
5074 /* If a private key has been added as SECRET, we allow the derived
5075 * key material to be used as a key in PSA Crypto. */
5076 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5077 operation->can_output_key = 1;
5078 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005079
Ronald Cron5c522922020-11-14 16:35:34 +01005080 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005081
Ronald Cron5c522922020-11-14 16:35:34 +01005082 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005083}
5084
Gilles Peskinebe697d82019-05-16 18:00:41 +02005085psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005086 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005087 const uint8_t *peer_key,
5088 size_t peer_key_length,
5089 uint8_t *output,
5090 size_t output_size,
5091 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005092{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005094 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005095 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005096
5097 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5098 {
5099 status = PSA_ERROR_INVALID_ARGUMENT;
5100 goto exit;
5101 }
Ronald Cron5c522922020-11-14 16:35:34 +01005102 status = psa_get_and_lock_transparent_key_slot_with_policy(
5103 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005104 if( status != PSA_SUCCESS )
5105 goto exit;
5106
5107 status = psa_key_agreement_raw_internal( alg, slot,
5108 peer_key, peer_key_length,
5109 output, output_size,
5110 output_length );
5111
5112exit:
5113 if( status != PSA_SUCCESS )
5114 {
5115 /* If an error happens and is not handled properly, the output
5116 * may be used as a key to protect sensitive data. Arrange for such
5117 * a key to be random, which is likely to result in decryption or
5118 * verification errors. This is better than filling the buffer with
5119 * some constant data such as zeros, which would result in the data
5120 * being protected with a reproducible, easily knowable key.
5121 */
5122 psa_generate_random( output, output_size );
5123 *output_length = output_size;
5124 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005125
Ronald Cron5c522922020-11-14 16:35:34 +01005126 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005127
Ronald Cron5c522922020-11-14 16:35:34 +01005128 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005129}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005130
5131
Gilles Peskine30524eb2020-11-13 17:02:26 +01005132
Gilles Peskine86a440b2018-11-12 18:39:40 +01005133/****************************************************************/
5134/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005135/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005136
Gilles Peskine30524eb2020-11-13 17:02:26 +01005137/** Initialize the PSA random generator.
5138 */
5139static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5140{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005141#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5142 memset( rng, 0, sizeof( *rng ) );
5143#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5144
Gilles Peskine30524eb2020-11-13 17:02:26 +01005145 /* Set default configuration if
5146 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5147 if( rng->entropy_init == NULL )
5148 rng->entropy_init = mbedtls_entropy_init;
5149 if( rng->entropy_free == NULL )
5150 rng->entropy_free = mbedtls_entropy_free;
5151
5152 rng->entropy_init( &rng->entropy );
5153#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5154 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5155 /* The PSA entropy injection feature depends on using NV seed as an entropy
5156 * source. Add NV seed as an entropy source for PSA entropy injection. */
5157 mbedtls_entropy_add_source( &rng->entropy,
5158 mbedtls_nv_seed_poll, NULL,
5159 MBEDTLS_ENTROPY_BLOCK_SIZE,
5160 MBEDTLS_ENTROPY_SOURCE_STRONG );
5161#endif
5162
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005163 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005164#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005165}
5166
5167/** Deinitialize the PSA random generator.
5168 */
5169static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5170{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005171#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5172 memset( rng, 0, sizeof( *rng ) );
5173#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005174 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005175 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005176#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005177}
5178
5179/** Seed the PSA random generator.
5180 */
5181static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5182{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005183#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5184 /* Do nothing: the external RNG seeds itself. */
5185 (void) rng;
5186 return( PSA_SUCCESS );
5187#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005188 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005189 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5190 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005191 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005192#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005193}
5194
Gilles Peskinee59236f2018-01-27 23:32:46 +01005195psa_status_t psa_generate_random( uint8_t *output,
5196 size_t output_size )
5197{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005198 GUARD_MODULE_INITIALIZED;
5199
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005200#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5201
5202 size_t output_length = 0;
5203 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5204 output, output_size,
5205 &output_length );
5206 if( status != PSA_SUCCESS )
5207 return( status );
5208 /* Breaking up a request into smaller chunks is currently not supported
5209 * for the extrernal RNG interface. */
5210 if( output_length != output_size )
5211 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5212 return( PSA_SUCCESS );
5213
5214#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5215
Gilles Peskine71ddab92021-01-04 21:01:07 +01005216 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005217 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005218 size_t request_size =
5219 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5220 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5221 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005222 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5223 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005224 if( ret != 0 )
5225 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005226 output_size -= request_size;
5227 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005228 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005229 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005230#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005231}
5232
Gilles Peskine8814fc42020-12-14 15:33:44 +01005233/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005234 *
5235 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5236 * `psa_generate_random(...)`. The state parameter is ignored since the
5237 * PSA API doesn't support passing an explicit state.
5238 *
5239 * In the non-external case, psa_generate_random() calls an
5240 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5241 * and semantics as mbedtls_psa_get_random(). As an optimization,
5242 * instead of doing this back-and-forth between the PSA API and the
5243 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5244 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005245 */
5246#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5247int mbedtls_psa_get_random( void *p_rng,
5248 unsigned char *output,
5249 size_t output_size )
5250{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005251 /* This function takes a pointer to the RNG state because that's what
5252 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5253 * its own state internally and doesn't let the caller access that state.
5254 * So we just ignore the state parameter, and in practice we'll pass
5255 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005256 (void) p_rng;
5257 psa_status_t status = psa_generate_random( output, output_size );
5258 if( status == PSA_SUCCESS )
5259 return( 0 );
5260 else
5261 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5262}
5263#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5264
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005265#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5266#include "mbedtls/entropy_poll.h"
5267
Gilles Peskine7228da22019-07-15 11:06:15 +02005268psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005269 size_t seed_size )
5270{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005271 if( global_data.initialized )
5272 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005273
5274 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5275 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5276 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5277 return( PSA_ERROR_INVALID_ARGUMENT );
5278
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005279 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005280}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005281#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005282
Ronald Cron3772afe2021-02-08 16:10:05 +01005283/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005284 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005285 * \param type The key type
5286 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005287 *
5288 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005289 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005290 * \retval #PSA_ERROR_INVALID_ARGUMENT
5291 * The size in bits of the key is not valid.
5292 * \retval #PSA_ERROR_NOT_SUPPORTED
5293 * The type and/or the size in bits of the key or the combination of
5294 * the two is not supported.
5295 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005296static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5297 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005298{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005299 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005300
Gilles Peskinee59236f2018-01-27 23:32:46 +01005301 if( key_type_is_raw_bytes( type ) )
5302 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005303 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005304 if( status != PSA_SUCCESS )
5305 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005306 }
5307 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005308#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005309 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5310 {
5311 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5312 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005313
Ronald Cron01b2aba2020-10-05 09:42:02 +02005314 /* Accept only byte-aligned keys, for the same reasons as
5315 * in psa_import_rsa_key(). */
5316 if( bits % 8 != 0 )
5317 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005318 }
5319 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005320#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005321
Ronald Cron5c4d3862020-12-07 11:07:24 +01005322#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005323 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5324 {
Ronald Crond81ab562021-02-16 09:01:16 +01005325 /* To avoid empty block, return successfully here. */
5326 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005327 }
5328 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005329#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005330 {
5331 return( PSA_ERROR_NOT_SUPPORTED );
5332 }
5333
5334 return( PSA_SUCCESS );
5335}
5336
Ronald Cron55ed0592020-10-05 10:30:40 +02005337psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005338 const psa_key_attributes_t *attributes,
5339 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005340{
5341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005342 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005343
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005344 if( ( attributes->domain_parameters == NULL ) &&
5345 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005346 return( PSA_ERROR_INVALID_ARGUMENT );
5347
Ronald Cron01b2aba2020-10-05 09:42:02 +02005348 if( key_type_is_raw_bytes( type ) )
5349 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005350 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005351 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005352 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005353
David Brown12ca5032021-02-11 11:02:00 -07005354#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005355 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005356 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005357#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005358 }
5359 else
5360
John Durkop07cc04a2020-11-16 22:08:34 -08005361#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005362 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005363 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005364 return( mbedtls_psa_rsa_generate_key( attributes,
5365 key_buffer,
5366 key_buffer_size,
5367 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005368 }
5369 else
John Durkop07cc04a2020-11-16 22:08:34 -08005370#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005371
John Durkop9814fa22020-11-04 12:28:15 -08005372#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005373 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005374 {
Ronald Cron7023db52020-11-20 18:17:42 +01005375 return( mbedtls_psa_ecp_generate_key( attributes,
5376 key_buffer,
5377 key_buffer_size,
5378 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005379 }
5380 else
John Durkop9814fa22020-11-04 12:28:15 -08005381#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005382 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005383 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005384 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005385 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005386
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005387 return( PSA_SUCCESS );
5388}
Darryl Green0c6575a2018-11-07 16:05:30 +00005389
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005390psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005391 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005392{
5393 psa_status_t status;
5394 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005395 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005396 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005397
Ronald Cron81709fc2020-11-14 12:10:32 +01005398 *key = MBEDTLS_SVC_KEY_ID_INIT;
5399
Gilles Peskine0f84d622019-09-12 19:03:13 +02005400 /* Reject any attempt to create a zero-length key so that we don't
5401 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5402 if( psa_get_key_bits( attributes ) == 0 )
5403 return( PSA_ERROR_INVALID_ARGUMENT );
5404
Ronald Cron81709fc2020-11-14 12:10:32 +01005405 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5406 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005407 if( status != PSA_SUCCESS )
5408 goto exit;
5409
Ronald Cron977c2472020-10-13 08:32:21 +02005410 /* In the case of a transparent key or an opaque key stored in local
5411 * storage (thus not in the case of generating a key in a secure element
5412 * or cryptoprocessor with storage), we have to allocate a buffer to
5413 * hold the generated key material. */
5414 if( slot->key.data == NULL )
5415 {
5416 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5417 PSA_KEY_LOCATION_LOCAL_STORAGE )
5418 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005419 status = psa_validate_key_type_and_size_for_key_generation(
5420 attributes->core.type, attributes->core.bits );
5421 if( status != PSA_SUCCESS )
5422 goto exit;
5423
5424 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5425 attributes->core.type,
5426 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005427 }
5428 else
5429 {
5430 status = psa_driver_wrapper_get_key_buffer_size(
5431 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005432 if( status != PSA_SUCCESS )
5433 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005434 }
Ronald Cron977c2472020-10-13 08:32:21 +02005435
5436 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5437 if( status != PSA_SUCCESS )
5438 goto exit;
5439 }
5440
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005441 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005442 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005443
Ronald Cron2b56bc82020-10-05 10:02:26 +02005444 if( status != PSA_SUCCESS )
5445 psa_remove_key_data_from_memory( slot );
5446
Gilles Peskine11792082019-08-06 18:36:36 +02005447exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005448 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005449 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005450 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005451 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005452
Darryl Green0c6575a2018-11-07 16:05:30 +00005453 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005454}
5455
Gilles Peskinee59236f2018-01-27 23:32:46 +01005456/****************************************************************/
5457/* Module setup */
5458/****************************************************************/
5459
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005460#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005461psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5462 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5463 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5464{
5465 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5466 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005467 global_data.rng.entropy_init = entropy_init;
5468 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005469 return( PSA_SUCCESS );
5470}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005471#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005472
Gilles Peskinee59236f2018-01-27 23:32:46 +01005473void mbedtls_psa_crypto_free( void )
5474{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005475 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005476 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5477 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005478 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005479 }
5480 /* Wipe all remaining data, including configuration.
5481 * In particular, this sets all state indicator to the value
5482 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005483 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005484#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005485 /* Unregister all secure element drivers, so that we restart from
5486 * a pristine state. */
5487 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005488#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005489}
5490
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005491#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5492/** Recover a transaction that was interrupted by a power failure.
5493 *
5494 * This function is called during initialization, before psa_crypto_init()
5495 * returns. If this function returns a failure status, the initialization
5496 * fails.
5497 */
5498static psa_status_t psa_crypto_recover_transaction(
5499 const psa_crypto_transaction_t *transaction )
5500{
5501 switch( transaction->unknown.type )
5502 {
5503 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5504 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005505 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005506 * is implemented.
5507 * https://github.com/ARMmbed/mbed-crypto/issues/218
5508 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005509 default:
5510 /* We found an unsupported transaction in the storage.
5511 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005512 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005513 }
5514}
5515#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5516
Gilles Peskinee59236f2018-01-27 23:32:46 +01005517psa_status_t psa_crypto_init( void )
5518{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005519 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005520
Gilles Peskinec6b69072018-11-20 21:42:52 +01005521 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005522 if( global_data.initialized != 0 )
5523 return( PSA_SUCCESS );
5524
Gilles Peskine30524eb2020-11-13 17:02:26 +01005525 /* Initialize and seed the random generator. */
5526 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005527 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005528 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005529 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005530 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005531 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005532
Gilles Peskine66fb1262018-12-10 16:29:04 +01005533 status = psa_initialize_key_slots( );
5534 if( status != PSA_SUCCESS )
5535 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005536
Gilles Peskined9348f22019-10-01 15:22:29 +02005537#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5538 status = psa_init_all_se_drivers( );
5539 if( status != PSA_SUCCESS )
5540 goto exit;
5541#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5542
Gilles Peskine4b734222019-07-24 15:56:31 +02005543#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005544 status = psa_crypto_load_transaction( );
5545 if( status == PSA_SUCCESS )
5546 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005547 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5548 if( status != PSA_SUCCESS )
5549 goto exit;
5550 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005551 }
5552 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5553 {
5554 /* There's no transaction to complete. It's all good. */
5555 status = PSA_SUCCESS;
5556 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005557#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005558
Gilles Peskinec6b69072018-11-20 21:42:52 +01005559 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005560 global_data.initialized = 1;
5561
5562exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005563 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005564 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005565 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005566}
5567
5568#endif /* MBEDTLS_PSA_CRYPTO_C */