blob: ed847b280adf20658238c8650747306535f9b5b5 [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"
Chris Jonesdaacb592021-03-09 17:03:29 +000081#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010082#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000083#include "pk_wrap.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:
Gilles Peskinea5905292018-02-07 20:59:33 +0100154 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200155 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
156 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
157 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
158 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
159 case MBEDTLS_ERR_ASN1_INVALID_DATA:
160 return( PSA_ERROR_INVALID_ARGUMENT );
161 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
162 return( PSA_ERROR_INSUFFICIENT_MEMORY );
163 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
164 return( PSA_ERROR_BUFFER_TOO_SMALL );
165
Jaeden Amero93e21112019-02-20 13:57:28 +0000166#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000167 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000168#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100169 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
170 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100171
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000173 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000174#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100175 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
176 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100177
178 case MBEDTLS_ERR_CCM_BAD_INPUT:
179 return( PSA_ERROR_INVALID_ARGUMENT );
180 case MBEDTLS_ERR_CCM_AUTH_FAILED:
181 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100182
Gilles Peskine26869f22019-05-06 15:25:00 +0200183 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
184 return( PSA_ERROR_INVALID_ARGUMENT );
185
186 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
187 return( PSA_ERROR_BAD_STATE );
188 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
189 return( PSA_ERROR_INVALID_SIGNATURE );
190
Gilles Peskinea5905292018-02-07 20:59:33 +0100191 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
192 return( PSA_ERROR_NOT_SUPPORTED );
193 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
194 return( PSA_ERROR_INVALID_ARGUMENT );
195 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
196 return( PSA_ERROR_INSUFFICIENT_MEMORY );
197 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
198 return( PSA_ERROR_INVALID_PADDING );
199 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200200 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
202 return( PSA_ERROR_INVALID_SIGNATURE );
203 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200204 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100205
Gilles Peskine82e57d12020-11-13 21:31:17 +0100206#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
207 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100208 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
209 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100210 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
211 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
212 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
213 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
214 return( PSA_ERROR_NOT_SUPPORTED );
215 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
216 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100217#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100218
219 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
220 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100221
Gilles Peskinee59236f2018-01-27 23:32:46 +0100222 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
223 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
224 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
225 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100226
227 case MBEDTLS_ERR_GCM_AUTH_FAILED:
228 return( PSA_ERROR_INVALID_SIGNATURE );
229 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200230 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100231
Gilles Peskine82e57d12020-11-13 21:31:17 +0100232#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
233 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100234 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
235 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100236 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
237 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
238 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
239 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
240 return( PSA_ERROR_NOT_SUPPORTED );
241 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
242 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
243#endif
244
Gilles Peskinea5905292018-02-07 20:59:33 +0100245 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
246 return( PSA_ERROR_NOT_SUPPORTED );
247 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
248 return( PSA_ERROR_INVALID_ARGUMENT );
249 case MBEDTLS_ERR_MD_ALLOC_FAILED:
250 return( PSA_ERROR_INSUFFICIENT_MEMORY );
251 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
252 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100253
Gilles Peskinef76aa772018-10-29 19:24:33 +0100254 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
255 return( PSA_ERROR_STORAGE_FAILURE );
256 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
261 return( PSA_ERROR_BUFFER_TOO_SMALL );
262 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
269 return( PSA_ERROR_INSUFFICIENT_MEMORY );
270
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100271 case MBEDTLS_ERR_PK_ALLOC_FAILED:
272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
273 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
274 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
275 return( PSA_ERROR_INVALID_ARGUMENT );
276 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100278 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
279 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
282 return( PSA_ERROR_NOT_SUPPORTED );
283 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
284 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
285 return( PSA_ERROR_NOT_PERMITTED );
286 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_PK_INVALID_ALG:
289 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
290 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
291 return( PSA_ERROR_NOT_SUPPORTED );
292 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
293 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100294
Gilles Peskineff2d2002019-05-06 15:26:23 +0200295 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
296 return( PSA_ERROR_HARDWARE_FAILURE );
297 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
298 return( PSA_ERROR_NOT_SUPPORTED );
299
Gilles Peskinea5905292018-02-07 20:59:33 +0100300 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
301 return( PSA_ERROR_INVALID_ARGUMENT );
302 case MBEDTLS_ERR_RSA_INVALID_PADDING:
303 return( PSA_ERROR_INVALID_PADDING );
304 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
305 return( PSA_ERROR_HARDWARE_FAILURE );
306 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
307 return( PSA_ERROR_INVALID_ARGUMENT );
308 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
309 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200310 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100311 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
312 return( PSA_ERROR_INVALID_SIGNATURE );
313 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
314 return( PSA_ERROR_BUFFER_TOO_SMALL );
315 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100316 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200317
Gilles Peskinea5905292018-02-07 20:59:33 +0100318 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
319 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100320
itayzafrir5c753392018-05-08 11:18:38 +0300321 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300322 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300323 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300324 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
325 return( PSA_ERROR_BUFFER_TOO_SMALL );
326 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
327 return( PSA_ERROR_NOT_SUPPORTED );
328 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
329 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
330 return( PSA_ERROR_INVALID_SIGNATURE );
331 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
332 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100333 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
334 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100335
Janos Follatha13b9052019-11-22 12:48:59 +0000336 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
337 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300338
Gilles Peskinee59236f2018-01-27 23:32:46 +0100339 default:
David Saadab4ecc272019-02-14 13:48:10 +0200340 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100341 }
342}
343
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200344
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200345
346
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100347/****************************************************************/
348/* Key management */
349/****************************************************************/
350
Gilles Peskine73167e12019-07-12 23:44:37 +0200351#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
352static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
353{
Gilles Peskine8e338702019-07-30 20:06:31 +0200354 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200355}
356#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
357
John Durkop07cc04a2020-11-16 22:08:34 -0800358/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
359 * current test driver in key_management.c is using this function
360 * when accelerators are used for ECC key pair and public key.
361 * Once that dependency is resolved these guards can be removed.
362 */
John Durkop9814fa22020-11-04 12:28:15 -0800363#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800364 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
365 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
366 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100367mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100368 size_t bits,
369 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200370{
371 switch( curve )
372 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100373 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100374 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100375 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100376#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100377 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100378 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100379#endif
380#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100381 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100382 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100383#endif
384#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100385 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100386 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100387#endif
388#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#endif
392#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100393 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100394 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100395 case 528:
396 if( bits_is_sloppy )
397 return( MBEDTLS_ECP_DP_SECP521R1 );
398 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100399#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100400 }
401 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100402
Paul Elliott8ff510a2020-06-02 17:19:28 +0100403 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100404 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100405 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100406#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#endif
410#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100411 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100413#endif
414#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100415 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100416 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100417#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100418 }
419 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100420
Paul Elliott8ff510a2020-06-02 17:19:28 +0100421 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100422 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100424#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 case 256:
428 if( bits_is_sloppy )
429 return( MBEDTLS_ECP_DP_CURVE25519 );
430 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100431#endif
432#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100433 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100434 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100435#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100436 }
437 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100438
Paul Elliott8ff510a2020-06-02 17:19:28 +0100439 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100440 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100441 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100442#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100443 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100444 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100445#endif
446#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100447 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100448 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100449#endif
450#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100451 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100452 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100453#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100454 }
455 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200456 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100457
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100458 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100459 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200460}
John Durkop9814fa22020-11-04 12:28:15 -0800461#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800462 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
463 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
464 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200465
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200466static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
467 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468{
469 /* Check that the bit size is acceptable for the key type */
470 switch( type )
471 {
472 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200474 case PSA_KEY_TYPE_DERIVE:
475 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100476#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200477 case PSA_KEY_TYPE_AES:
478 if( bits != 128 && bits != 192 && bits != 256 )
479 return( PSA_ERROR_INVALID_ARGUMENT );
480 break;
481#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100482#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200483 case PSA_KEY_TYPE_CAMELLIA:
484 if( bits != 128 && bits != 192 && bits != 256 )
485 return( PSA_ERROR_INVALID_ARGUMENT );
486 break;
487#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100488#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200489 case PSA_KEY_TYPE_DES:
490 if( bits != 64 && bits != 128 && bits != 192 )
491 return( PSA_ERROR_INVALID_ARGUMENT );
492 break;
493#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100494#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200495 case PSA_KEY_TYPE_ARC4:
496 if( bits < 8 || bits > 2048 )
497 return( PSA_ERROR_INVALID_ARGUMENT );
498 break;
499#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100500#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200501 case PSA_KEY_TYPE_CHACHA20:
502 if( bits != 256 )
503 return( PSA_ERROR_INVALID_ARGUMENT );
504 break;
505#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200506 default:
507 return( PSA_ERROR_NOT_SUPPORTED );
508 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200509 if( bits % 8 != 0 )
510 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200511
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200512 return( PSA_SUCCESS );
513}
514
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100515/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100516 *
Steven Cooremancd640932021-03-08 12:00:27 +0100517 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
518 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100519 *
520 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100521 * \param[in] key_type The key type of the key to be used with the
522 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100523 *
524 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100525 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100526 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100527 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100528 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100529MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100530 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100531 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100532{
Steven Cooremancd640932021-03-08 12:00:27 +0100533 if( PSA_ALG_IS_HMAC( algorithm ) )
534 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100535 if( key_type == PSA_KEY_TYPE_HMAC )
536 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100537 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100538
539 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100540 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100541 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
542 * key. */
543 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
544 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
545 {
546 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
547 * the block length (larger than 1) for block ciphers. */
548 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
549 return( PSA_SUCCESS );
550 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100551 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100552
553 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100554}
555
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200556psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
557 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200558{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100559 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200560 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200561
Ronald Cronea0f8a62020-11-25 17:52:23 +0100562 slot->key.data = mbedtls_calloc( 1, buffer_length );
563 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200564 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200565
Ronald Cronea0f8a62020-11-25 17:52:23 +0100566 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200567 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200568}
569
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200570psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
571 const uint8_t* data,
572 size_t data_length )
573{
574 psa_status_t status = psa_allocate_buffer_to_slot( slot,
575 data_length );
576 if( status != PSA_SUCCESS )
577 return( status );
578
Ronald Cronea0f8a62020-11-25 17:52:23 +0100579 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200580 return( PSA_SUCCESS );
581}
582
Ronald Crona0fe59f2020-11-29 11:14:53 +0100583psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100584 const psa_key_attributes_t *attributes,
585 const uint8_t *data, size_t data_length,
586 uint8_t *key_buffer, size_t key_buffer_size,
587 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100588{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100589 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
590 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100591
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200592 /* zero-length keys are never supported. */
593 if( data_length == 0 )
594 return( PSA_ERROR_NOT_SUPPORTED );
595
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100596 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100597 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100598 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200599
Steven Cooreman75b74362020-07-28 14:30:13 +0200600 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
601 if( data_length > SIZE_MAX / 8 )
602 return( PSA_ERROR_NOT_SUPPORTED );
603
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200604 /* Enforce a size limit, and in particular ensure that the bit
605 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100606 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200607 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200608
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100609 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200610 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200611 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200612
Ronald Crondd04d422020-11-28 15:14:42 +0100613 /* Copy the key material. */
614 memcpy( key_buffer, data, data_length );
615 *key_buffer_length = data_length;
616 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200617
Steven Cooreman40120f62020-10-29 11:42:22 +0100618 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100619 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100620 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200621 {
John Durkop9814fa22020-11-04 12:28:15 -0800622#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
623 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100624 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200625 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100626 return( mbedtls_psa_ecp_import_key( attributes,
627 data, data_length,
628 key_buffer, key_buffer_size,
629 key_buffer_length,
630 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100631 }
John Durkop9814fa22020-11-04 12:28:15 -0800632#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
633 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700634#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
635 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100636 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200637 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100638 return( mbedtls_psa_rsa_import_key( attributes,
639 data, data_length,
640 key_buffer, key_buffer_size,
641 key_buffer_length,
642 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200643 }
John Durkop9814fa22020-11-04 12:28:15 -0800644#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
645 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100646 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100647
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100648 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100649}
650
Gilles Peskinef603c712019-01-19 13:40:11 +0100651/** Calculate the intersection of two algorithm usage policies.
652 *
653 * Return 0 (which allows no operation) on incompatibility.
654 */
655static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100656 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100657 psa_algorithm_t alg1,
658 psa_algorithm_t alg2 )
659{
Gilles Peskine549ea862019-05-22 11:45:59 +0200660 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100661 if( alg1 == alg2 )
662 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100663 /* If the policies are from the same hash-and-sign family, check
664 * if one is a wildcard. If so the other has the specific algorithm. */
665 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
666 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
667 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100668 {
Steven Cooreman03488022021-02-18 12:07:20 +0100669 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
670 return( alg2 );
671 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
672 return( alg1 );
673 }
674 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100675 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100676 * restrictive tag length. */
677 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
678 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
679 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
680 {
681 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
682 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100683 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100684
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100685 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100686 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
687 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100688 {
Steven Cooremancd640932021-03-08 12:00:27 +0100689 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
690 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100691 }
692 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100693 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100694 ( alg1_len <= alg2_len ) )
695 {
696 return( alg2 );
697 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100698 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100699 ( alg2_len <= alg1_len ) )
700 {
701 return( alg1 );
702 }
703 }
704 /* If the policies are from the same MAC family, check whether one
705 * of them is a minimum-MAC-length policy. Calculate the most
706 * restrictive tag length. */
707 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
708 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
709 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
710 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100711 /* Validate the combination of key type and algorithm. Since the base
712 * algorithm of alg1 and alg2 are the same, we only need this once. */
713 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100714 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100715
Steven Cooreman31a876d2021-03-03 20:47:40 +0100716 /* Get the (exact or at-least) output lengths for both sides of the
717 * requested intersection. None of the currently supported algorithms
718 * have an output length dependent on the actual key size, so setting it
719 * to a bogus value of 0 is currently OK.
720 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100721 * Note that for at-least-this-length wildcard algorithms, the output
722 * length is set to the shortest allowed length, which allows us to
723 * calculate the most restrictive tag length for the intersection. */
724 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
725 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100726 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100727
Steven Cooremana1d83222021-02-25 10:20:29 +0100728 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100729 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
730 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100731 {
Steven Cooremancd640932021-03-08 12:00:27 +0100732 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100733 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100734
735 /* If only one is an at-least-this-length policy, the intersection would
736 * be the other (fixed-length) policy as long as said fixed length is
737 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100738 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100739 {
Steven Cooremancd640932021-03-08 12:00:27 +0100740 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100741 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100742 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100743 {
Steven Cooremancd640932021-03-08 12:00:27 +0100744 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100745 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100746
Steven Cooremancd640932021-03-08 12:00:27 +0100747 /* If none of them are wildcards, check whether they define the same tag
748 * length. This is still possible here when one is default-length and
749 * the other specific-length. Ensure to always return the
750 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100751 if( alg1_len == alg2_len )
752 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100753 }
754 /* If the policies are incompatible, allow nothing. */
755 return( 0 );
756}
757
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100758static int psa_key_algorithm_permits( psa_key_type_t key_type,
759 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200760 psa_algorithm_t requested_alg )
761{
Gilles Peskine549ea862019-05-22 11:45:59 +0200762 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200763 if( requested_alg == policy_alg )
764 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100765 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
766 * and requested_alg is the same hash-and-sign family with any hash,
767 * then requested_alg is compliant with policy_alg. */
768 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
769 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200770 {
Steven Cooreman03488022021-02-18 12:07:20 +0100771 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
772 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
773 }
774 /* If policy_alg is a wildcard AEAD algorithm of the same base as
775 * the requested algorithm, check the requested tag length to be
776 * equal-length or longer than the wildcard-specified length. */
777 if( PSA_ALG_IS_AEAD( policy_alg ) &&
778 PSA_ALG_IS_AEAD( requested_alg ) &&
779 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
780 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100781 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100782 {
783 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
784 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
785 }
Steven Cooremancd640932021-03-08 12:00:27 +0100786 /* If policy_alg is a MAC algorithm of the same base as the requested
787 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100788 if( PSA_ALG_IS_MAC( policy_alg ) &&
789 PSA_ALG_IS_MAC( requested_alg ) &&
790 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100791 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100792 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100793 /* Validate the combination of key type and algorithm. Since the policy
794 * and requested algorithms are the same, we only need this once. */
795 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100796 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100797
Steven Cooreman31a876d2021-03-03 20:47:40 +0100798 /* Get both the requested output length for the algorithm which is to be
799 * verified, and the default output length for the base algorithm.
800 * Note that none of the currently supported algorithms have an output
801 * length dependent on actual key size, so setting it to a bogus value
802 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100803 size_t requested_output_length = PSA_MAC_LENGTH(
804 key_type, 0, requested_alg );
805 size_t default_output_length = PSA_MAC_LENGTH(
806 key_type, 0,
807 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100808
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809 /* If the policy is default-length, only allow an algorithm with
810 * a declared exact-length matching the default. */
811 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100812 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100813
814 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100815 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100816 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
817 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
818 {
819 return( 1 );
820 }
821
Steven Cooremancd640932021-03-08 12:00:27 +0100822 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
823 * check for the requested MAC length to be equal to or longer than the
824 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100825 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
826 {
827 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100828 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100829 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200830 }
Steven Cooremance48e852020-10-05 16:02:45 +0200831 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200832 * a key derivation with that key agreement should also be allowed. This
833 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200834 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
835 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
836 {
837 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
838 policy_alg );
839 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100840 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200841 return( 0 );
842}
843
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100844/** Test whether a policy permits an algorithm.
845 *
846 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100847 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100848 * \note This function requires providing the key type for which the policy is
849 * being validated, since some algorithm policy definitions (e.g. MAC)
850 * have different properties depending on what kind of cipher it is
851 * combined with.
852 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100853 * \retval PSA_SUCCESS When \p alg is a specific algorithm
854 * allowed by the \p policy.
855 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
856 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
857 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100859static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100860 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100861 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100862{
Steven Cooremand788fab2021-02-25 11:29:17 +0100863 /* '0' is not a valid algorithm */
864 if( alg == 0 )
865 return( PSA_ERROR_INVALID_ARGUMENT );
866
Steven Cooreman7e39f052021-02-23 14:18:32 +0100867 /* A requested algorithm cannot be a wildcard. */
868 if( PSA_ALG_IS_WILDCARD( alg ) )
869 return( PSA_ERROR_INVALID_ARGUMENT );
870
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100871 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
872 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100873 return( PSA_SUCCESS );
874 else
875 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100876}
877
Gilles Peskinef603c712019-01-19 13:40:11 +0100878/** Restrict a key policy based on a constraint.
879 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100880 * \note This function requires providing the key type for which the policy is
881 * being restricted, since some algorithm policy definitions (e.g. MAC)
882 * have different properties depending on what kind of cipher it is
883 * combined with.
884 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100885 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100886 * \param[in,out] policy The policy to restrict.
887 * \param[in] constraint The policy constraint to apply.
888 *
889 * \retval #PSA_SUCCESS
890 * \c *policy contains the intersection of the original value of
891 * \c *policy and \c *constraint.
892 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100893 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100894 * \c *policy is unchanged.
895 */
896static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100897 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100898 psa_key_policy_t *policy,
899 const psa_key_policy_t *constraint )
900{
901 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100902 psa_key_policy_algorithm_intersection( key_type, policy->alg,
903 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200904 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100905 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
906 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100907 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
908 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200909 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
910 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100911 policy->usage &= constraint->usage;
912 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200913 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100914 return( PSA_SUCCESS );
915}
916
Ronald Cron5c522922020-11-14 16:35:34 +0100917/** Get the description of a key given its identifier and policy constraints
918 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200919 *
Ronald Cron5c522922020-11-14 16:35:34 +0100920 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100921 * nonzero, the key must allow operations with this algorithm. If \p alg is
922 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100923 *
Ronald Cron5c522922020-11-14 16:35:34 +0100924 * In case of a persistent key, the function loads the description of the key
925 * into a key slot if not already done.
926 *
927 * On success, the returned key slot is locked. It is the responsibility of
928 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200929 */
Ronald Cron5c522922020-11-14 16:35:34 +0100930static psa_status_t psa_get_and_lock_key_slot_with_policy(
931 mbedtls_svc_key_id_t key,
932 psa_key_slot_t **p_slot,
933 psa_key_usage_t usage,
934 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100935{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200936 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
937 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100938
Ronald Cron5c522922020-11-14 16:35:34 +0100939 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100940 if( status != PSA_SUCCESS )
941 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200942 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100943
944 /* Enforce that usage policy for the key slot contains all the flags
945 * required by the usage parameter. There is one exception: public
946 * keys can always be exported, so we treat public key objects as
947 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200948 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100949 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200950
Gilles Peskine8e338702019-07-30 20:06:31 +0200951 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100952 {
953 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200954 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100955 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100956
957 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100958 if( alg != 0 )
959 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100960 status = psa_key_policy_permits( &slot->attr.policy,
961 slot->attr.type,
962 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100963 if( status != PSA_SUCCESS )
964 goto error;
965 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100966
Darryl Green06fd18d2018-07-16 11:21:11 +0100967 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200968
969error:
970 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100971 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200972
973 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100974}
Darryl Green940d72c2018-07-13 13:18:51 +0100975
Ronald Cron5c522922020-11-14 16:35:34 +0100976/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200977 *
978 * A transparent key is a key for which the key material is directly
979 * available, as opposed to a key in a secure element.
980 *
Ronald Cron5c522922020-11-14 16:35:34 +0100981 * This is a temporary function to use instead of
982 * psa_get_and_lock_key_slot_with_policy() until secure element support is
983 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200984 *
Ronald Cron5c522922020-11-14 16:35:34 +0100985 * On success, the returned key slot is locked. It is the responsibility of the
986 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200987 */
988#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100989static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
990 mbedtls_svc_key_id_t key,
991 psa_key_slot_t **p_slot,
992 psa_key_usage_t usage,
993 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200994{
Ronald Cron5c522922020-11-14 16:35:34 +0100995 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
996 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200997 if( status != PSA_SUCCESS )
998 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200999
Gilles Peskineadad8132019-07-25 11:31:23 +02001000 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001001 {
Ronald Cron5c522922020-11-14 16:35:34 +01001002 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001003 *p_slot = NULL;
1004 return( PSA_ERROR_NOT_SUPPORTED );
1005 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001006
Gilles Peskine28f8f302019-07-24 13:30:31 +02001007 return( PSA_SUCCESS );
1008}
1009#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1010/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001011#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1012 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001013#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1014
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001015psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001016{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001017 /* Data pointer will always be either a valid pointer or NULL in an
1018 * initialized slot, so we can just free it. */
1019 if( slot->key.data != NULL )
1020 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1021
1022 mbedtls_free( slot->key.data );
1023 slot->key.data = NULL;
1024 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001025
1026 return( PSA_SUCCESS );
1027}
1028
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001029/** Completely wipe a slot in memory, including its policy.
1030 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001031psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001032{
1033 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001034
1035 /*
1036 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001037 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001038 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1039 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001040 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001041 */
Ronald Cron5c522922020-11-14 16:35:34 +01001042 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001043 {
1044#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001045 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001046#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001047 status = PSA_ERROR_CORRUPTION_DETECTED;
1048 }
1049
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001050 /* Multipart operations may still be using the key. This is safe
1051 * because all multipart operation objects are independent from
1052 * the key slot: if they need to access the key after the setup
1053 * phase, they have a copy of the key. Note that this means that
1054 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001055 /* At this point, key material and other type-specific content has
1056 * been wiped. Clear remaining metadata. We can call memset and not
1057 * zeroize because the metadata is not particularly sensitive. */
1058 memset( slot, 0, sizeof( *slot ) );
1059 return( status );
1060}
1061
Ronald Croncf56a0a2020-08-04 09:51:30 +02001062psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001063{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001064 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001065 psa_status_t status; /* status of the last operation */
1066 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001067#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1068 psa_se_drv_table_entry_t *driver;
1069#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001070
Ronald Croncf56a0a2020-08-04 09:51:30 +02001071 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001072 return( PSA_SUCCESS );
1073
Ronald Cronf2911112020-10-29 17:51:10 +01001074 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001075 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001076 * key, this will load the key description from persistent memory if not
1077 * done yet. We cannot avoid this loading as without it we don't know if
1078 * the key is operated by an SE or not and this information is needed by
1079 * the current implementation.
1080 */
Ronald Cron5c522922020-11-14 16:35:34 +01001081 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001082 if( status != PSA_SUCCESS )
1083 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001084
Ronald Cronf2911112020-10-29 17:51:10 +01001085 /*
1086 * If the key slot containing the key description is under access by the
1087 * library (apart from the present access), the key cannot be destroyed
1088 * yet. For the time being, just return in error. Eventually (to be
1089 * implemented), the key should be destroyed when all accesses have
1090 * stopped.
1091 */
Ronald Cron5c522922020-11-14 16:35:34 +01001092 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001093 {
Ronald Cron5c522922020-11-14 16:35:34 +01001094 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001095 return( PSA_ERROR_GENERIC_ERROR );
1096 }
1097
Gilles Peskine354f7672019-07-12 23:46:38 +02001098#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001099 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001100 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001101 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001102 /* For a key in a secure element, we need to do three things:
1103 * remove the key file in internal storage, destroy the
1104 * key inside the secure element, and update the driver's
1105 * persistent data. Start a transaction that will encompass these
1106 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001107 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001108 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001109 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001110 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001111 status = psa_crypto_save_transaction( );
1112 if( status != PSA_SUCCESS )
1113 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001114 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001115 /* We should still try to destroy the key in the secure
1116 * element and the key metadata in storage. This is especially
1117 * important if the error is that the storage is full.
1118 * But how to do it exactly without risking an inconsistent
1119 * state after a reset?
1120 * https://github.com/ARMmbed/mbed-crypto/issues/215
1121 */
1122 overall_status = status;
1123 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001124 }
1125
Ronald Cronea0f8a62020-11-25 17:52:23 +01001126 status = psa_destroy_se_key( driver,
1127 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128 if( overall_status == PSA_SUCCESS )
1129 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001130 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001131#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1132
Darryl Greend49a4992018-06-18 17:27:26 +01001133#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001134 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001135 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001136 status = psa_destroy_persistent_key( slot->attr.id );
1137 if( overall_status == PSA_SUCCESS )
1138 overall_status = status;
1139
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001140 /* TODO: other slots may have a copy of the same key. We should
1141 * invalidate them.
1142 * https://github.com/ARMmbed/mbed-crypto/issues/214
1143 */
Darryl Greend49a4992018-06-18 17:27:26 +01001144 }
1145#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001146
Gilles Peskinefc762652019-07-22 19:30:34 +02001147#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1148 if( driver != NULL )
1149 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001150 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001151 if( overall_status == PSA_SUCCESS )
1152 overall_status = status;
1153 status = psa_crypto_stop_transaction( );
1154 if( overall_status == PSA_SUCCESS )
1155 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001156 }
1157#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1158
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001159#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1160exit:
1161#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001162 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001163 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1164 if( overall_status == PSA_SUCCESS )
1165 overall_status = status;
1166 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001167}
1168
John Durkop07cc04a2020-11-16 22:08:34 -08001169#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001170 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001171static psa_status_t psa_get_rsa_public_exponent(
1172 const mbedtls_rsa_context *rsa,
1173 psa_key_attributes_t *attributes )
1174{
1175 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001176 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001177 uint8_t *buffer = NULL;
1178 size_t buflen;
1179 mbedtls_mpi_init( &mpi );
1180
1181 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1182 if( ret != 0 )
1183 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001184 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1185 {
1186 /* It's the default value, which is reported as an empty string,
1187 * so there's nothing to do. */
1188 goto exit;
1189 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001190
1191 buflen = mbedtls_mpi_size( &mpi );
1192 buffer = mbedtls_calloc( 1, buflen );
1193 if( buffer == NULL )
1194 {
1195 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1196 goto exit;
1197 }
1198 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1199 if( ret != 0 )
1200 goto exit;
1201 attributes->domain_parameters = buffer;
1202 attributes->domain_parameters_size = buflen;
1203
1204exit:
1205 mbedtls_mpi_free( &mpi );
1206 if( ret != 0 )
1207 mbedtls_free( buffer );
1208 return( mbedtls_to_psa_error( ret ) );
1209}
John Durkop07cc04a2020-11-16 22:08:34 -08001210#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001211 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001212
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001213/** Retrieve all the publicly-accessible attributes of a key.
1214 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001215psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001216 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001217{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001219 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001220 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001221
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001222 psa_reset_key_attributes( attributes );
1223
Ronald Cron5c522922020-11-14 16:35:34 +01001224 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001225 if( status != PSA_SUCCESS )
1226 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001227
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001228 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001229 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1230 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1231
1232#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1233 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001234 psa_set_key_slot_number( attributes,
1235 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001236#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001237
Gilles Peskine8e338702019-07-30 20:06:31 +02001238 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001239 {
John Durkop07cc04a2020-11-16 22:08:34 -08001240#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001241 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001242 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001243 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001244#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001245 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001246 * is not yet implemented.
1247 * https://github.com/ARMmbed/mbed-crypto/issues/216
1248 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001249 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001250 break;
1251#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001252 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001253 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001254
Ronald Cron90857082020-11-25 14:58:33 +01001255 status = mbedtls_psa_rsa_load_representation(
1256 slot->attr.type,
1257 slot->key.data,
1258 slot->key.bytes,
1259 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001260 if( status != PSA_SUCCESS )
1261 break;
1262
Steven Cooremana2371e52020-07-28 14:30:39 +02001263 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001264 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001265 mbedtls_rsa_free( rsa );
1266 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001267 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001268 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001269#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001270 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001271 default:
1272 /* Nothing else to do. */
1273 break;
1274 }
1275
1276 if( status != PSA_SUCCESS )
1277 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001278
Ronald Cron5c522922020-11-14 16:35:34 +01001279 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001280
Ronald Cron5c522922020-11-14 16:35:34 +01001281 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001282}
1283
Gilles Peskinec8000c02019-08-02 20:15:51 +02001284#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1285psa_status_t psa_get_key_slot_number(
1286 const psa_key_attributes_t *attributes,
1287 psa_key_slot_number_t *slot_number )
1288{
1289 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1290 {
1291 *slot_number = attributes->slot_number;
1292 return( PSA_SUCCESS );
1293 }
1294 else
1295 return( PSA_ERROR_INVALID_ARGUMENT );
1296}
1297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1298
Ronald Crond18b5f82020-11-25 16:46:05 +01001299static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1300 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001301 uint8_t *data,
1302 size_t data_size,
1303 size_t *data_length )
1304{
Ronald Crond18b5f82020-11-25 16:46:05 +01001305 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001306 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001307 memcpy( data, key_buffer, key_buffer_size );
1308 memset( data + key_buffer_size, 0,
1309 data_size - key_buffer_size );
1310 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001311 return( PSA_SUCCESS );
1312}
1313
Ronald Cron7285cda2020-11-26 14:46:37 +01001314psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001315 const psa_key_attributes_t *attributes,
1316 const uint8_t *key_buffer, size_t key_buffer_size,
1317 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001318{
Ronald Crond18b5f82020-11-25 16:46:05 +01001319 psa_key_type_t type = attributes->core.type;
1320
Ronald Crond18b5f82020-11-25 16:46:05 +01001321 if( key_type_is_raw_bytes( type ) ||
1322 PSA_KEY_TYPE_IS_RSA( type ) ||
1323 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001324 {
1325 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001326 key_buffer, key_buffer_size,
1327 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001328 }
1329 else
1330 {
1331 /* This shouldn't happen in the reference implementation, but
1332 it is valid for a special-purpose implementation to omit
1333 support for exporting certain key types. */
1334 return( PSA_ERROR_NOT_SUPPORTED );
1335 }
1336}
1337
1338psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1339 uint8_t *data,
1340 size_t data_size,
1341 size_t *data_length )
1342{
1343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1344 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1345 psa_key_slot_t *slot;
1346
Ronald Crone907e552021-01-18 13:22:38 +01001347 /* Reject a zero-length output buffer now, since this can never be a
1348 * valid key representation. This way we know that data must be a valid
1349 * pointer and we can do things like memset(data, ..., data_size). */
1350 if( data_size == 0 )
1351 return( PSA_ERROR_BUFFER_TOO_SMALL );
1352
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353 /* Set the key to empty now, so that even when there are errors, we always
1354 * set data_length to a value between 0 and data_size. On error, setting
1355 * the key to empty is a good choice because an empty key representation is
1356 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001357 *data_length = 0;
1358
Ronald Cron9486f9d2020-11-26 13:36:23 +01001359 /* Export requires the EXPORT flag. There is an exception for public keys,
1360 * which don't require any flag, but
1361 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1362 */
1363 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1364 PSA_KEY_USAGE_EXPORT, 0 );
1365 if( status != PSA_SUCCESS )
1366 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001367
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 psa_key_attributes_t attributes = {
1369 .core = slot->attr
1370 };
Ronald Cron67227982020-11-26 15:16:05 +01001371 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001372 slot->key.data, slot->key.bytes,
1373 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001374
Ronald Cron9486f9d2020-11-26 13:36:23 +01001375 unlock_status = psa_unlock_key_slot( slot );
1376
1377 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1378}
1379
Ronald Cron7285cda2020-11-26 14:46:37 +01001380psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001381 const psa_key_attributes_t *attributes,
1382 const uint8_t *key_buffer,
1383 size_t key_buffer_size,
1384 uint8_t *data,
1385 size_t data_size,
1386 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001387{
Ronald Crond18b5f82020-11-25 16:46:05 +01001388 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001389
Ronald Crond18b5f82020-11-25 16:46:05 +01001390 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001391 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001392 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001393 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001394 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001395 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001396 key_buffer, key_buffer_size,
1397 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001398 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001399
Ronald Crond18b5f82020-11-25 16:46:05 +01001400 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001401 {
John Durkop0e005192020-10-31 22:06:54 -07001402#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1403 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001404 return( mbedtls_psa_rsa_export_public_key( attributes,
1405 key_buffer,
1406 key_buffer_size,
1407 data,
1408 data_size,
1409 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001410#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001411 /* We don't know how to convert a private RSA key to public. */
1412 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001413#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1414 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001415 }
1416 else
Moran Pekera998bc62018-04-16 18:16:20 +03001417 {
John Durkop6ba40d12020-11-10 08:50:04 -08001418#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1419 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001420 return( mbedtls_psa_ecp_export_public_key( attributes,
1421 key_buffer,
1422 key_buffer_size,
1423 data,
1424 data_size,
1425 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001426#else
1427 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001428 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001429#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1430 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001431 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001432 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001433 else
1434 {
1435 /* This shouldn't happen in the reference implementation, but
1436 it is valid for a special-purpose implementation to omit
1437 support for exporting certain key types. */
1438 return( PSA_ERROR_NOT_SUPPORTED );
1439 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001440}
Ronald Crond18b5f82020-11-25 16:46:05 +01001441
Ronald Croncf56a0a2020-08-04 09:51:30 +02001442psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001443 uint8_t *data,
1444 size_t data_size,
1445 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001446{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001448 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001449 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001450
Ronald Crone907e552021-01-18 13:22:38 +01001451 /* Reject a zero-length output buffer now, since this can never be a
1452 * valid key representation. This way we know that data must be a valid
1453 * pointer and we can do things like memset(data, ..., data_size). */
1454 if( data_size == 0 )
1455 return( PSA_ERROR_BUFFER_TOO_SMALL );
1456
Darryl Greendd8fb772018-11-07 16:00:44 +00001457 /* Set the key to empty now, so that even when there are errors, we always
1458 * set data_length to a value between 0 and data_size. On error, setting
1459 * the key to empty is a good choice because an empty key representation is
1460 * unlikely to be accepted anywhere. */
1461 *data_length = 0;
1462
1463 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001464 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001465 if( status != PSA_SUCCESS )
1466 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001467
Ronald Cron9486f9d2020-11-26 13:36:23 +01001468 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1469 {
1470 status = PSA_ERROR_INVALID_ARGUMENT;
1471 goto exit;
1472 }
1473
Ronald Crond18b5f82020-11-25 16:46:05 +01001474 psa_key_attributes_t attributes = {
1475 .core = slot->attr
1476 };
Ronald Cron67227982020-11-26 15:16:05 +01001477 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001478 &attributes, slot->key.data, slot->key.bytes,
1479 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001480
1481exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001482 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001483
Ronald Cron5c522922020-11-14 16:35:34 +01001484 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001485}
1486
Gilles Peskine91e8c332019-08-02 19:19:39 +02001487#if defined(static_assert)
1488static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1489 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001490static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001491 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001492static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001493 "One or more key attribute flag is listed as both internal-only and external-only" );
1494#endif
1495
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001496/** Validate that a key policy is internally well-formed.
1497 *
1498 * This function only rejects invalid policies. It does not validate the
1499 * consistency of the policy with respect to other attributes of the key
1500 * such as the key type.
1501 */
1502static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001503{
1504 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001505 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001506 PSA_KEY_USAGE_ENCRYPT |
1507 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001508 PSA_KEY_USAGE_SIGN_HASH |
1509 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001510 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1511 return( PSA_ERROR_INVALID_ARGUMENT );
1512
Gilles Peskine4747d192019-04-17 15:05:45 +02001513 return( PSA_SUCCESS );
1514}
1515
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001516/** Validate the internal consistency of key attributes.
1517 *
1518 * This function only rejects invalid attribute values. If does not
1519 * validate the consistency of the attributes with any key data that may
1520 * be involved in the creation of the key.
1521 *
1522 * Call this function early in the key creation process.
1523 *
1524 * \param[in] attributes Key attributes for the new key.
1525 * \param[out] p_drv On any return, the driver for the key, if any.
1526 * NULL for a transparent key.
1527 *
1528 */
1529static psa_status_t psa_validate_key_attributes(
1530 const psa_key_attributes_t *attributes,
1531 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001532{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001533 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001534 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001535 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536
Ronald Cron54b90082020-10-29 15:26:43 +01001537 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001538 if( status != PSA_SUCCESS )
1539 return( status );
1540
Ronald Crond2ed4812020-07-17 16:11:30 +02001541 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001542 if( status != PSA_SUCCESS )
1543 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001544
Ronald Cron65f38a32020-10-23 17:11:13 +02001545 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1546 {
1547 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1548 return( PSA_ERROR_INVALID_ARGUMENT );
1549 }
1550 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001551 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001552 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1553 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001554 }
1555
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001556 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001557 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001558 return( status );
1559
1560 /* Refuse to create overly large keys.
1561 * Note that this doesn't trigger on import if the attributes don't
1562 * explicitly specify a size (so psa_get_key_bits returns 0), so
1563 * psa_import_key() needs its own checks. */
1564 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1565 return( PSA_ERROR_NOT_SUPPORTED );
1566
Gilles Peskine91e8c332019-08-02 19:19:39 +02001567 /* Reject invalid flags. These should not be reachable through the API. */
1568 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1569 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1570 return( PSA_ERROR_INVALID_ARGUMENT );
1571
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001572 return( PSA_SUCCESS );
1573}
1574
Gilles Peskine4747d192019-04-17 15:05:45 +02001575/** Prepare a key slot to receive key material.
1576 *
1577 * This function allocates a key slot and sets its metadata.
1578 *
1579 * If this function fails, call psa_fail_key_creation().
1580 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001581 * This function is intended to be used as follows:
1582 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001583 * it with the specified attributes, and in case of a volatile key assign it
1584 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001585 * -# Populate the slot with the key material.
1586 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1587 * In case of failure at any step, stop the sequence and call
1588 * psa_fail_key_creation().
1589 *
Ronald Cron5c522922020-11-14 16:35:34 +01001590 * On success, the key slot is locked. It is the responsibility of the caller
1591 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001592 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001593 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001594 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001595 * \param[out] p_slot On success, a pointer to the prepared slot.
1596 * \param[out] p_drv On any return, the driver for the key, if any.
1597 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001598 *
1599 * \retval #PSA_SUCCESS
1600 * The key slot is ready to receive key material.
1601 * \return If this function fails, the key slot is an invalid state.
1602 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001603 */
1604static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001605 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001606 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001607 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001608 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001609{
1610 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001611 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001612 psa_key_slot_t *slot;
1613
Gilles Peskinedf179142019-07-15 22:02:14 +02001614 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001615 *p_drv = NULL;
1616
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001617 status = psa_validate_key_attributes( attributes, p_drv );
1618 if( status != PSA_SUCCESS )
1619 return( status );
1620
Ronald Cronc4d1b512020-07-31 11:26:37 +02001621 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001622 if( status != PSA_SUCCESS )
1623 return( status );
1624 slot = *p_slot;
1625
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001626 /* We're storing the declared bit-size of the key. It's up to each
1627 * creation mechanism to verify that this information is correct.
1628 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001629 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001630 * is optional (import, copy). In case of a volatile key, assign it the
1631 * volatile key identifier associated to the slot returned to contain its
1632 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001633
1634 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001635 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1636 {
1637#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1638 slot->attr.id = volatile_key_id;
1639#else
1640 slot->attr.id.key_id = volatile_key_id;
1641#endif
1642 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001643
Gilles Peskine91e8c332019-08-02 19:19:39 +02001644 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001645 * external-only flags, query `attributes`. Thanks to the check
1646 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001647 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001648 * may have set. */
1649 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001650
Gilles Peskinecbaff462019-07-12 23:46:04 +02001651#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001652 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001653 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001654 * create the key file in internal storage, create the
1655 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001656 * persistent data. This is done by starting a transaction that will
1657 * encompass these three actions.
1658 * For registering a volatile key, we just need to find an appropriate
1659 * slot number inside the SE. Since the key is designated volatile, creating
1660 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001661 /* The first thing to do is to find a slot number for the new key.
1662 * We save the slot number in persistent storage as part of the
1663 * transaction data. It will be needed to recover if the power
1664 * fails during the key creation process, to clean up on the secure
1665 * element side after restarting. Obtaining a slot number from the
1666 * secure element driver updates its persistent state, but we do not yet
1667 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001668 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001669 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001670 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001671 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001672 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001673 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001674 if( status != PSA_SUCCESS )
1675 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001676
1677 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001678 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001679 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1680 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001681 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001682 psa_crypto_transaction.key.id = slot->attr.id;
1683 status = psa_crypto_save_transaction( );
1684 if( status != PSA_SUCCESS )
1685 {
1686 (void) psa_crypto_stop_transaction( );
1687 return( status );
1688 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001689 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001690
1691 status = psa_copy_key_material_into_slot(
1692 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001693 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001694
1695 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1696 {
1697 /* Key registration only makes sense with a secure element. */
1698 return( PSA_ERROR_INVALID_ARGUMENT );
1699 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001700#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1701
Ronald Cronc4d1b512020-07-31 11:26:37 +02001702 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001703}
Gilles Peskine4747d192019-04-17 15:05:45 +02001704
1705/** Finalize the creation of a key once its key material has been set.
1706 *
1707 * This entails writing the key to persistent storage.
1708 *
1709 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001710 * See the documentation of psa_start_key_creation() for the intended use
1711 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001712 *
Ronald Cron5c522922020-11-14 16:35:34 +01001713 * If the finalization succeeds, the function unlocks the key slot (it was
1714 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1715 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001716 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001717 * \param[in,out] slot Pointer to the slot with key material.
1718 * \param[in] driver The secure element driver for the key,
1719 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001720 * \param[out] key On success, identifier of the key. Note that the
1721 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001722 *
1723 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001724 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001725 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1726 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1727 * \retval #PSA_ERROR_ALREADY_EXISTS
1728 * \retval #PSA_ERROR_DATA_INVALID
1729 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001730 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001731 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001732 * \return If this function fails, the key slot is an invalid state.
1733 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001734 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001735static psa_status_t psa_finish_key_creation(
1736 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001737 psa_se_drv_table_entry_t *driver,
1738 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001739{
1740 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001741 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001742 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001743
1744#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001745 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001746 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001747#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1748 if( driver != NULL )
1749 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001750 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001751 psa_key_slot_number_t slot_number =
1752 psa_key_slot_get_slot_number( slot ) ;
1753
Gilles Peskineb46bef22019-07-30 21:32:04 +02001754#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001755 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001756 sizeof( data.slot_number ),
1757 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001758#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001759 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001760 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001761 (uint8_t*) &data,
1762 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001763 }
1764 else
1765#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1766 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001767 /* Key material is saved in export representation in the slot, so
1768 * just pass the slot buffer for storage. */
1769 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001770 slot->key.data,
1771 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001772 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001774#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1775
Gilles Peskinecbaff462019-07-12 23:46:04 +02001776#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001777 /* Finish the transaction for a key creation. This does not
1778 * happen when registering an existing key. Detect this case
1779 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001780 * creation of a persistent key in a secure element requires a transaction,
1781 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001782 if( driver != NULL &&
1783 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001784 {
1785 status = psa_save_se_persistent_data( driver );
1786 if( status != PSA_SUCCESS )
1787 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001788 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001789 return( status );
1790 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001791 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001792 }
1793#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1794
Ronald Cron50972942020-11-14 11:28:25 +01001795 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001796 {
1797 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001798 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001799 if( status != PSA_SUCCESS )
1800 *key = MBEDTLS_SVC_KEY_ID_INIT;
1801 }
Ronald Cron50972942020-11-14 11:28:25 +01001802
Gilles Peskine4747d192019-04-17 15:05:45 +02001803 return( status );
1804}
1805
1806/** Abort the creation of a key.
1807 *
1808 * You may call this function after calling psa_start_key_creation(),
1809 * or after psa_finish_key_creation() fails. In other circumstances, this
1810 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001811 * See the documentation of psa_start_key_creation() for the intended use
1812 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001813 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001814 * \param[in,out] slot Pointer to the slot with key material.
1815 * \param[in] driver The secure element driver for the key,
1816 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001817 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001818static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001819 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001820{
Gilles Peskine011e4282019-06-26 18:34:38 +02001821 (void) driver;
1822
Gilles Peskine4747d192019-04-17 15:05:45 +02001823 if( slot == NULL )
1824 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001825
1826#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001827 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001828 * element, and the failure happened later (when saving metadata
1829 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001830 * element.
1831 * https://github.com/ARMmbed/mbed-crypto/issues/217
1832 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001833
Gilles Peskined7729582019-08-05 15:55:54 +02001834 /* Abort the ongoing transaction if any (there may not be one if
1835 * the creation process failed before starting one, or if the
1836 * key creation is a registration of a key in a secure element).
1837 * Earlier functions must already have done what it takes to undo any
1838 * partial creation. All that's left is to update the transaction data
1839 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001840 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001841#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1842
Gilles Peskine4747d192019-04-17 15:05:45 +02001843 psa_wipe_key_slot( slot );
1844}
1845
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001846/** Validate optional attributes during key creation.
1847 *
1848 * Some key attributes are optional during key creation. If they are
1849 * specified in the attributes structure, check that they are consistent
1850 * with the data in the slot.
1851 *
1852 * This function should be called near the end of key creation, after
1853 * the slot in memory is fully populated but before saving persistent data.
1854 */
1855static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001856 const psa_key_slot_t *slot,
1857 const psa_key_attributes_t *attributes )
1858{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001859 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001861 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001862 return( PSA_ERROR_INVALID_ARGUMENT );
1863 }
1864
1865 if( attributes->domain_parameters_size != 0 )
1866 {
John Durkop0e005192020-10-31 22:06:54 -07001867#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1868 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001869 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001870 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001871 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001872 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001874
Ronald Cron90857082020-11-25 14:58:33 +01001875 psa_status_t status = mbedtls_psa_rsa_load_representation(
1876 slot->attr.type,
1877 slot->key.data,
1878 slot->key.bytes,
1879 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001880 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001881 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001882
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001883 mbedtls_mpi_init( &actual );
1884 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001885 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001887 mbedtls_rsa_free( rsa );
1888 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001889 if( ret != 0 )
1890 goto rsa_exit;
1891 ret = mbedtls_mpi_read_binary( &required,
1892 attributes->domain_parameters,
1893 attributes->domain_parameters_size );
1894 if( ret != 0 )
1895 goto rsa_exit;
1896 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1897 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1898 rsa_exit:
1899 mbedtls_mpi_free( &actual );
1900 mbedtls_mpi_free( &required );
1901 if( ret != 0)
1902 return( mbedtls_to_psa_error( ret ) );
1903 }
1904 else
John Durkop9814fa22020-11-04 12:28:15 -08001905#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1906 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 {
1908 return( PSA_ERROR_INVALID_ARGUMENT );
1909 }
1910 }
1911
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001912 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001913 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001914 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001915 return( PSA_ERROR_INVALID_ARGUMENT );
1916 }
1917
1918 return( PSA_SUCCESS );
1919}
1920
Gilles Peskine4747d192019-04-17 15:05:45 +02001921psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001922 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001923 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001924 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001925{
1926 psa_status_t status;
1927 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001928 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001929 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001930
Ronald Cron81709fc2020-11-14 12:10:32 +01001931 *key = MBEDTLS_SVC_KEY_ID_INIT;
1932
Gilles Peskine0f84d622019-09-12 19:03:13 +02001933 /* Reject zero-length symmetric keys (including raw data key objects).
1934 * This also rejects any key which might be encoded as an empty string,
1935 * which is never valid. */
1936 if( data_length == 0 )
1937 return( PSA_ERROR_INVALID_ARGUMENT );
1938
Gilles Peskinedf179142019-07-15 22:02:14 +02001939 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001940 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001941 if( status != PSA_SUCCESS )
1942 goto exit;
1943
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001944 /* In the case of a transparent key or an opaque key stored in local
1945 * storage (thus not in the case of generating a key in a secure element
1946 * or cryptoprocessor with storage), we have to allocate a buffer to
1947 * hold the generated key material. */
1948 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001949 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001950 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001951 if( status != PSA_SUCCESS )
1952 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001953 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001954
1955 bits = slot->attr.bits;
1956 status = psa_driver_wrapper_import_key( attributes,
1957 data, data_length,
1958 slot->key.data,
1959 slot->key.bytes,
1960 &slot->key.bytes, &bits );
1961 if( status != PSA_SUCCESS )
1962 goto exit;
1963
1964 if( slot->attr.bits == 0 )
1965 slot->attr.bits = (psa_key_bits_t) bits;
1966 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001967 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001968 status = PSA_ERROR_INVALID_ARGUMENT;
1969 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001970 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001971
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001972 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001973 if( status != PSA_SUCCESS )
1974 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001975
Ronald Cron81709fc2020-11-14 12:10:32 +01001976 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001977exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001978 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001979 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001980
Gilles Peskine4747d192019-04-17 15:05:45 +02001981 return( status );
1982}
1983
Gilles Peskined7729582019-08-05 15:55:54 +02001984#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1985psa_status_t mbedtls_psa_register_se_key(
1986 const psa_key_attributes_t *attributes )
1987{
1988 psa_status_t status;
1989 psa_key_slot_t *slot = NULL;
1990 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001991 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001992
1993 /* Leaving attributes unspecified is not currently supported.
1994 * It could make sense to query the key type and size from the
1995 * secure element, but not all secure elements support this
1996 * and the driver HAL doesn't currently support it. */
1997 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1998 return( PSA_ERROR_NOT_SUPPORTED );
1999 if( psa_get_key_bits( attributes ) == 0 )
2000 return( PSA_ERROR_NOT_SUPPORTED );
2001
2002 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002003 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002004 if( status != PSA_SUCCESS )
2005 goto exit;
2006
Ronald Cron81709fc2020-11-14 12:10:32 +01002007 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002008
2009exit:
2010 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002011 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002012
Gilles Peskined7729582019-08-05 15:55:54 +02002013 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002014 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002015 return( status );
2016}
2017#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2018
Gilles Peskinef603c712019-01-19 13:40:11 +01002019static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002021{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002022 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002023 source->key.data,
2024 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002025 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002026 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002027
Steven Cooreman398aee52020-10-13 14:35:45 +02002028 target->attr.type = source->attr.type;
2029 target->attr.bits = source->attr.bits;
2030
2031 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002032}
2033
Ronald Croncf56a0a2020-08-04 09:51:30 +02002034psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002035 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002036 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002037{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002039 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002040 psa_key_slot_t *source_slot = NULL;
2041 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002042 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002043 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002044
Ronald Cron81709fc2020-11-14 12:10:32 +01002045 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2046
Ronald Cron5c522922020-11-14 16:35:34 +01002047 status = psa_get_and_lock_transparent_key_slot_with_policy(
2048 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002049 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002050 goto exit;
2051
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002052 status = psa_validate_optional_attributes( source_slot,
2053 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002054 if( status != PSA_SUCCESS )
2055 goto exit;
2056
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002057 status = psa_restrict_key_policy( source_slot->attr.type,
2058 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002059 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002060 if( status != PSA_SUCCESS )
2061 goto exit;
2062
Ronald Cron81709fc2020-11-14 12:10:32 +01002063 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2064 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002065 if( status != PSA_SUCCESS )
2066 goto exit;
2067
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002068#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2069 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002070 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002071 /* Copying to a secure element is not implemented yet. */
2072 status = PSA_ERROR_NOT_SUPPORTED;
2073 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002074 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002075#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002076
Ronald Cron6cc66312021-04-02 12:27:47 +02002077 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2078 {
2079 /*
2080 * Copying through an opaque driver is not implemented yet, consider
2081 * a lifetime with an external location as an invalid parameter for
2082 * now.
2083 */
2084 status = PSA_ERROR_INVALID_ARGUMENT;
2085 goto exit;
2086 }
2087
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002088 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002089 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002090 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002091
Ronald Cron81709fc2020-11-14 12:10:32 +01002092 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002093exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002095 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002096
Ronald Cron5c522922020-11-14 16:35:34 +01002097 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002098
Ronald Cron5c522922020-11-14 16:35:34 +01002099 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002100}
2101
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002102
2103
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002104/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002105/* Message digests */
2106/****************************************************************/
2107
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002108psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2109{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002110 /* Aborting a non-active operation is allowed */
2111 if( operation->id == 0 )
2112 return( PSA_SUCCESS );
2113
2114 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2115 operation->id = 0;
2116
2117 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002118}
2119
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002120psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002121 psa_algorithm_t alg )
2122{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002123 /* A context must be freshly initialized before it can be set up. */
2124 if( operation->id != 0 )
2125 return( PSA_ERROR_BAD_STATE );
2126
2127 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002128 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002129
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002130 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2131 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002132 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2133
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002134 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002135}
2136
2137psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2138 const uint8_t *input,
2139 size_t input_length )
2140{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002141 if( operation->id == 0 )
2142 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002143
Steven Cooremanc8288352021-03-04 14:02:19 +01002144 /* Don't require hash implementations to behave correctly on a
2145 * zero-length input, which may have an invalid pointer. */
2146 if( input_length == 0 )
2147 return( PSA_SUCCESS );
2148
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002149 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2150 input, input_length );
2151 if( status != PSA_SUCCESS )
2152 psa_hash_abort( operation );
2153
2154 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155}
2156
2157psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2158 uint8_t *hash,
2159 size_t hash_size,
2160 size_t *hash_length )
2161{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002162 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163 if( operation->id == 0 )
2164 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002165
Steven Cooreman1e582352021-02-18 17:24:37 +01002166 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002167 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002168 psa_hash_abort( operation );
2169 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002170}
2171
Gilles Peskine2d277862018-06-18 15:41:12 +02002172psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2173 const uint8_t *hash,
2174 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002175{
2176 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2177 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002178 psa_status_t status = psa_hash_finish(
2179 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002180 actual_hash, sizeof( actual_hash ),
2181 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182 if( status != PSA_SUCCESS )
2183 return( status );
2184 if( actual_hash_length != hash_length )
2185 return( PSA_ERROR_INVALID_SIGNATURE );
2186 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2187 return( PSA_ERROR_INVALID_SIGNATURE );
2188 return( PSA_SUCCESS );
2189}
2190
Gilles Peskine0a749c82019-11-28 19:33:58 +01002191psa_status_t psa_hash_compute( psa_algorithm_t alg,
2192 const uint8_t *input, size_t input_length,
2193 uint8_t *hash, size_t hash_size,
2194 size_t *hash_length )
2195{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002196 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002197 if( !PSA_ALG_IS_HASH( alg ) )
2198 return( PSA_ERROR_INVALID_ARGUMENT );
2199
Steven Cooreman1e582352021-02-18 17:24:37 +01002200 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2201 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002202}
2203
2204psa_status_t psa_hash_compare( psa_algorithm_t alg,
2205 const uint8_t *input, size_t input_length,
2206 const uint8_t *hash, size_t hash_length )
2207{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002208 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2209 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002210
2211 if( !PSA_ALG_IS_HASH( alg ) )
2212 return( PSA_ERROR_INVALID_ARGUMENT );
2213
Steven Cooreman1e582352021-02-18 17:24:37 +01002214 psa_status_t status = psa_driver_wrapper_hash_compute(
2215 alg, input, input_length,
2216 actual_hash, sizeof(actual_hash),
2217 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002218 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002219 return( status );
2220 if( actual_hash_length != hash_length )
2221 return( PSA_ERROR_INVALID_SIGNATURE );
2222 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2223 return( PSA_ERROR_INVALID_SIGNATURE );
2224 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002225}
2226
Gilles Peskineeb35d782019-01-22 17:56:16 +01002227psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2228 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002229{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002230 if( source_operation->id == 0 ||
2231 target_operation->id != 0 )
2232 {
2233 return( PSA_ERROR_BAD_STATE );
2234 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002235
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002236 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2237 target_operation );
2238 if( status != PSA_SUCCESS )
2239 psa_hash_abort( target_operation );
2240
2241 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002242}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002243
2244
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002246/* MAC */
2247/****************************************************************/
2248
John Durkop6ba40d12020-11-10 08:50:04 -08002249#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002250static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002251{
Gilles Peskine2d277862018-06-18 15:41:12 +02002252 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002253 {
2254 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002255 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002256 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002257 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002258 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002259 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002260 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002261 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002262 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002263 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002264 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002265 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002266 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002267 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002268 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002269 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002270 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002271 return( 128 );
2272 default:
2273 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002274 }
2275}
John Durkop07cc04a2020-11-16 22:08:34 -08002276#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002277
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002278/* Initialize the MAC operation structure. Once this function has been
2279 * called, psa_mac_abort can run and will do the right thing. */
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002280static psa_status_t psa_mac_init( mbedtls_psa_mac_operation_t *operation,
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002281 psa_algorithm_t alg )
2282{
2283 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2284
Steven Cooreman15472f82021-03-02 16:16:22 +01002285 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002286 operation->key_set = 0;
2287 operation->iv_set = 0;
2288 operation->iv_required = 0;
2289 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002290 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002291
Ronald Cron3d471812021-03-18 13:40:31 +01002292#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002293 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002294 {
2295 operation->iv_required = 0;
2296 mbedtls_cipher_init( &operation->ctx.cmac );
2297 status = PSA_SUCCESS;
2298 }
2299 else
Ronald Cron3d471812021-03-18 13:40:31 +01002300#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002301#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002302 if( PSA_ALG_IS_HMAC( operation->alg ) )
2303 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002304 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002305 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002306 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002307 }
2308 else
John Durkopd0321952020-10-29 21:37:36 -07002309#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002310 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002311 if( ! PSA_ALG_IS_MAC( alg ) )
2312 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002313 }
2314
2315 if( status != PSA_SUCCESS )
2316 memset( operation, 0, sizeof( *operation ) );
2317 return( status );
2318}
2319
John Durkop6ba40d12020-11-10 08:50:04 -08002320#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002321static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2322{
Gilles Peskine3f108122018-12-07 18:14:53 +01002323 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002324 return( psa_hash_abort( &hmac->hash_ctx ) );
2325}
John Durkop6ba40d12020-11-10 08:50:04 -08002326#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002327
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002328psa_status_t psa_mac_abort( psa_mac_operation_t *psa_operation )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002329{
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002330 /* Temporary recast to avoid changing a lot of lines */
2331 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2332
Gilles Peskinefbfac682018-07-08 20:51:54 +02002333 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002334 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002335 /* The object has (apparently) been initialized but it is not
2336 * in use. It's ok to call abort on such an object, and there's
2337 * nothing to do. */
2338 return( PSA_SUCCESS );
2339 }
2340 else
Ronald Cron3d471812021-03-18 13:40:31 +01002341#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002342 if( operation->alg == PSA_ALG_CMAC )
2343 {
2344 mbedtls_cipher_free( &operation->ctx.cmac );
2345 }
2346 else
Ronald Cron3d471812021-03-18 13:40:31 +01002347#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002348#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002349 if( PSA_ALG_IS_HMAC( operation->alg ) )
2350 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002351 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002352 }
2353 else
John Durkopd0321952020-10-29 21:37:36 -07002354#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002355 {
2356 /* Sanity check (shouldn't happen: operation->alg should
2357 * always have been initialized to a valid value). */
2358 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002359 }
Moran Peker41deec42018-04-04 15:43:05 +03002360
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361 operation->alg = 0;
2362 operation->key_set = 0;
2363 operation->iv_set = 0;
2364 operation->iv_required = 0;
2365 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002366 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002367
Gilles Peskine8c9def32018-02-08 10:02:12 +01002368 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002369
2370bad_state:
2371 /* If abort is called on an uninitialized object, we can't trust
2372 * anything. Wipe the object in case it contains confidential data.
2373 * This may result in a memory leak if a pointer gets overwritten,
2374 * but it's too late to do anything about this. */
2375 memset( operation, 0, sizeof( *operation ) );
2376 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002377}
2378
Ronald Cron3d471812021-03-18 13:40:31 +01002379#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002380static psa_status_t psa_cmac_setup( mbedtls_psa_mac_operation_t *operation,
Steven Cooreman15472f82021-03-02 16:16:22 +01002381 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002382{
Janos Follath24eed8d2019-11-22 13:21:35 +00002383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002384 const mbedtls_cipher_info_t *cipher_info =
2385 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2386 slot->attr.type, slot->attr.bits,
2387 NULL );
2388 if( cipher_info == NULL )
2389 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002390
2391 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2392 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002393 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002394
2395 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002396 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002397 slot->attr.bits );
2398exit:
2399 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002400}
Ronald Cron3d471812021-03-18 13:40:31 +01002401#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002402
John Durkop6ba40d12020-11-10 08:50:04 -08002403#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002404static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2405 const uint8_t *key,
2406 size_t key_length,
2407 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002408{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002409 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002410 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002411 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002412 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002413 psa_status_t status;
2414
Steven Cooreman0e307642021-02-18 16:18:32 +01002415 hmac->alg = hash_alg;
2416
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002417 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2418 * overflow below. This should never trigger if the hash algorithm
2419 * is implemented correctly. */
2420 /* The size checks against the ipad and opad buffers cannot be written
2421 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2422 * because that triggers -Wlogical-op on GCC 7.3. */
2423 if( block_size > sizeof( ipad ) )
2424 return( PSA_ERROR_NOT_SUPPORTED );
2425 if( block_size > sizeof( hmac->opad ) )
2426 return( PSA_ERROR_NOT_SUPPORTED );
2427 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002428 return( PSA_ERROR_NOT_SUPPORTED );
2429
Gilles Peskined223b522018-06-11 18:12:58 +02002430 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002431 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002432 status = psa_hash_compute( hash_alg, key, key_length,
2433 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002434 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002435 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002436 }
Gilles Peskine96889972018-07-12 17:07:03 +02002437 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2438 * but it is permitted. It is common when HMAC is used in HKDF, for
2439 * example. Don't call `memcpy` in the 0-length because `key` could be
2440 * an invalid pointer which would make the behavior undefined. */
2441 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002442 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002443
Gilles Peskined223b522018-06-11 18:12:58 +02002444 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2445 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002446 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002447 ipad[i] ^= 0x36;
2448 memset( ipad + key_length, 0x36, block_size - key_length );
2449
2450 /* Copy the key material from ipad to opad, flipping the requisite bits,
2451 * and filling the rest of opad with the requisite constant. */
2452 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002453 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2454 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002455
Gilles Peskine01126fa2018-07-12 17:04:55 +02002456 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002457 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002458 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002459
Gilles Peskine01126fa2018-07-12 17:04:55 +02002460 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002461
2462cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002463 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002464
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002465 return( status );
2466}
John Durkop6ba40d12020-11-10 08:50:04 -08002467#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002468
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002469static psa_status_t psa_mac_setup( psa_mac_operation_t *psa_operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002470 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002471 psa_algorithm_t alg,
2472 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002473{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002474 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002475 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002476 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002477 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002478 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002479
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002480 /* Temporary recast to avoid changing a lot of lines */
2481 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2482
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002483 /* A context must be freshly initialized before it can be set up. */
2484 if( operation->alg != 0 )
2485 {
2486 return( PSA_ERROR_BAD_STATE );
2487 }
2488
Steven Cooreman15472f82021-03-02 16:16:22 +01002489 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002490 if( status != PSA_SUCCESS )
2491 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002492 if( is_sign )
2493 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002494
Ronald Cron5c522922020-11-14 16:35:34 +01002495 status = psa_get_and_lock_transparent_key_slot_with_policy(
2496 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002497 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002498 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002499
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002500 /* Validate the combination of key type and algorithm */
2501 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002502 if( status != PSA_SUCCESS )
2503 goto exit;
2504
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002505 /* Get the output length for the algorithm and key combination. None of the
2506 * currently supported algorithms have an output length dependent on actual
2507 * key size, so setting it to a bogus value is currently OK. */
2508 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002509
2510 if( operation->mac_size < 4 )
2511 {
2512 /* A very short MAC is too short for security since it can be
2513 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2514 * so we make this our minimum, even though 32 bits is still
2515 * too small for security. */
2516 status = PSA_ERROR_NOT_SUPPORTED;
2517 goto exit;
2518 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002519
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002520 if( operation->mac_size >
2521 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2522 {
2523 /* It's impossible to "truncate" to a larger length than the full length
2524 * of the algorithm. */
2525 status = PSA_ERROR_INVALID_ARGUMENT;
2526 goto exit;
2527 }
2528
Ronald Cron3d471812021-03-18 13:40:31 +01002529#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002530 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002531 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002532 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002533 }
2534 else
Ronald Cron3d471812021-03-18 13:40:31 +01002535#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002536#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002537 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002538 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002539 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002540 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002541 {
2542 status = PSA_ERROR_NOT_SUPPORTED;
2543 goto exit;
2544 }
2545
Gilles Peskine8e338702019-07-30 20:06:31 +02002546 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002547 {
2548 status = PSA_ERROR_INVALID_ARGUMENT;
2549 goto exit;
2550 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002551
Gilles Peskine01126fa2018-07-12 17:04:55 +02002552 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002553 slot->key.data,
2554 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002555 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002556 }
2557 else
John Durkopd0321952020-10-29 21:37:36 -07002558#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002559 {
2560 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002562
Gilles Peskinefbfac682018-07-08 20:51:54 +02002563exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002564 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002565 {
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002566 psa_mac_abort( psa_operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002567 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002568 else
2569 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002570 operation->key_set = 1;
2571 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002572
Ronald Cron5c522922020-11-14 16:35:34 +01002573 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002574
Ronald Cron5c522922020-11-14 16:35:34 +01002575 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002576}
2577
Gilles Peskine89167cb2018-07-08 20:12:23 +02002578psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002579 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002580 psa_algorithm_t alg )
2581{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002582 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002583}
2584
2585psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002586 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002587 psa_algorithm_t alg )
2588{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002589 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002590}
2591
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002592psa_status_t psa_mac_update( psa_mac_operation_t *psa_operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002593 const uint8_t *input,
2594 size_t input_length )
2595{
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002596 /* Temporary recast to avoid changing a lot of lines */
2597 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2598
Gilles Peskinefbfac682018-07-08 20:51:54 +02002599 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002600 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002601 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002602 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002603 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002604 operation->has_input = 1;
2605
Ronald Cron3d471812021-03-18 13:40:31 +01002606#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002607 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002608 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002609 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2610 input, input_length );
2611 status = mbedtls_to_psa_error( ret );
2612 }
2613 else
Ronald Cron3d471812021-03-18 13:40:31 +01002614#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002615#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002616 if( PSA_ALG_IS_HMAC( operation->alg ) )
2617 {
2618 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2619 input_length );
2620 }
2621 else
John Durkopd0321952020-10-29 21:37:36 -07002622#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002623 {
2624 /* This shouldn't happen if `operation` was initialized by
2625 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002626 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002627 }
2628
Gilles Peskinefbfac682018-07-08 20:51:54 +02002629 if( status != PSA_SUCCESS )
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002630 psa_mac_abort( psa_operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002631 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002632}
2633
John Durkop6ba40d12020-11-10 08:50:04 -08002634#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002635static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2636 uint8_t *mac,
2637 size_t mac_size )
2638{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002639 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002640 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002641 size_t hash_size = 0;
2642 size_t block_size = psa_get_hash_block_size( hash_alg );
2643 psa_status_t status;
2644
Gilles Peskine01126fa2018-07-12 17:04:55 +02002645 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2646 if( status != PSA_SUCCESS )
2647 return( status );
2648 /* From here on, tmp needs to be wiped. */
2649
2650 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2651 if( status != PSA_SUCCESS )
2652 goto exit;
2653
2654 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2655 if( status != PSA_SUCCESS )
2656 goto exit;
2657
2658 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2659 if( status != PSA_SUCCESS )
2660 goto exit;
2661
Gilles Peskined911eb72018-08-14 15:18:45 +02002662 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2663 if( status != PSA_SUCCESS )
2664 goto exit;
2665
2666 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002667
2668exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002669 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002670 return( status );
2671}
John Durkop6ba40d12020-11-10 08:50:04 -08002672#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002673
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002674static psa_status_t psa_mac_finish_internal( mbedtls_psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002675 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002676 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002677{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002678 if( ! operation->key_set )
2679 return( PSA_ERROR_BAD_STATE );
2680 if( operation->iv_required && ! operation->iv_set )
2681 return( PSA_ERROR_BAD_STATE );
2682
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683 if( mac_size < operation->mac_size )
2684 return( PSA_ERROR_BUFFER_TOO_SMALL );
2685
Ronald Cron3d471812021-03-18 13:40:31 +01002686#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002687 if( operation->alg == PSA_ALG_CMAC )
2688 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002689 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002690 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2691 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002692 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002693 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002694 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002695 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002696 else
Ronald Cron3d471812021-03-18 13:40:31 +01002697#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002698#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002699 if( PSA_ALG_IS_HMAC( operation->alg ) )
2700 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002701 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002702 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002703 }
2704 else
John Durkopd0321952020-10-29 21:37:36 -07002705#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002706 {
2707 /* This shouldn't happen if `operation` was initialized by
2708 * a setup function. */
2709 return( PSA_ERROR_BAD_STATE );
2710 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002711}
2712
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002713psa_status_t psa_mac_sign_finish( psa_mac_operation_t *psa_operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002714 uint8_t *mac,
2715 size_t mac_size,
2716 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002717{
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002718 /* Temporary recast to avoid changing a lot of lines */
2719 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2720
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002721 psa_status_t status;
2722
Jaeden Amero252ef282019-02-15 14:05:35 +00002723 if( operation->alg == 0 )
2724 {
2725 return( PSA_ERROR_BAD_STATE );
2726 }
2727
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002728 /* Fill the output buffer with something that isn't a valid mac
2729 * (barring an attack on the mac and deliberately-crafted input),
2730 * in case the caller doesn't check the return status properly. */
2731 *mac_length = mac_size;
2732 /* If mac_size is 0 then mac may be NULL and then the
2733 * call to memset would have undefined behavior. */
2734 if( mac_size != 0 )
2735 memset( mac, '!', mac_size );
2736
Gilles Peskine89167cb2018-07-08 20:12:23 +02002737 if( ! operation->is_sign )
2738 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002739 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002740 }
mohammad16036df908f2018-04-02 08:34:15 -07002741
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002742 status = psa_mac_finish_internal( operation, mac, mac_size );
2743
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002744 if( status == PSA_SUCCESS )
2745 {
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002746 status = psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002747 if( status == PSA_SUCCESS )
2748 *mac_length = operation->mac_size;
2749 else
2750 memset( mac, '!', mac_size );
2751 }
2752 else
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002753 psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002754 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002755}
2756
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002757psa_status_t psa_mac_verify_finish( psa_mac_operation_t *psa_operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002758 const uint8_t *mac,
2759 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002760{
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002761 /* Temporary recast to avoid changing a lot of lines */
2762 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2763
Gilles Peskine828ed142018-06-18 23:25:51 +02002764 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002765 psa_status_t status;
2766
Jaeden Amero252ef282019-02-15 14:05:35 +00002767 if( operation->alg == 0 )
2768 {
2769 return( PSA_ERROR_BAD_STATE );
2770 }
2771
Gilles Peskine89167cb2018-07-08 20:12:23 +02002772 if( operation->is_sign )
2773 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002774 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002775 }
2776 if( operation->mac_size != mac_length )
2777 {
2778 status = PSA_ERROR_INVALID_SIGNATURE;
2779 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002780 }
mohammad16036df908f2018-04-02 08:34:15 -07002781
2782 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002783 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002784 if( status != PSA_SUCCESS )
2785 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002786
2787 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2788 status = PSA_ERROR_INVALID_SIGNATURE;
2789
2790cleanup:
2791 if( status == PSA_SUCCESS )
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002792 status = psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002793 else
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002794 psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002795
Gilles Peskine3f108122018-12-07 18:14:53 +01002796 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002797
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002798 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799}
2800
2801
Gilles Peskine20035e32018-02-03 22:44:14 +01002802
Gilles Peskine20035e32018-02-03 22:44:14 +01002803/****************************************************************/
2804/* Asymmetric cryptography */
2805/****************************************************************/
2806
Ronald Cron67b1eb32020-12-08 17:37:27 +01002807psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002808 const psa_key_attributes_t *attributes,
2809 const uint8_t *key_buffer, size_t key_buffer_size,
2810 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2811 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002812{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002813 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002814 {
Ronald Cron4501c982021-03-19 20:09:32 +01002815 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2816 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002817 {
Ronald Cron4501c982021-03-19 20:09:32 +01002818#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2819 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2820 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002821 attributes,
2822 key_buffer, key_buffer_size,
2823 alg, hash, hash_length,
2824 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002825#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2826 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002827 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002828 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002829 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002830 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002831 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002832 }
2833 else
Ronald Cron4501c982021-03-19 20:09:32 +01002834 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2835 {
2836 if( PSA_ALG_IS_ECDSA( alg ) )
2837 {
2838#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2839 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2840 return( mbedtls_psa_ecdsa_sign_hash(
2841 attributes,
2842 key_buffer, key_buffer_size,
2843 alg, hash, hash_length,
2844 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002845#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2846 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002847 }
2848 else
2849 {
2850 return( PSA_ERROR_INVALID_ARGUMENT );
2851 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002852 }
Ronald Cron4501c982021-03-19 20:09:32 +01002853
2854 (void)key_buffer;
2855 (void)key_buffer_size;
2856 (void)hash;
2857 (void)hash_length;
2858 (void)signature;
2859 (void)signature_size;
2860 (void)signature_length;
2861
2862 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002863}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002864
2865psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2866 psa_algorithm_t alg,
2867 const uint8_t *hash,
2868 size_t hash_length,
2869 uint8_t *signature,
2870 size_t signature_size,
2871 size_t *signature_length )
2872{
2873 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2874 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2875 psa_key_slot_t *slot;
2876
2877 *signature_length = signature_size;
2878 /* Immediately reject a zero-length signature buffer. This guarantees
2879 * that signature must be a valid pointer. (On the other hand, the hash
2880 * buffer can in principle be empty since it doesn't actually have
2881 * to be a hash.) */
2882 if( signature_size == 0 )
2883 return( PSA_ERROR_BUFFER_TOO_SMALL );
2884
2885 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
2886 PSA_KEY_USAGE_SIGN_HASH,
2887 alg );
2888 if( status != PSA_SUCCESS )
2889 goto exit;
2890 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2891 {
2892 status = PSA_ERROR_INVALID_ARGUMENT;
2893 goto exit;
2894 }
2895
Ronald Cron9f17aa42020-12-08 17:07:25 +01002896 psa_key_attributes_t attributes = {
2897 .core = slot->attr
2898 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002899
Ronald Cron9f17aa42020-12-08 17:07:25 +01002900 status = psa_driver_wrapper_sign_hash(
2901 &attributes, slot->key.data, slot->key.bytes,
2902 alg, hash, hash_length,
2903 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002904
2905exit:
2906 /* Fill the unused part of the output buffer (the whole buffer on error,
2907 * the trailing part on success) with something that isn't a valid mac
2908 * (barring an attack on the mac and deliberately-crafted input),
2909 * in case the caller doesn't check the return status properly. */
2910 if( status == PSA_SUCCESS )
2911 memset( signature + *signature_length, '!',
2912 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02002913 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002914 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002915 /* If signature_size is 0 then we have nothing to do. We must not call
2916 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02002917
Ronald Cron5c522922020-11-14 16:35:34 +01002918 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002919
Ronald Cron5c522922020-11-14 16:35:34 +01002920 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03002921}
2922
Ronald Cron67b1eb32020-12-08 17:37:27 +01002923psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002924 const psa_key_attributes_t *attributes,
2925 const uint8_t *key_buffer, size_t key_buffer_size,
2926 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2927 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002928{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002929 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002930 {
Ronald Cron4501c982021-03-19 20:09:32 +01002931 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2932 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002933 {
Ronald Cron4501c982021-03-19 20:09:32 +01002934#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2935 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2936 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002937 attributes,
2938 key_buffer, key_buffer_size,
2939 alg, hash, hash_length,
2940 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002941#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2942 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002943 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002944 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002945 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002946 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002947 }
itayzafrir5c753392018-05-08 11:18:38 +03002948 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002949 else
Ronald Cron4501c982021-03-19 20:09:32 +01002950 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002951 {
Ronald Cron4501c982021-03-19 20:09:32 +01002952 if( PSA_ALG_IS_ECDSA( alg ) )
2953 {
2954#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2955 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2956 return( mbedtls_psa_ecdsa_verify_hash(
2957 attributes,
2958 key_buffer, key_buffer_size,
2959 alg, hash, hash_length,
2960 signature, signature_length ) );
2961#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2962 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2963 }
2964 else
2965 {
2966 return( PSA_ERROR_INVALID_ARGUMENT );
2967 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002968 }
Ronald Cron4501c982021-03-19 20:09:32 +01002969
2970 (void)key_buffer;
2971 (void)key_buffer_size;
2972 (void)hash;
2973 (void)hash_length;
2974 (void)signature;
2975 (void)signature_length;
2976
2977 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002978}
2979
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002980psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2981 psa_algorithm_t alg,
2982 const uint8_t *hash,
2983 size_t hash_length,
2984 const uint8_t *signature,
2985 size_t signature_length )
2986{
2987 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2988 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03002989 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002990
2991 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002992 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02002993 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002994 if( status != PSA_SUCCESS )
2995 return( status );
2996
Ronald Cron9f17aa42020-12-08 17:07:25 +01002997 psa_key_attributes_t attributes = {
2998 .core = slot->attr
2999 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003000
Ronald Cron9f17aa42020-12-08 17:07:25 +01003001 status = psa_driver_wrapper_verify_hash(
3002 &attributes, slot->key.data, slot->key.bytes,
3003 alg, hash, hash_length,
3004 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003005
Ronald Cron5c522922020-11-14 16:35:34 +01003006 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003007
Ronald Cron5c522922020-11-14 16:35:34 +01003008 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003009}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003010
John Durkop0e005192020-10-31 22:06:54 -07003011#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003012static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3013 mbedtls_rsa_context *rsa )
3014{
3015 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3016 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3017 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3018 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3019}
John Durkop0e005192020-10-31 22:06:54 -07003020#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003021
Ronald Croncf56a0a2020-08-04 09:51:30 +02003022psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003023 psa_algorithm_t alg,
3024 const uint8_t *input,
3025 size_t input_length,
3026 const uint8_t *salt,
3027 size_t salt_length,
3028 uint8_t *output,
3029 size_t output_size,
3030 size_t *output_length )
3031{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003033 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003034 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003035
Darryl Green5cc689a2018-07-24 15:34:10 +01003036 (void) input;
3037 (void) input_length;
3038 (void) salt;
3039 (void) output;
3040 (void) output_size;
3041
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003042 *output_length = 0;
3043
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003044 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3045 return( PSA_ERROR_INVALID_ARGUMENT );
3046
Ronald Cron5c522922020-11-14 16:35:34 +01003047 status = psa_get_and_lock_transparent_key_slot_with_policy(
3048 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003049 if( status != PSA_SUCCESS )
3050 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003051 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3052 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003053 {
3054 status = PSA_ERROR_INVALID_ARGUMENT;
3055 goto exit;
3056 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003057
John Durkop6ba40d12020-11-10 08:50:04 -08003058#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3059 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003060 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003061 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003062 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003063 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3064 slot->key.data,
3065 slot->key.bytes,
3066 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003067 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003068 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003069
3070 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003071 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003072 status = PSA_ERROR_BUFFER_TOO_SMALL;
3073 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003074 }
John Durkop0e005192020-10-31 22:06:54 -07003075#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003076 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3077 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003078 status = mbedtls_to_psa_error(
3079 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003080 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003081 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003082 MBEDTLS_RSA_PUBLIC,
3083 input_length,
3084 input,
3085 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003086 }
3087 else
John Durkop0e005192020-10-31 22:06:54 -07003088#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3089#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003090 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3091 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003092 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003093 status = mbedtls_to_psa_error(
3094 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003095 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003096 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003097 MBEDTLS_RSA_PUBLIC,
3098 salt, salt_length,
3099 input_length,
3100 input,
3101 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003102 }
3103 else
John Durkop0e005192020-10-31 22:06:54 -07003104#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003105 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003106 status = PSA_ERROR_INVALID_ARGUMENT;
3107 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003109rsa_exit:
3110 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003111 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003112
Steven Cooremana2371e52020-07-28 14:30:39 +02003113 mbedtls_rsa_free( rsa );
3114 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115 }
3116 else
John Durkop9814fa22020-11-04 12:28:15 -08003117#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003118 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003119 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003120 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003122
3123exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003124 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003125
Ronald Cron5c522922020-11-14 16:35:34 +01003126 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003127}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003128
Ronald Croncf56a0a2020-08-04 09:51:30 +02003129psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003130 psa_algorithm_t alg,
3131 const uint8_t *input,
3132 size_t input_length,
3133 const uint8_t *salt,
3134 size_t salt_length,
3135 uint8_t *output,
3136 size_t output_size,
3137 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003138{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003140 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003141 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003142
Darryl Green5cc689a2018-07-24 15:34:10 +01003143 (void) input;
3144 (void) input_length;
3145 (void) salt;
3146 (void) output;
3147 (void) output_size;
3148
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003149 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003150
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003151 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3152 return( PSA_ERROR_INVALID_ARGUMENT );
3153
Ronald Cron5c522922020-11-14 16:35:34 +01003154 status = psa_get_and_lock_transparent_key_slot_with_policy(
3155 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003156 if( status != PSA_SUCCESS )
3157 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003158 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003159 {
3160 status = PSA_ERROR_INVALID_ARGUMENT;
3161 goto exit;
3162 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003163
John Durkop6ba40d12020-11-10 08:50:04 -08003164#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3165 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003166 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003168 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003169 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3170 slot->key.data,
3171 slot->key.bytes,
3172 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003173 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003174 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003175
Steven Cooremana2371e52020-07-28 14:30:39 +02003176 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003177 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003178 status = PSA_ERROR_INVALID_ARGUMENT;
3179 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003180 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181
John Durkop0e005192020-10-31 22:06:54 -07003182#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003183 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003184 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003185 status = mbedtls_to_psa_error(
3186 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003187 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003188 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003189 MBEDTLS_RSA_PRIVATE,
3190 output_length,
3191 input,
3192 output,
3193 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003194 }
3195 else
John Durkop0e005192020-10-31 22:06:54 -07003196#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3197#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003198 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003199 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003200 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003201 status = mbedtls_to_psa_error(
3202 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003203 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003204 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003205 MBEDTLS_RSA_PRIVATE,
3206 salt, salt_length,
3207 output_length,
3208 input,
3209 output,
3210 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211 }
3212 else
John Durkop0e005192020-10-31 22:06:54 -07003213#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003215 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003216 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003217
Steven Cooreman4fed4552020-08-03 14:46:03 +02003218rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003219 mbedtls_rsa_free( rsa );
3220 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003221 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003222 else
John Durkop6ba40d12020-11-10 08:50:04 -08003223#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3224 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003225 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003226 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003227 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003228
3229exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003230 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003231
Ronald Cron5c522922020-11-14 16:35:34 +01003232 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003233}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003234
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003235
3236
mohammad1603503973b2018-03-12 15:59:30 +02003237/****************************************************************/
3238/* Symmetric cryptography */
3239/****************************************************************/
3240
Ronald Cronab99ac22020-10-01 16:38:28 +02003241static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3242 mbedtls_svc_key_id_t key,
3243 psa_algorithm_t alg,
3244 mbedtls_operation_t cipher_operation )
3245{
3246 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3247 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3248 psa_key_slot_t *slot;
3249 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3250 PSA_KEY_USAGE_ENCRYPT :
3251 PSA_KEY_USAGE_DECRYPT );
3252
3253 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003254 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003255 return( PSA_ERROR_BAD_STATE );
3256
3257 /* The requested algorithm must be one that can be processed by cipher. */
3258 if( ! PSA_ALG_IS_CIPHER( alg ) )
3259 return( PSA_ERROR_INVALID_ARGUMENT );
3260
3261 /* Fetch key material from key storage. */
3262 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3263 if( status != PSA_SUCCESS )
3264 goto exit;
3265
Ronald Cron49fafa92021-03-10 08:34:23 +01003266 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003267 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003268 * so we only set it (in the driver wrapper) after resources have been
3269 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003270 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003271 if( alg == PSA_ALG_ECB_NO_PADDING )
3272 operation->iv_required = 0;
3273 else
3274 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003275 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003276
Ronald Crona4af55f2020-12-14 14:36:06 +01003277 psa_key_attributes_t attributes = {
3278 .core = slot->attr
3279 };
3280
Ronald Cronab99ac22020-10-01 16:38:28 +02003281 /* Try doing the operation through a driver before using software fallback. */
3282 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003283 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3284 &attributes,
3285 slot->key.data,
3286 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003287 alg );
3288 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003289 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3290 &attributes,
3291 slot->key.data,
3292 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003293 alg );
3294
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003295exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003296 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003297 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003298
Ronald Cron5c522922020-11-14 16:35:34 +01003299 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003300
Ronald Cron5c522922020-11-14 16:35:34 +01003301 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003302}
3303
Gilles Peskinefe119512018-07-08 21:39:34 +02003304psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003305 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003306 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003307{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003308 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003309}
3310
Gilles Peskinefe119512018-07-08 21:39:34 +02003311psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003312 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003313 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003314{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003315 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003316}
3317
Gilles Peskinefe119512018-07-08 21:39:34 +02003318psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003319 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003320 size_t iv_size,
3321 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003322{
Ronald Cron6d051732020-10-01 14:10:20 +02003323 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003324
Ronald Cron5618a392021-03-26 09:52:26 +01003325 *iv_length = 0;
3326
Ronald Cron49fafa92021-03-10 08:34:23 +01003327 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003328 {
3329 return( PSA_ERROR_BAD_STATE );
3330 }
3331
Steven Cooreman7df02922020-09-09 15:28:49 +02003332 if( operation->iv_set || ! operation->iv_required )
3333 {
3334 return( PSA_ERROR_BAD_STATE );
3335 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003336
Ronald Cron5618a392021-03-26 09:52:26 +01003337 if( iv_size < operation->default_iv_length )
3338 {
3339 status = PSA_ERROR_BUFFER_TOO_SMALL;
3340 goto exit;
3341 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003342
Ronald Cron5618a392021-03-26 09:52:26 +01003343 status = psa_generate_random( iv, operation->default_iv_length );
3344 if( status != PSA_SUCCESS )
3345 goto exit;
3346
3347 status = psa_driver_wrapper_cipher_set_iv( operation,
3348 iv,
3349 operation->default_iv_length );
3350
3351exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003352 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003353 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003354 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003355 *iv_length = operation->default_iv_length;
3356 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003357 else
Moran Peker395db872018-05-31 14:07:14 +03003358 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003359
itayzafrir534bd7c2018-08-02 13:56:32 +03003360 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003361}
3362
Gilles Peskinefe119512018-07-08 21:39:34 +02003363psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003364 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003365 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003366{
Ronald Cron6d051732020-10-01 14:10:20 +02003367 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003368
Ronald Cron49fafa92021-03-10 08:34:23 +01003369 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003370 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003371
Steven Cooreman7df02922020-09-09 15:28:49 +02003372 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003373 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003374
3375 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3376 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003377
Ronald Crondd24c9b2020-12-15 14:10:01 +01003378 status = psa_driver_wrapper_cipher_set_iv( operation,
3379 iv,
3380 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003381
itayzafrir534bd7c2018-08-02 13:56:32 +03003382 if( status == PSA_SUCCESS )
3383 operation->iv_set = 1;
3384 else
mohammad1603503973b2018-03-12 15:59:30 +02003385 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003386 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003387}
3388
Gilles Peskinee553c652018-06-04 16:22:46 +02003389psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3390 const uint8_t *input,
3391 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003392 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003393 size_t output_size,
3394 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003395{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003397
Ronald Cron49fafa92021-03-10 08:34:23 +01003398 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003399 {
3400 return( PSA_ERROR_BAD_STATE );
3401 }
3402 if( operation->iv_required && ! operation->iv_set )
3403 {
3404 return( PSA_ERROR_BAD_STATE );
3405 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003406
Ronald Crondd24c9b2020-12-15 14:10:01 +01003407 status = psa_driver_wrapper_cipher_update( operation,
3408 input,
3409 input_length,
3410 output,
3411 output_size,
3412 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003413 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003414 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003415
itayzafrir534bd7c2018-08-02 13:56:32 +03003416 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003417}
3418
Gilles Peskinee553c652018-06-04 16:22:46 +02003419psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3420 uint8_t *output,
3421 size_t output_size,
3422 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003423{
David Saadab4ecc272019-02-14 13:48:10 +02003424 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003425
Ronald Cron49fafa92021-03-10 08:34:23 +01003426 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003427 {
3428 return( PSA_ERROR_BAD_STATE );
3429 }
3430 if( operation->iv_required && ! operation->iv_set )
3431 {
3432 return( PSA_ERROR_BAD_STATE );
3433 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003434
Ronald Crondd24c9b2020-12-15 14:10:01 +01003435 status = psa_driver_wrapper_cipher_finish( operation,
3436 output,
3437 output_size,
3438 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003439 if( status == PSA_SUCCESS )
3440 return( psa_cipher_abort( operation ) );
3441 else
3442 {
3443 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003444 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003445
Steven Cooremanef8575e2020-09-11 11:44:50 +02003446 return( status );
3447 }
mohammad1603503973b2018-03-12 15:59:30 +02003448}
3449
Gilles Peskinee553c652018-06-04 16:22:46 +02003450psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3451{
Ronald Cron49fafa92021-03-10 08:34:23 +01003452 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003453 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003454 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003455 * in use. It's ok to call abort on such an object, and there's
3456 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003457 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003458 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003459
Ronald Crondd24c9b2020-12-15 14:10:01 +01003460 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003461
Ronald Cron49fafa92021-03-10 08:34:23 +01003462 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003463 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003464 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003465
Moran Peker395db872018-05-31 14:07:14 +03003466 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003467}
3468
mohammad16035955c982018-04-26 00:53:03 +03003469/****************************************************************/
3470/* AEAD */
3471/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003472
Ronald Croncf56a0a2020-08-04 09:51:30 +02003473psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003474 psa_algorithm_t alg,
3475 const uint8_t *nonce,
3476 size_t nonce_length,
3477 const uint8_t *additional_data,
3478 size_t additional_data_length,
3479 const uint8_t *plaintext,
3480 size_t plaintext_length,
3481 uint8_t *ciphertext,
3482 size_t ciphertext_size,
3483 size_t *ciphertext_length )
3484{
Ronald Cron215633c2021-03-16 17:15:37 +01003485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3486 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003487
mohammad1603f08a5502018-06-03 15:05:47 +03003488 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003489
Steven Cooremanea7ab132021-03-17 16:28:00 +01003490 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3491 return( PSA_ERROR_NOT_SUPPORTED );
3492
Ronald Cron9a986162021-03-26 12:40:07 +01003493 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003494 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003495 if( status != PSA_SUCCESS )
3496 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003497
Ronald Cron215633c2021-03-16 17:15:37 +01003498 psa_key_attributes_t attributes = {
3499 .core = slot->attr
3500 };
mohammad16035955c982018-04-26 00:53:03 +03003501
Ronald Cronde822812021-03-17 16:08:20 +01003502 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003503 &attributes, slot->key.data, slot->key.bytes,
3504 alg,
3505 nonce, nonce_length,
3506 additional_data, additional_data_length,
3507 plaintext, plaintext_length,
3508 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003509
Gilles Peskineedf9a652018-08-17 18:11:56 +02003510 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3511 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003512
Ronald Cron9f310172021-03-16 16:36:37 +01003513 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003514
mohammad16035955c982018-04-26 00:53:03 +03003515 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003516}
3517
Ronald Croncf56a0a2020-08-04 09:51:30 +02003518psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003519 psa_algorithm_t alg,
3520 const uint8_t *nonce,
3521 size_t nonce_length,
3522 const uint8_t *additional_data,
3523 size_t additional_data_length,
3524 const uint8_t *ciphertext,
3525 size_t ciphertext_length,
3526 uint8_t *plaintext,
3527 size_t plaintext_size,
3528 size_t *plaintext_length )
3529{
Ronald Cron215633c2021-03-16 17:15:37 +01003530 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3531 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003532
Gilles Peskineee652a32018-06-01 19:23:52 +02003533 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003534
Steven Cooremanea7ab132021-03-17 16:28:00 +01003535 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3536 return( PSA_ERROR_NOT_SUPPORTED );
3537
Ronald Cron9a986162021-03-26 12:40:07 +01003538 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003539 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003540 if( status != PSA_SUCCESS )
3541 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003542
Ronald Cron215633c2021-03-16 17:15:37 +01003543 psa_key_attributes_t attributes = {
3544 .core = slot->attr
3545 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003546
Ronald Cronde822812021-03-17 16:08:20 +01003547 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003548 &attributes, slot->key.data, slot->key.bytes,
3549 alg,
3550 nonce, nonce_length,
3551 additional_data, additional_data_length,
3552 ciphertext, ciphertext_length,
3553 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003554
Gilles Peskineedf9a652018-08-17 18:11:56 +02003555 if( status != PSA_SUCCESS && plaintext_size != 0 )
3556 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003557
Ronald Cron215633c2021-03-16 17:15:37 +01003558 psa_unlock_key_slot( slot );
3559
Gilles Peskineedf9a652018-08-17 18:11:56 +02003560 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003561}
3562
Gilles Peskinee59236f2018-01-27 23:32:46 +01003563/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003564/* Generators */
3565/****************************************************************/
3566
John Durkop07cc04a2020-11-16 22:08:34 -08003567#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3568 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3569 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3570#define AT_LEAST_ONE_BUILTIN_KDF
3571#endif
3572
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003573#define HKDF_STATE_INIT 0 /* no input yet */
3574#define HKDF_STATE_STARTED 1 /* got salt */
3575#define HKDF_STATE_KEYED 2 /* got key */
3576#define HKDF_STATE_OUTPUT 3 /* output started */
3577
Gilles Peskinecbe66502019-05-16 16:59:18 +02003578static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003579 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003580{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003581 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3582 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003583 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003584 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003585}
3586
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003587psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003588{
3589 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003590 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003591 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003592 {
3593 /* The object has (apparently) been initialized but it is not
3594 * in use. It's ok to call abort on such an object, and there's
3595 * nothing to do. */
3596 }
3597 else
John Durkopd0321952020-10-29 21:37:36 -07003598#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003599 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003600 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003601 mbedtls_free( operation->ctx.hkdf.info );
3602 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003603 }
John Durkop07cc04a2020-11-16 22:08:34 -08003604 else
3605#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3606#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3607 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3608 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003609 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003610 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003611 {
Janos Follath6a1d2622019-06-11 10:37:28 +01003612 if( operation->ctx.tls12_prf.seed != NULL )
3613 {
3614 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3615 operation->ctx.tls12_prf.seed_length );
3616 mbedtls_free( operation->ctx.tls12_prf.seed );
3617 }
3618
3619 if( operation->ctx.tls12_prf.label != NULL )
3620 {
3621 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3622 operation->ctx.tls12_prf.label_length );
3623 mbedtls_free( operation->ctx.tls12_prf.label );
3624 }
3625
3626 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
3627
3628 /* We leave the fields Ai and output_block to be erased safely by the
3629 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003630 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003631 else
John Durkop07cc04a2020-11-16 22:08:34 -08003632#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3633 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003634 {
3635 status = PSA_ERROR_BAD_STATE;
3636 }
Janos Follath083036a2019-06-11 10:22:26 +01003637 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003638 return( status );
3639}
3640
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003641psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003642 size_t *capacity)
3643{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003644 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003645 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003646 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003647 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003648 }
3649
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003650 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003651 return( PSA_SUCCESS );
3652}
3653
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003654psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003655 size_t capacity )
3656{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003657 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003658 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003659 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003660 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003661 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003662 return( PSA_SUCCESS );
3663}
3664
John Durkopd0321952020-10-29 21:37:36 -07003665#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003666/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003667 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003668static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003669 psa_algorithm_t hash_alg,
3670 uint8_t *output,
3671 size_t output_length )
3672{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003673 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003674 psa_status_t status;
3675
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003676 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3677 return( PSA_ERROR_BAD_STATE );
3678 hkdf->state = HKDF_STATE_OUTPUT;
3679
Gilles Peskinebef7f142018-07-12 17:22:21 +02003680 while( output_length != 0 )
3681 {
3682 /* Copy what remains of the current block */
3683 uint8_t n = hash_length - hkdf->offset_in_block;
3684 if( n > output_length )
3685 n = (uint8_t) output_length;
3686 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3687 output += n;
3688 output_length -= n;
3689 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003690 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003691 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003692 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003693 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003694 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003695 * object was corrupted or if this function is called directly
3696 * inside the library. */
3697 if( hkdf->block_number == 0xff )
3698 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003699
3700 /* We need a new block */
3701 ++hkdf->block_number;
3702 hkdf->offset_in_block = 0;
3703 status = psa_hmac_setup_internal( &hkdf->hmac,
3704 hkdf->prk, hash_length,
3705 hash_alg );
3706 if( status != PSA_SUCCESS )
3707 return( status );
3708 if( hkdf->block_number != 1 )
3709 {
3710 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3711 hkdf->output_block,
3712 hash_length );
3713 if( status != PSA_SUCCESS )
3714 return( status );
3715 }
3716 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3717 hkdf->info,
3718 hkdf->info_length );
3719 if( status != PSA_SUCCESS )
3720 return( status );
3721 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3722 &hkdf->block_number, 1 );
3723 if( status != PSA_SUCCESS )
3724 return( status );
3725 status = psa_hmac_finish_internal( &hkdf->hmac,
3726 hkdf->output_block,
3727 sizeof( hkdf->output_block ) );
3728 if( status != PSA_SUCCESS )
3729 return( status );
3730 }
3731
3732 return( PSA_SUCCESS );
3733}
John Durkop07cc04a2020-11-16 22:08:34 -08003734#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003735
John Durkop07cc04a2020-11-16 22:08:34 -08003736#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3737 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003738static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3739 psa_tls12_prf_key_derivation_t *tls12_prf,
3740 psa_algorithm_t alg )
3741{
3742 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003743 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01003744 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
3745 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003746
Janos Follath7742fee2019-06-17 12:58:10 +01003747 /* We can't be wanting more output after block 0xff, otherwise
3748 * the capacity check in psa_key_derivation_output_bytes() would have
3749 * prevented this call. It could happen only if the operation
3750 * object was corrupted or if this function is called directly
3751 * inside the library. */
3752 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003753 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003754
3755 /* We need a new block */
3756 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003757 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003758
3759 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3760 *
3761 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3762 *
3763 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3764 * HMAC_hash(secret, A(2) + seed) +
3765 * HMAC_hash(secret, A(3) + seed) + ...
3766 *
3767 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003768 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003769 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003770 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003771 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003772 * is currently extracted as `output_block` and where i is
3773 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003774 */
3775
Janos Follathea29bfb2019-06-19 12:21:20 +01003776 /* Save the hash context before using it, to preserve the hash state with
3777 * only the inner padding in it. We need this, because inner padding depends
3778 * on the key (secret in the RFC's terminology). */
3779 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
3780 if( status != PSA_SUCCESS )
3781 goto cleanup;
3782
3783 /* Calculate A(i) where i = tls12_prf->block_number. */
3784 if( tls12_prf->block_number == 1 )
3785 {
3786 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3787 * the variable seed and in this instance means it in the context of the
3788 * P_hash function, where seed = label + seed.) */
3789 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3790 tls12_prf->label, tls12_prf->label_length );
3791 if( status != PSA_SUCCESS )
3792 goto cleanup;
3793 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3794 tls12_prf->seed, tls12_prf->seed_length );
3795 if( status != PSA_SUCCESS )
3796 goto cleanup;
3797 }
3798 else
3799 {
3800 /* A(i) = HMAC_hash(secret, A(i-1)) */
3801 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3802 tls12_prf->Ai, hash_length );
3803 if( status != PSA_SUCCESS )
3804 goto cleanup;
3805 }
3806
3807 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3808 tls12_prf->Ai, hash_length );
3809 if( status != PSA_SUCCESS )
3810 goto cleanup;
3811 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3812 if( status != PSA_SUCCESS )
3813 goto cleanup;
3814
3815 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
3816 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3817 tls12_prf->Ai, hash_length );
3818 if( status != PSA_SUCCESS )
3819 goto cleanup;
3820 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3821 tls12_prf->label, tls12_prf->label_length );
3822 if( status != PSA_SUCCESS )
3823 goto cleanup;
3824 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3825 tls12_prf->seed, tls12_prf->seed_length );
3826 if( status != PSA_SUCCESS )
3827 goto cleanup;
3828 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3829 tls12_prf->output_block, hash_length );
3830 if( status != PSA_SUCCESS )
3831 goto cleanup;
3832 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3833 if( status != PSA_SUCCESS )
3834 goto cleanup;
3835
Janos Follath7742fee2019-06-17 12:58:10 +01003836
3837cleanup:
3838
Janos Follathea29bfb2019-06-19 12:21:20 +01003839 cleanup_status = psa_hash_abort( &backup );
3840 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3841 status = cleanup_status;
3842
3843 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003844}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003845
Janos Follath844eb0e2019-06-19 12:10:49 +01003846static psa_status_t psa_key_derivation_tls12_prf_read(
3847 psa_tls12_prf_key_derivation_t *tls12_prf,
3848 psa_algorithm_t alg,
3849 uint8_t *output,
3850 size_t output_length )
3851{
3852 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003853 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003854 psa_status_t status;
3855 uint8_t offset, length;
3856
3857 while( output_length != 0 )
3858 {
3859 /* Check if we have fully processed the current block. */
3860 if( tls12_prf->left_in_block == 0 )
3861 {
3862 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3863 alg );
3864 if( status != PSA_SUCCESS )
3865 return( status );
3866
3867 continue;
3868 }
3869
3870 if( tls12_prf->left_in_block > output_length )
3871 length = (uint8_t) output_length;
3872 else
3873 length = tls12_prf->left_in_block;
3874
3875 offset = hash_length - tls12_prf->left_in_block;
3876 memcpy( output, tls12_prf->output_block + offset, length );
3877 output += length;
3878 output_length -= length;
3879 tls12_prf->left_in_block -= length;
3880 }
3881
3882 return( PSA_SUCCESS );
3883}
John Durkop07cc04a2020-11-16 22:08:34 -08003884#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3885 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003886
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003887psa_status_t psa_key_derivation_output_bytes(
3888 psa_key_derivation_operation_t *operation,
3889 uint8_t *output,
3890 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003891{
3892 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003893 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003894
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003895 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003896 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003897 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003898 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003899 }
3900
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003901 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003902 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003903 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003904 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003905 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003906 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003907 goto exit;
3908 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003909 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003910 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003911 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003912 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003913 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3914 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003915 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003916 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003917 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003918 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003919 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003920
John Durkopd0321952020-10-29 21:37:36 -07003921#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003922 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003923 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003924 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003925 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003926 output, output_length );
3927 }
Janos Follathadbec812019-06-14 11:05:39 +01003928 else
John Durkop07cc04a2020-11-16 22:08:34 -08003929#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3930#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3931 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003932 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003933 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003934 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003935 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003936 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003937 output_length );
3938 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003939 else
John Durkop07cc04a2020-11-16 22:08:34 -08003940#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3941 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003942 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003943 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003944 return( PSA_ERROR_BAD_STATE );
3945 }
3946
3947exit:
3948 if( status != PSA_SUCCESS )
3949 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003950 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003951 * This allows us to differentiate between exhausted operations and
3952 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3953 * operations. */
3954 psa_algorithm_t alg = operation->alg;
3955 psa_key_derivation_abort( operation );
3956 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003957 memset( output, '!', output_length );
3958 }
3959 return( status );
3960}
3961
David Brown7807bf72021-02-09 16:28:23 -07003962#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003963static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3964{
3965 if( data_size >= 8 )
3966 mbedtls_des_key_set_parity( data );
3967 if( data_size >= 16 )
3968 mbedtls_des_key_set_parity( data + 8 );
3969 if( data_size >= 24 )
3970 mbedtls_des_key_set_parity( data + 16 );
3971}
David Brown7807bf72021-02-09 16:28:23 -07003972#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003973
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003974static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003975 psa_key_slot_t *slot,
3976 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003977 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003978{
3979 uint8_t *data = NULL;
3980 size_t bytes = PSA_BITS_TO_BYTES( bits );
3981 psa_status_t status;
3982
Gilles Peskine8e338702019-07-30 20:06:31 +02003983 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003984 return( PSA_ERROR_INVALID_ARGUMENT );
3985 if( bits % 8 != 0 )
3986 return( PSA_ERROR_INVALID_ARGUMENT );
3987 data = mbedtls_calloc( 1, bytes );
3988 if( data == NULL )
3989 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3990
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003991 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003992 if( status != PSA_SUCCESS )
3993 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003994#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003995 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003996 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003997#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003998
3999 status = psa_allocate_buffer_to_slot( slot, bytes );
4000 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004001 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004002
Ronald Cronbf33c932020-11-28 18:06:53 +01004003 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004004 psa_key_attributes_t attributes = {
4005 .core = slot->attr
4006 };
4007
Ronald Cronbf33c932020-11-28 18:06:53 +01004008 status = psa_driver_wrapper_import_key( &attributes,
4009 data, bytes,
4010 slot->key.data,
4011 slot->key.bytes,
4012 &slot->key.bytes, &bits );
4013 if( bits != slot->attr.bits )
4014 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004015
4016exit:
4017 mbedtls_free( data );
4018 return( status );
4019}
4020
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004021psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004022 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004023 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004024{
4025 psa_status_t status;
4026 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004027 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004028
Ronald Cron81709fc2020-11-14 12:10:32 +01004029 *key = MBEDTLS_SVC_KEY_ID_INIT;
4030
Gilles Peskine0f84d622019-09-12 19:03:13 +02004031 /* Reject any attempt to create a zero-length key so that we don't
4032 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4033 if( psa_get_key_bits( attributes ) == 0 )
4034 return( PSA_ERROR_INVALID_ARGUMENT );
4035
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004036 if( ! operation->can_output_key )
4037 return( PSA_ERROR_NOT_PERMITTED );
4038
Ronald Cron81709fc2020-11-14 12:10:32 +01004039 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4040 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4042 if( driver != NULL )
4043 {
4044 /* Deriving a key in a secure element is not implemented yet. */
4045 status = PSA_ERROR_NOT_SUPPORTED;
4046 }
4047#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004048 if( status == PSA_SUCCESS )
4049 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004050 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004051 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004052 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004053 }
4054 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004055 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004056 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004057 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004058
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004059 return( status );
4060}
4061
Gilles Peskineeab56e42018-07-12 17:12:33 +02004062
4063
4064/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004065/* Key derivation */
4066/****************************************************************/
4067
Steven Cooreman932ffb72021-02-15 12:14:32 +01004068#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004069static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004070 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004071 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004072{
John Durkop07cc04a2020-11-16 22:08:34 -08004073 int is_kdf_alg_supported;
4074
Janos Follath5fe19732019-06-20 15:09:30 +01004075 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4076 * initialisers for this union leave some bytes unspecified.) */
4077 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4078
Gilles Peskine969c5d62019-01-16 15:53:06 +01004079 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004080#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004081 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4082 is_kdf_alg_supported = 1;
4083 else
4084#endif
4085#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4086 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4087 is_kdf_alg_supported = 1;
4088 else
4089#endif
4090#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4091 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4092 is_kdf_alg_supported = 1;
4093 else
4094#endif
4095 is_kdf_alg_supported = 0;
4096
4097 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004098 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004099 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004100 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004101 if( hash_size == 0 )
4102 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004103 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4104 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004105 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004106 {
4107 return( PSA_ERROR_NOT_SUPPORTED );
4108 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004109 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004110 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004111 }
John Durkop07cc04a2020-11-16 22:08:34 -08004112
4113 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004114}
John Durkop07cc04a2020-11-16 22:08:34 -08004115#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004116
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004117psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004118 psa_algorithm_t alg )
4119{
4120 psa_status_t status;
4121
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004122 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004123 return( PSA_ERROR_BAD_STATE );
4124
Gilles Peskine6843c292019-01-18 16:44:49 +01004125 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4126 return( PSA_ERROR_INVALID_ARGUMENT );
4127 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004128 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004129#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004130 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004131 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004132#else
4133 return( PSA_ERROR_NOT_SUPPORTED );
4134#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004135 }
4136 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4137 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004138#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004139 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004140#else
4141 return( PSA_ERROR_NOT_SUPPORTED );
4142#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004143 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004144 else
4145 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004146
4147 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004148 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004149 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004150}
4151
John Durkopd0321952020-10-29 21:37:36 -07004152#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004153static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004154 psa_algorithm_t hash_alg,
4155 psa_key_derivation_step_t step,
4156 const uint8_t *data,
4157 size_t data_length )
4158{
4159 psa_status_t status;
4160 switch( step )
4161 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004162 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004163 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004164 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004165 status = psa_hmac_setup_internal( &hkdf->hmac,
4166 data, data_length,
4167 hash_alg );
4168 if( status != PSA_SUCCESS )
4169 return( status );
4170 hkdf->state = HKDF_STATE_STARTED;
4171 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004172 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004173 /* If no salt was provided, use an empty salt. */
4174 if( hkdf->state == HKDF_STATE_INIT )
4175 {
4176 status = psa_hmac_setup_internal( &hkdf->hmac,
4177 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004178 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004179 if( status != PSA_SUCCESS )
4180 return( status );
4181 hkdf->state = HKDF_STATE_STARTED;
4182 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004183 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004184 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004185 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4186 data, data_length );
4187 if( status != PSA_SUCCESS )
4188 return( status );
4189 status = psa_hmac_finish_internal( &hkdf->hmac,
4190 hkdf->prk,
4191 sizeof( hkdf->prk ) );
4192 if( status != PSA_SUCCESS )
4193 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004194 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004195 hkdf->block_number = 0;
4196 hkdf->state = HKDF_STATE_KEYED;
4197 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004198 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004199 if( hkdf->state == HKDF_STATE_OUTPUT )
4200 return( PSA_ERROR_BAD_STATE );
4201 if( hkdf->info_set )
4202 return( PSA_ERROR_BAD_STATE );
4203 hkdf->info_length = data_length;
4204 if( data_length != 0 )
4205 {
4206 hkdf->info = mbedtls_calloc( 1, data_length );
4207 if( hkdf->info == NULL )
4208 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4209 memcpy( hkdf->info, data, data_length );
4210 }
4211 hkdf->info_set = 1;
4212 return( PSA_SUCCESS );
4213 default:
4214 return( PSA_ERROR_INVALID_ARGUMENT );
4215 }
4216}
John Durkop07cc04a2020-11-16 22:08:34 -08004217#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004218
John Durkop07cc04a2020-11-16 22:08:34 -08004219#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4220 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004221static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4222 const uint8_t *data,
4223 size_t data_length )
4224{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004225 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004226 return( PSA_ERROR_BAD_STATE );
4227
Janos Follathd6dce9f2019-07-04 09:11:38 +01004228 if( data_length != 0 )
4229 {
4230 prf->seed = mbedtls_calloc( 1, data_length );
4231 if( prf->seed == NULL )
4232 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004233
Janos Follathd6dce9f2019-07-04 09:11:38 +01004234 memcpy( prf->seed, data, data_length );
4235 prf->seed_length = data_length;
4236 }
Janos Follathf08e2652019-06-13 09:05:41 +01004237
Gilles Peskine43f958b2020-12-13 14:55:14 +01004238 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004239
4240 return( PSA_SUCCESS );
4241}
4242
Janos Follath81550542019-06-13 14:26:34 +01004243static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4244 psa_algorithm_t hash_alg,
4245 const uint8_t *data,
4246 size_t data_length )
4247{
4248 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004249 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004250 return( PSA_ERROR_BAD_STATE );
4251
4252 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4253 if( status != PSA_SUCCESS )
4254 return( status );
4255
Gilles Peskine43f958b2020-12-13 14:55:14 +01004256 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004257
4258 return( PSA_SUCCESS );
4259}
4260
Janos Follath63028dd2019-06-13 09:15:47 +01004261static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4262 const uint8_t *data,
4263 size_t data_length )
4264{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004265 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004266 return( PSA_ERROR_BAD_STATE );
4267
Janos Follathd6dce9f2019-07-04 09:11:38 +01004268 if( data_length != 0 )
4269 {
4270 prf->label = mbedtls_calloc( 1, data_length );
4271 if( prf->label == NULL )
4272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004273
Janos Follathd6dce9f2019-07-04 09:11:38 +01004274 memcpy( prf->label, data, data_length );
4275 prf->label_length = data_length;
4276 }
Janos Follath63028dd2019-06-13 09:15:47 +01004277
Gilles Peskine43f958b2020-12-13 14:55:14 +01004278 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004279
4280 return( PSA_SUCCESS );
4281}
4282
Janos Follathb03233e2019-06-11 15:30:30 +01004283static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4284 psa_algorithm_t hash_alg,
4285 psa_key_derivation_step_t step,
4286 const uint8_t *data,
4287 size_t data_length )
4288{
Janos Follathb03233e2019-06-11 15:30:30 +01004289 switch( step )
4290 {
Janos Follathf08e2652019-06-13 09:05:41 +01004291 case PSA_KEY_DERIVATION_INPUT_SEED:
4292 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004293 case PSA_KEY_DERIVATION_INPUT_SECRET:
4294 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004295 case PSA_KEY_DERIVATION_INPUT_LABEL:
4296 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004297 default:
4298 return( PSA_ERROR_INVALID_ARGUMENT );
4299 }
4300}
John Durkop07cc04a2020-11-16 22:08:34 -08004301#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4302 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4303
4304#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4305static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4306 psa_tls12_prf_key_derivation_t *prf,
4307 psa_algorithm_t hash_alg,
4308 const uint8_t *data,
4309 size_t data_length )
4310{
4311 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004312 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004313 uint8_t *cur = pms;
4314
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004315 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004316 return( PSA_ERROR_INVALID_ARGUMENT );
4317
4318 /* Quoting RFC 4279, Section 2:
4319 *
4320 * The premaster secret is formed as follows: if the PSK is N octets
4321 * long, concatenate a uint16 with the value N, N zero octets, a second
4322 * uint16 with the value N, and the PSK itself.
4323 */
4324
4325 *cur++ = ( data_length >> 8 ) & 0xff;
4326 *cur++ = ( data_length >> 0 ) & 0xff;
4327 memset( cur, 0, data_length );
4328 cur += data_length;
4329 *cur++ = pms[0];
4330 *cur++ = pms[1];
4331 memcpy( cur, data, data_length );
4332 cur += data_length;
4333
4334 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
4335
4336 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4337 return( status );
4338}
Janos Follath6660f0e2019-06-17 08:44:03 +01004339
4340static psa_status_t psa_tls12_prf_psk_to_ms_input(
4341 psa_tls12_prf_key_derivation_t *prf,
4342 psa_algorithm_t hash_alg,
4343 psa_key_derivation_step_t step,
4344 const uint8_t *data,
4345 size_t data_length )
4346{
4347 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004348 {
Janos Follath6660f0e2019-06-17 08:44:03 +01004349 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
4350 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004351 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004352
4353 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
4354}
John Durkop07cc04a2020-11-16 22:08:34 -08004355#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004356
Gilles Peskineb8965192019-09-24 16:21:10 +02004357/** Check whether the given key type is acceptable for the given
4358 * input step of a key derivation.
4359 *
4360 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4361 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4362 * Both secret and non-secret inputs can alternatively have the type
4363 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4364 * that the input was passed as a buffer rather than via a key object.
4365 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004366static int psa_key_derivation_check_input_type(
4367 psa_key_derivation_step_t step,
4368 psa_key_type_t key_type )
4369{
4370 switch( step )
4371 {
4372 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004373 if( key_type == PSA_KEY_TYPE_DERIVE )
4374 return( PSA_SUCCESS );
4375 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004376 return( PSA_SUCCESS );
4377 break;
4378 case PSA_KEY_DERIVATION_INPUT_LABEL:
4379 case PSA_KEY_DERIVATION_INPUT_SALT:
4380 case PSA_KEY_DERIVATION_INPUT_INFO:
4381 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004382 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4383 return( PSA_SUCCESS );
4384 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004385 return( PSA_SUCCESS );
4386 break;
4387 }
4388 return( PSA_ERROR_INVALID_ARGUMENT );
4389}
4390
Janos Follathb80a94e2019-06-12 15:54:46 +01004391static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004392 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004393 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004394 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004395 const uint8_t *data,
4396 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004397{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004398 psa_status_t status;
4399 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4400
4401 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004402 if( status != PSA_SUCCESS )
4403 goto exit;
4404
John Durkopd0321952020-10-29 21:37:36 -07004405#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004406 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004407 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004408 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004409 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004410 step, data, data_length );
4411 }
John Durkop07cc04a2020-11-16 22:08:34 -08004412 else
4413#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4414#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4415 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004416 {
Janos Follathb03233e2019-06-11 15:30:30 +01004417 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
4418 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4419 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004420 }
John Durkop07cc04a2020-11-16 22:08:34 -08004421 else
4422#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4423#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4424 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004425 {
4426 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
4427 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4428 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004429 }
4430 else
John Durkop07cc04a2020-11-16 22:08:34 -08004431#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004432 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004433 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004434 (void) data;
4435 (void) data_length;
4436 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004437 return( PSA_ERROR_BAD_STATE );
4438 }
4439
Gilles Peskine224b0d62019-09-23 18:13:17 +02004440exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004441 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004442 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004443 return( status );
4444}
4445
Janos Follath51f4a0f2019-06-14 11:35:55 +01004446psa_status_t psa_key_derivation_input_bytes(
4447 psa_key_derivation_operation_t *operation,
4448 psa_key_derivation_step_t step,
4449 const uint8_t *data,
4450 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004451{
Gilles Peskineb8965192019-09-24 16:21:10 +02004452 return( psa_key_derivation_input_internal( operation, step,
4453 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004454 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004455}
4456
Janos Follath51f4a0f2019-06-14 11:35:55 +01004457psa_status_t psa_key_derivation_input_key(
4458 psa_key_derivation_operation_t *operation,
4459 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004460 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004461{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004462 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004463 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004464 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004465
Ronald Cron5c522922020-11-14 16:35:34 +01004466 status = psa_get_and_lock_transparent_key_slot_with_policy(
4467 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004468 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004469 {
4470 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004471 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004472 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004473
4474 /* Passing a key object as a SECRET input unlocks the permission
4475 * to output to a key object. */
4476 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4477 operation->can_output_key = 1;
4478
Ronald Cronf95a2b12020-10-22 15:24:49 +02004479 status = psa_key_derivation_input_internal( operation,
4480 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004481 slot->key.data,
4482 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004483
Ronald Cron5c522922020-11-14 16:35:34 +01004484 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004485
Ronald Cron5c522922020-11-14 16:35:34 +01004486 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004487}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004488
4489
4490
4491/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004492/* Key agreement */
4493/****************************************************************/
4494
John Durkop6ba40d12020-11-10 08:50:04 -08004495#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004496static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4497 size_t peer_key_length,
4498 const mbedtls_ecp_keypair *our_key,
4499 uint8_t *shared_secret,
4500 size_t shared_secret_size,
4501 size_t *shared_secret_length )
4502{
Steven Cooremand4867872020-08-05 16:31:39 +02004503 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004504 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004505 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004506 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004507 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004508 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004509
Ronald Cron90857082020-11-25 14:58:33 +01004510 status = mbedtls_psa_ecp_load_representation(
4511 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004512 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004513 peer_key,
4514 peer_key_length,
4515 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004516 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004517 goto exit;
4518
Jaeden Amero97271b32019-01-10 19:38:51 +00004519 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004520 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004521 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004522 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004523 status = mbedtls_to_psa_error(
4524 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4525 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004526 goto exit;
4527
Jaeden Amero97271b32019-01-10 19:38:51 +00004528 status = mbedtls_to_psa_error(
4529 mbedtls_ecdh_calc_secret( &ecdh,
4530 shared_secret_length,
4531 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004532 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004533 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004534 if( status != PSA_SUCCESS )
4535 goto exit;
4536 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4537 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004538
4539exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004540 if( status != PSA_SUCCESS )
4541 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004542 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004543 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004544 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004545
Jaeden Amero97271b32019-01-10 19:38:51 +00004546 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004547}
John Durkop6ba40d12020-11-10 08:50:04 -08004548#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004549
Gilles Peskine01d718c2018-09-18 12:01:02 +02004550#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4551
Gilles Peskine0216fe12019-04-11 21:23:21 +02004552static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4553 psa_key_slot_t *private_key,
4554 const uint8_t *peer_key,
4555 size_t peer_key_length,
4556 uint8_t *shared_secret,
4557 size_t shared_secret_size,
4558 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004559{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004560 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004561 {
John Durkop6ba40d12020-11-10 08:50:04 -08004562#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004563 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004564 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004565 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004566 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004567 psa_status_t status = mbedtls_psa_ecp_load_representation(
4568 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004569 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004570 private_key->key.data,
4571 private_key->key.bytes,
4572 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004573 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004574 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004575 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004576 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004577 shared_secret, shared_secret_size,
4578 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004579 mbedtls_ecp_keypair_free( ecp );
4580 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004581 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004582#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004583 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004584 (void) private_key;
4585 (void) peer_key;
4586 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004587 (void) shared_secret;
4588 (void) shared_secret_size;
4589 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004590 return( PSA_ERROR_NOT_SUPPORTED );
4591 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004592}
4593
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004594/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004595 * to potentially free embedded data structures and wipe confidential data.
4596 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004597static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004598 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004599 psa_key_slot_t *private_key,
4600 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004601 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004602{
4603 psa_status_t status;
4604 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4605 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004606 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004607
4608 /* Step 1: run the secret agreement algorithm to generate the shared
4609 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004610 status = psa_key_agreement_raw_internal( ka_alg,
4611 private_key,
4612 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004613 shared_secret,
4614 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004615 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004616 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004617 goto exit;
4618
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004619 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004620 * the shared secret. A shared secret is permitted wherever a key
4621 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004622 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004623 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004624 shared_secret,
4625 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004626exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004627 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004628 return( status );
4629}
4630
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004631psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004632 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004633 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004634 const uint8_t *peer_key,
4635 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004636{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004637 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004638 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004639 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004640
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004641 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004642 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004643 status = psa_get_and_lock_transparent_key_slot_with_policy(
4644 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004645 if( status != PSA_SUCCESS )
4646 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004647 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004648 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004649 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004650 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004651 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004652 else
4653 {
4654 /* If a private key has been added as SECRET, we allow the derived
4655 * key material to be used as a key in PSA Crypto. */
4656 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4657 operation->can_output_key = 1;
4658 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004659
Ronald Cron5c522922020-11-14 16:35:34 +01004660 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004661
Ronald Cron5c522922020-11-14 16:35:34 +01004662 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004663}
4664
Gilles Peskinebe697d82019-05-16 18:00:41 +02004665psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004666 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004667 const uint8_t *peer_key,
4668 size_t peer_key_length,
4669 uint8_t *output,
4670 size_t output_size,
4671 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004672{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004673 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004674 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004675 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004676
4677 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4678 {
4679 status = PSA_ERROR_INVALID_ARGUMENT;
4680 goto exit;
4681 }
Ronald Cron5c522922020-11-14 16:35:34 +01004682 status = psa_get_and_lock_transparent_key_slot_with_policy(
4683 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004684 if( status != PSA_SUCCESS )
4685 goto exit;
4686
4687 status = psa_key_agreement_raw_internal( alg, slot,
4688 peer_key, peer_key_length,
4689 output, output_size,
4690 output_length );
4691
4692exit:
4693 if( status != PSA_SUCCESS )
4694 {
4695 /* If an error happens and is not handled properly, the output
4696 * may be used as a key to protect sensitive data. Arrange for such
4697 * a key to be random, which is likely to result in decryption or
4698 * verification errors. This is better than filling the buffer with
4699 * some constant data such as zeros, which would result in the data
4700 * being protected with a reproducible, easily knowable key.
4701 */
4702 psa_generate_random( output, output_size );
4703 *output_length = output_size;
4704 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004705
Ronald Cron5c522922020-11-14 16:35:34 +01004706 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004707
Ronald Cron5c522922020-11-14 16:35:34 +01004708 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004709}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004710
4711
Gilles Peskine30524eb2020-11-13 17:02:26 +01004712
Gilles Peskine86a440b2018-11-12 18:39:40 +01004713/****************************************************************/
4714/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004715/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004716
Gilles Peskine30524eb2020-11-13 17:02:26 +01004717/** Initialize the PSA random generator.
4718 */
4719static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4720{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004721#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4722 memset( rng, 0, sizeof( *rng ) );
4723#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4724
Gilles Peskine30524eb2020-11-13 17:02:26 +01004725 /* Set default configuration if
4726 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4727 if( rng->entropy_init == NULL )
4728 rng->entropy_init = mbedtls_entropy_init;
4729 if( rng->entropy_free == NULL )
4730 rng->entropy_free = mbedtls_entropy_free;
4731
4732 rng->entropy_init( &rng->entropy );
4733#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4734 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4735 /* The PSA entropy injection feature depends on using NV seed as an entropy
4736 * source. Add NV seed as an entropy source for PSA entropy injection. */
4737 mbedtls_entropy_add_source( &rng->entropy,
4738 mbedtls_nv_seed_poll, NULL,
4739 MBEDTLS_ENTROPY_BLOCK_SIZE,
4740 MBEDTLS_ENTROPY_SOURCE_STRONG );
4741#endif
4742
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004743 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004744#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004745}
4746
4747/** Deinitialize the PSA random generator.
4748 */
4749static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4750{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004751#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4752 memset( rng, 0, sizeof( *rng ) );
4753#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004754 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004755 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004756#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004757}
4758
4759/** Seed the PSA random generator.
4760 */
4761static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4762{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004763#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4764 /* Do nothing: the external RNG seeds itself. */
4765 (void) rng;
4766 return( PSA_SUCCESS );
4767#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004768 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004769 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4770 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004771 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004772#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004773}
4774
Gilles Peskinee59236f2018-01-27 23:32:46 +01004775psa_status_t psa_generate_random( uint8_t *output,
4776 size_t output_size )
4777{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004778 GUARD_MODULE_INITIALIZED;
4779
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004780#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4781
4782 size_t output_length = 0;
4783 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4784 output, output_size,
4785 &output_length );
4786 if( status != PSA_SUCCESS )
4787 return( status );
4788 /* Breaking up a request into smaller chunks is currently not supported
4789 * for the extrernal RNG interface. */
4790 if( output_length != output_size )
4791 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4792 return( PSA_SUCCESS );
4793
4794#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4795
Gilles Peskine71ddab92021-01-04 21:01:07 +01004796 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004797 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004798 size_t request_size =
4799 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4800 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4801 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004802 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4803 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004804 if( ret != 0 )
4805 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004806 output_size -= request_size;
4807 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004808 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004809 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004810#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004811}
4812
Gilles Peskine8814fc42020-12-14 15:33:44 +01004813/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004814 *
4815 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4816 * `psa_generate_random(...)`. The state parameter is ignored since the
4817 * PSA API doesn't support passing an explicit state.
4818 *
4819 * In the non-external case, psa_generate_random() calls an
4820 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4821 * and semantics as mbedtls_psa_get_random(). As an optimization,
4822 * instead of doing this back-and-forth between the PSA API and the
4823 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4824 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004825 */
4826#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4827int mbedtls_psa_get_random( void *p_rng,
4828 unsigned char *output,
4829 size_t output_size )
4830{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004831 /* This function takes a pointer to the RNG state because that's what
4832 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4833 * its own state internally and doesn't let the caller access that state.
4834 * So we just ignore the state parameter, and in practice we'll pass
4835 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004836 (void) p_rng;
4837 psa_status_t status = psa_generate_random( output, output_size );
4838 if( status == PSA_SUCCESS )
4839 return( 0 );
4840 else
4841 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4842}
4843#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4844
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004845#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004846#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004847
Gilles Peskine7228da22019-07-15 11:06:15 +02004848psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004849 size_t seed_size )
4850{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004851 if( global_data.initialized )
4852 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004853
4854 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4855 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4856 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4857 return( PSA_ERROR_INVALID_ARGUMENT );
4858
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004859 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004860}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004861#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004862
Ronald Cron3772afe2021-02-08 16:10:05 +01004863/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004864 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004865 * \param type The key type
4866 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004867 *
4868 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004869 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004870 * \retval #PSA_ERROR_INVALID_ARGUMENT
4871 * The size in bits of the key is not valid.
4872 * \retval #PSA_ERROR_NOT_SUPPORTED
4873 * The type and/or the size in bits of the key or the combination of
4874 * the two is not supported.
4875 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004876static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4877 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004878{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004879 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004880
Gilles Peskinee59236f2018-01-27 23:32:46 +01004881 if( key_type_is_raw_bytes( type ) )
4882 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004883 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004884 if( status != PSA_SUCCESS )
4885 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004886 }
4887 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004888#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004889 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4890 {
4891 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4892 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004893
Ronald Cron01b2aba2020-10-05 09:42:02 +02004894 /* Accept only byte-aligned keys, for the same reasons as
4895 * in psa_import_rsa_key(). */
4896 if( bits % 8 != 0 )
4897 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004898 }
4899 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004900#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004901
Ronald Cron5c4d3862020-12-07 11:07:24 +01004902#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004903 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4904 {
Ronald Crond81ab562021-02-16 09:01:16 +01004905 /* To avoid empty block, return successfully here. */
4906 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004907 }
4908 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004909#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004910 {
4911 return( PSA_ERROR_NOT_SUPPORTED );
4912 }
4913
4914 return( PSA_SUCCESS );
4915}
4916
Ronald Cron55ed0592020-10-05 10:30:40 +02004917psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004918 const psa_key_attributes_t *attributes,
4919 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004920{
4921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004922 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004923
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004924 if( ( attributes->domain_parameters == NULL ) &&
4925 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004926 return( PSA_ERROR_INVALID_ARGUMENT );
4927
Ronald Cron01b2aba2020-10-05 09:42:02 +02004928 if( key_type_is_raw_bytes( type ) )
4929 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004930 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004931 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004932 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004933
David Brown12ca5032021-02-11 11:02:00 -07004934#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004935 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004936 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004937#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004938 }
4939 else
4940
John Durkop07cc04a2020-11-16 22:08:34 -08004941#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004942 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004943 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004944 return( mbedtls_psa_rsa_generate_key( attributes,
4945 key_buffer,
4946 key_buffer_size,
4947 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004948 }
4949 else
John Durkop07cc04a2020-11-16 22:08:34 -08004950#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004951
John Durkop9814fa22020-11-04 12:28:15 -08004952#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004953 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004954 {
Ronald Cron7023db52020-11-20 18:17:42 +01004955 return( mbedtls_psa_ecp_generate_key( attributes,
4956 key_buffer,
4957 key_buffer_size,
4958 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004959 }
4960 else
John Durkop9814fa22020-11-04 12:28:15 -08004961#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004962 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004963 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004964 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004965 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004966
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004967 return( PSA_SUCCESS );
4968}
Darryl Green0c6575a2018-11-07 16:05:30 +00004969
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004970psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004971 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004972{
4973 psa_status_t status;
4974 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004975 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004976 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004977
Ronald Cron81709fc2020-11-14 12:10:32 +01004978 *key = MBEDTLS_SVC_KEY_ID_INIT;
4979
Gilles Peskine0f84d622019-09-12 19:03:13 +02004980 /* Reject any attempt to create a zero-length key so that we don't
4981 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4982 if( psa_get_key_bits( attributes ) == 0 )
4983 return( PSA_ERROR_INVALID_ARGUMENT );
4984
Ronald Cron81709fc2020-11-14 12:10:32 +01004985 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4986 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004987 if( status != PSA_SUCCESS )
4988 goto exit;
4989
Ronald Cron977c2472020-10-13 08:32:21 +02004990 /* In the case of a transparent key or an opaque key stored in local
4991 * storage (thus not in the case of generating a key in a secure element
4992 * or cryptoprocessor with storage), we have to allocate a buffer to
4993 * hold the generated key material. */
4994 if( slot->key.data == NULL )
4995 {
4996 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4997 PSA_KEY_LOCATION_LOCAL_STORAGE )
4998 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004999 status = psa_validate_key_type_and_size_for_key_generation(
5000 attributes->core.type, attributes->core.bits );
5001 if( status != PSA_SUCCESS )
5002 goto exit;
5003
5004 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5005 attributes->core.type,
5006 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005007 }
5008 else
5009 {
5010 status = psa_driver_wrapper_get_key_buffer_size(
5011 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005012 if( status != PSA_SUCCESS )
5013 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005014 }
Ronald Cron977c2472020-10-13 08:32:21 +02005015
5016 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5017 if( status != PSA_SUCCESS )
5018 goto exit;
5019 }
5020
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005021 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005022 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005023
Ronald Cron2b56bc82020-10-05 10:02:26 +02005024 if( status != PSA_SUCCESS )
5025 psa_remove_key_data_from_memory( slot );
5026
Gilles Peskine11792082019-08-06 18:36:36 +02005027exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005028 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005029 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005030 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005031 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005032
Darryl Green0c6575a2018-11-07 16:05:30 +00005033 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005034}
5035
Gilles Peskinee59236f2018-01-27 23:32:46 +01005036/****************************************************************/
5037/* Module setup */
5038/****************************************************************/
5039
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005040#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005041psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5042 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5043 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5044{
5045 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5046 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005047 global_data.rng.entropy_init = entropy_init;
5048 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005049 return( PSA_SUCCESS );
5050}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005051#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005052
Gilles Peskinee59236f2018-01-27 23:32:46 +01005053void mbedtls_psa_crypto_free( void )
5054{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005055 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005056 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5057 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005058 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005059 }
5060 /* Wipe all remaining data, including configuration.
5061 * In particular, this sets all state indicator to the value
5062 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005063 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005064#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005065 /* Unregister all secure element drivers, so that we restart from
5066 * a pristine state. */
5067 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005068#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005069}
5070
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005071#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5072/** Recover a transaction that was interrupted by a power failure.
5073 *
5074 * This function is called during initialization, before psa_crypto_init()
5075 * returns. If this function returns a failure status, the initialization
5076 * fails.
5077 */
5078static psa_status_t psa_crypto_recover_transaction(
5079 const psa_crypto_transaction_t *transaction )
5080{
5081 switch( transaction->unknown.type )
5082 {
5083 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5084 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005085 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005086 * is implemented.
5087 * https://github.com/ARMmbed/mbed-crypto/issues/218
5088 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005089 default:
5090 /* We found an unsupported transaction in the storage.
5091 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005092 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005093 }
5094}
5095#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5096
Gilles Peskinee59236f2018-01-27 23:32:46 +01005097psa_status_t psa_crypto_init( void )
5098{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005099 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005100
Gilles Peskinec6b69072018-11-20 21:42:52 +01005101 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005102 if( global_data.initialized != 0 )
5103 return( PSA_SUCCESS );
5104
Gilles Peskine30524eb2020-11-13 17:02:26 +01005105 /* Initialize and seed the random generator. */
5106 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005107 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005108 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005109 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005110 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005111 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005112
Gilles Peskine66fb1262018-12-10 16:29:04 +01005113 status = psa_initialize_key_slots( );
5114 if( status != PSA_SUCCESS )
5115 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005116
Gilles Peskined9348f22019-10-01 15:22:29 +02005117#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5118 status = psa_init_all_se_drivers( );
5119 if( status != PSA_SUCCESS )
5120 goto exit;
5121#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5122
Gilles Peskine4b734222019-07-24 15:56:31 +02005123#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005124 status = psa_crypto_load_transaction( );
5125 if( status == PSA_SUCCESS )
5126 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005127 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5128 if( status != PSA_SUCCESS )
5129 goto exit;
5130 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005131 }
5132 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5133 {
5134 /* There's no transaction to complete. It's all good. */
5135 status = PSA_SUCCESS;
5136 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005137#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005138
Gilles Peskinec6b69072018-11-20 21:42:52 +01005139 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005140 global_data.initialized = 1;
5141
5142exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005143 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005144 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005145 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005146}
5147
5148#endif /* MBEDTLS_PSA_CRYPTO_C */