blob: f1678c79020c4d35e13f9b003551f2af9751a035 [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 Peskinea5905292018-02-07 20:59:33 +0100155
Gilles Peskine9a944802018-06-21 09:35:35 +0200156 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
157 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
158 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
159 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
160 case MBEDTLS_ERR_ASN1_INVALID_DATA:
161 return( PSA_ERROR_INVALID_ARGUMENT );
162 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
163 return( PSA_ERROR_INSUFFICIENT_MEMORY );
164 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
165 return( PSA_ERROR_BUFFER_TOO_SMALL );
166
Jaeden Amero93e21112019-02-20 13:57:28 +0000167#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000168 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000169#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100170 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
171 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100172
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000174 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000175#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100178
179 case MBEDTLS_ERR_CCM_BAD_INPUT:
180 return( PSA_ERROR_INVALID_ARGUMENT );
181 case MBEDTLS_ERR_CCM_AUTH_FAILED:
182 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100183
Gilles Peskine26869f22019-05-06 15:25:00 +0200184 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
185 return( PSA_ERROR_INVALID_ARGUMENT );
186
187 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
188 return( PSA_ERROR_BAD_STATE );
189 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
190 return( PSA_ERROR_INVALID_SIGNATURE );
191
Gilles Peskinea5905292018-02-07 20:59:33 +0100192 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
193 return( PSA_ERROR_NOT_SUPPORTED );
194 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
195 return( PSA_ERROR_INVALID_ARGUMENT );
196 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
197 return( PSA_ERROR_INSUFFICIENT_MEMORY );
198 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
199 return( PSA_ERROR_INVALID_PADDING );
200 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200201 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100202 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200205 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100218#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100219
220 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
221 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100222
Gilles Peskinee59236f2018-01-27 23:32:46 +0100223 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
224 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
225 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
226 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100227
228 case MBEDTLS_ERR_GCM_AUTH_FAILED:
229 return( PSA_ERROR_INVALID_SIGNATURE );
230 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200231 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100232
Gilles Peskine82e57d12020-11-13 21:31:17 +0100233#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
234 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100235 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
236 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100237 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
238 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
239 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
240 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
241 return( PSA_ERROR_NOT_SUPPORTED );
242 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
243 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
244#endif
245
Gilles Peskinea5905292018-02-07 20:59:33 +0100246 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
247 return( PSA_ERROR_NOT_SUPPORTED );
248 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
249 return( PSA_ERROR_INVALID_ARGUMENT );
250 case MBEDTLS_ERR_MD_ALLOC_FAILED:
251 return( PSA_ERROR_INSUFFICIENT_MEMORY );
252 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
253 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100254
Gilles Peskinef76aa772018-10-29 19:24:33 +0100255 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
256 return( PSA_ERROR_STORAGE_FAILURE );
257 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
258 return( PSA_ERROR_INVALID_ARGUMENT );
259 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
262 return( PSA_ERROR_BUFFER_TOO_SMALL );
263 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
264 return( PSA_ERROR_INVALID_ARGUMENT );
265 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
268 return( PSA_ERROR_INVALID_ARGUMENT );
269 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
270 return( PSA_ERROR_INSUFFICIENT_MEMORY );
271
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100272 case MBEDTLS_ERR_PK_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
275 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100278 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100279 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
280 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
281 return( PSA_ERROR_INVALID_ARGUMENT );
282 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
283 return( PSA_ERROR_NOT_SUPPORTED );
284 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
285 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
286 return( PSA_ERROR_NOT_PERMITTED );
287 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_PK_INVALID_ALG:
290 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
291 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
292 return( PSA_ERROR_NOT_SUPPORTED );
293 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
294 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100295
Gilles Peskineff2d2002019-05-06 15:26:23 +0200296 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
297 return( PSA_ERROR_HARDWARE_FAILURE );
298 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
299 return( PSA_ERROR_NOT_SUPPORTED );
300
Gilles Peskinea5905292018-02-07 20:59:33 +0100301 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
302 return( PSA_ERROR_INVALID_ARGUMENT );
303 case MBEDTLS_ERR_RSA_INVALID_PADDING:
304 return( PSA_ERROR_INVALID_PADDING );
305 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
306 return( PSA_ERROR_HARDWARE_FAILURE );
307 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
308 return( PSA_ERROR_INVALID_ARGUMENT );
309 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
310 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200311 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
313 return( PSA_ERROR_INVALID_SIGNATURE );
314 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
315 return( PSA_ERROR_BUFFER_TOO_SMALL );
316 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100317 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100318
319 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
320 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100321
itayzafrir5c753392018-05-08 11:18:38 +0300322 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300323 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300324 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300325 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
326 return( PSA_ERROR_BUFFER_TOO_SMALL );
327 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
328 return( PSA_ERROR_NOT_SUPPORTED );
329 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
330 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
331 return( PSA_ERROR_INVALID_SIGNATURE );
332 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
333 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100334 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
335 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100336
Janos Follatha13b9052019-11-22 12:48:59 +0000337 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
338 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300339
Gilles Peskinee59236f2018-01-27 23:32:46 +0100340 default:
David Saadab4ecc272019-02-14 13:48:10 +0200341 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100342 }
343}
344
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200345
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200346
347
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100348/****************************************************************/
349/* Key management */
350/****************************************************************/
351
Gilles Peskine73167e12019-07-12 23:44:37 +0200352#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
353static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
354{
Gilles Peskine8e338702019-07-30 20:06:31 +0200355 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200356}
357#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
358
John Durkop07cc04a2020-11-16 22:08:34 -0800359/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
360 * current test driver in key_management.c is using this function
361 * when accelerators are used for ECC key pair and public key.
362 * Once that dependency is resolved these guards can be removed.
363 */
John Durkop9814fa22020-11-04 12:28:15 -0800364#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800365 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
366 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
367 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100368mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100369 size_t bits,
370 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200371{
372 switch( curve )
373 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100375 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100376 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100377#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#endif
381#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
385#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100386 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100388#endif
389#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100390 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100391 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100392#endif
393#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100396 case 528:
397 if( bits_is_sloppy )
398 return( MBEDTLS_ECP_DP_SECP521R1 );
399 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 }
402 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100403
Paul Elliott8ff510a2020-06-02 17:19:28 +0100404 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100406 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100407#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100408 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100409 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100410#endif
411#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#endif
415#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100417 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 }
420 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100421
Paul Elliott8ff510a2020-06-02 17:19:28 +0100422 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100425#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100427 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100428 case 256:
429 if( bits_is_sloppy )
430 return( MBEDTLS_ECP_DP_CURVE25519 );
431 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100432#endif
433#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100435 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100437 }
438 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100439
Paul Elliott8ff510a2020-06-02 17:19:28 +0100440 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100441 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100442 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100443#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100445 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100446#endif
447#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100448 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100449 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100450#endif
451#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100452 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100454#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100455 }
456 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200457 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100458
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100459 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100460 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200461}
John Durkop9814fa22020-11-04 12:28:15 -0800462#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800463 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
464 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
465 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200466
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200467static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
468 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200469{
470 /* Check that the bit size is acceptable for the key type */
471 switch( type )
472 {
473 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200474 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200475 case PSA_KEY_TYPE_DERIVE:
476 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100477#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478 case PSA_KEY_TYPE_AES:
479 if( bits != 128 && bits != 192 && bits != 256 )
480 return( PSA_ERROR_INVALID_ARGUMENT );
481 break;
482#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100483#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200484 case PSA_KEY_TYPE_CAMELLIA:
485 if( bits != 128 && bits != 192 && bits != 256 )
486 return( PSA_ERROR_INVALID_ARGUMENT );
487 break;
488#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100489#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490 case PSA_KEY_TYPE_DES:
491 if( bits != 64 && bits != 128 && bits != 192 )
492 return( PSA_ERROR_INVALID_ARGUMENT );
493 break;
494#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100495#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200496 case PSA_KEY_TYPE_ARC4:
497 if( bits < 8 || bits > 2048 )
498 return( PSA_ERROR_INVALID_ARGUMENT );
499 break;
500#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100501#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200502 case PSA_KEY_TYPE_CHACHA20:
503 if( bits != 256 )
504 return( PSA_ERROR_INVALID_ARGUMENT );
505 break;
506#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200507 default:
508 return( PSA_ERROR_NOT_SUPPORTED );
509 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200510 if( bits % 8 != 0 )
511 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200512
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200513 return( PSA_SUCCESS );
514}
515
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100516/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100517 *
Steven Cooremancd640932021-03-08 12:00:27 +0100518 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
519 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100520 *
521 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100522 * \param[in] key_type The key type of the key to be used with the
523 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100524 *
525 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100526 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100527 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100528 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100529 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100530MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100531 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100532 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100533{
Steven Cooremancd640932021-03-08 12:00:27 +0100534 if( PSA_ALG_IS_HMAC( algorithm ) )
535 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100536 if( key_type == PSA_KEY_TYPE_HMAC )
537 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100538 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100539
540 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100541 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100542 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
543 * key. */
544 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
545 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
546 {
547 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
548 * the block length (larger than 1) for block ciphers. */
549 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
550 return( PSA_SUCCESS );
551 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100552 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100553
554 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100555}
556
Steven Cooreman75b74362020-07-28 14:30:13 +0200557/** Try to allocate a buffer to an empty key slot.
558 *
559 * \param[in,out] slot Key slot to attach buffer to.
560 * \param[in] buffer_length Requested size of the buffer.
561 *
562 * \retval #PSA_SUCCESS
563 * The buffer has been successfully allocated.
564 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
565 * Not enough memory was available for allocation.
566 * \retval #PSA_ERROR_ALREADY_EXISTS
567 * Trying to allocate a buffer to a non-empty key slot.
568 */
569static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
570 size_t buffer_length )
571{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100572 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200573 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200574
Ronald Cronea0f8a62020-11-25 17:52:23 +0100575 slot->key.data = mbedtls_calloc( 1, buffer_length );
576 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200577 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200578
Ronald Cronea0f8a62020-11-25 17:52:23 +0100579 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200580 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200581}
582
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200583psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
584 const uint8_t* data,
585 size_t data_length )
586{
587 psa_status_t status = psa_allocate_buffer_to_slot( slot,
588 data_length );
589 if( status != PSA_SUCCESS )
590 return( status );
591
Ronald Cronea0f8a62020-11-25 17:52:23 +0100592 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200593 return( PSA_SUCCESS );
594}
595
Ronald Crona0fe59f2020-11-29 11:14:53 +0100596psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 const psa_key_attributes_t *attributes,
598 const uint8_t *data, size_t data_length,
599 uint8_t *key_buffer, size_t key_buffer_size,
600 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100601{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
603 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100604
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200605 /* zero-length keys are never supported. */
606 if( data_length == 0 )
607 return( PSA_ERROR_NOT_SUPPORTED );
608
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100609 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100610 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100611 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200612
Steven Cooreman75b74362020-07-28 14:30:13 +0200613 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
614 if( data_length > SIZE_MAX / 8 )
615 return( PSA_ERROR_NOT_SUPPORTED );
616
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200617 /* Enforce a size limit, and in particular ensure that the bit
618 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100619 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200620 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200621
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100622 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200623 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200625
Ronald Crondd04d422020-11-28 15:14:42 +0100626 /* Copy the key material. */
627 memcpy( key_buffer, data, data_length );
628 *key_buffer_length = data_length;
629 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200630
Steven Cooreman40120f62020-10-29 11:42:22 +0100631 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100632 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100633 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200634 {
John Durkop9814fa22020-11-04 12:28:15 -0800635#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
636 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100637 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200638 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100639 return( mbedtls_psa_ecp_import_key( attributes,
640 data, data_length,
641 key_buffer, key_buffer_size,
642 key_buffer_length,
643 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100644 }
John Durkop9814fa22020-11-04 12:28:15 -0800645#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
646 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700647#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
648 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100649 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200650 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100651 return( mbedtls_psa_rsa_import_key( attributes,
652 data, data_length,
653 key_buffer, key_buffer_size,
654 key_buffer_length,
655 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200656 }
John Durkop9814fa22020-11-04 12:28:15 -0800657#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
658 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100659 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100660
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100661 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100662}
663
Gilles Peskinef603c712019-01-19 13:40:11 +0100664/** Calculate the intersection of two algorithm usage policies.
665 *
666 * Return 0 (which allows no operation) on incompatibility.
667 */
668static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100669 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100670 psa_algorithm_t alg1,
671 psa_algorithm_t alg2 )
672{
Gilles Peskine549ea862019-05-22 11:45:59 +0200673 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100674 if( alg1 == alg2 )
675 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100676 /* If the policies are from the same hash-and-sign family, check
677 * if one is a wildcard. If so the other has the specific algorithm. */
678 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
679 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
680 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100681 {
Steven Cooreman03488022021-02-18 12:07:20 +0100682 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
683 return( alg2 );
684 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
685 return( alg1 );
686 }
687 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100688 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100689 * restrictive tag length. */
690 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
691 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
692 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
693 {
694 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
695 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100696 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100697
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100698 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100699 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
700 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100701 {
Steven Cooremancd640932021-03-08 12:00:27 +0100702 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
703 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100704 }
705 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100706 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100707 ( alg1_len <= alg2_len ) )
708 {
709 return( alg2 );
710 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100711 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100712 ( alg2_len <= alg1_len ) )
713 {
714 return( alg1 );
715 }
716 }
717 /* If the policies are from the same MAC family, check whether one
718 * of them is a minimum-MAC-length policy. Calculate the most
719 * restrictive tag length. */
720 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
721 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
722 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
723 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100724 /* Validate the combination of key type and algorithm. Since the base
725 * algorithm of alg1 and alg2 are the same, we only need this once. */
726 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100727 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100728
Steven Cooreman31a876d2021-03-03 20:47:40 +0100729 /* Get the (exact or at-least) output lengths for both sides of the
730 * requested intersection. None of the currently supported algorithms
731 * have an output length dependent on the actual key size, so setting it
732 * to a bogus value of 0 is currently OK.
733 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100734 * Note that for at-least-this-length wildcard algorithms, the output
735 * length is set to the shortest allowed length, which allows us to
736 * calculate the most restrictive tag length for the intersection. */
737 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
738 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100739 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100740
Steven Cooremana1d83222021-02-25 10:20:29 +0100741 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100742 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
743 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100744 {
Steven Cooremancd640932021-03-08 12:00:27 +0100745 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100746 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100747
748 /* If only one is an at-least-this-length policy, the intersection would
749 * be the other (fixed-length) policy as long as said fixed length is
750 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100751 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100752 {
Steven Cooremancd640932021-03-08 12:00:27 +0100753 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100754 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100755 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100756 {
Steven Cooremancd640932021-03-08 12:00:27 +0100757 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100758 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100759
Steven Cooremancd640932021-03-08 12:00:27 +0100760 /* If none of them are wildcards, check whether they define the same tag
761 * length. This is still possible here when one is default-length and
762 * the other specific-length. Ensure to always return the
763 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100764 if( alg1_len == alg2_len )
765 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100766 }
767 /* If the policies are incompatible, allow nothing. */
768 return( 0 );
769}
770
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100771static int psa_key_algorithm_permits( psa_key_type_t key_type,
772 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200773 psa_algorithm_t requested_alg )
774{
Gilles Peskine549ea862019-05-22 11:45:59 +0200775 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200776 if( requested_alg == policy_alg )
777 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100778 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
779 * and requested_alg is the same hash-and-sign family with any hash,
780 * then requested_alg is compliant with policy_alg. */
781 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
782 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200783 {
Steven Cooreman03488022021-02-18 12:07:20 +0100784 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
785 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
786 }
787 /* If policy_alg is a wildcard AEAD algorithm of the same base as
788 * the requested algorithm, check the requested tag length to be
789 * equal-length or longer than the wildcard-specified length. */
790 if( PSA_ALG_IS_AEAD( policy_alg ) &&
791 PSA_ALG_IS_AEAD( requested_alg ) &&
792 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
793 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100794 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100795 {
796 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
797 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
798 }
Steven Cooremancd640932021-03-08 12:00:27 +0100799 /* If policy_alg is a MAC algorithm of the same base as the requested
800 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100801 if( PSA_ALG_IS_MAC( policy_alg ) &&
802 PSA_ALG_IS_MAC( requested_alg ) &&
803 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100804 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100805 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100806 /* Validate the combination of key type and algorithm. Since the policy
807 * and requested algorithms are the same, we only need this once. */
808 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100810
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811 /* Get both the requested output length for the algorithm which is to be
812 * verified, and the default output length for the base algorithm.
813 * Note that none of the currently supported algorithms have an output
814 * length dependent on actual key size, so setting it to a bogus value
815 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100816 size_t requested_output_length = PSA_MAC_LENGTH(
817 key_type, 0, requested_alg );
818 size_t default_output_length = PSA_MAC_LENGTH(
819 key_type, 0,
820 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100821
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100822 /* If the policy is default-length, only allow an algorithm with
823 * a declared exact-length matching the default. */
824 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100825 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100826
827 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100828 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100829 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
830 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
831 {
832 return( 1 );
833 }
834
Steven Cooremancd640932021-03-08 12:00:27 +0100835 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
836 * check for the requested MAC length to be equal to or longer than the
837 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100838 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
839 {
840 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100841 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100842 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200843 }
Steven Cooremance48e852020-10-05 16:02:45 +0200844 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200845 * a key derivation with that key agreement should also be allowed. This
846 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200847 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
848 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
849 {
850 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
851 policy_alg );
852 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100853 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200854 return( 0 );
855}
856
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100857/** Test whether a policy permits an algorithm.
858 *
859 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100860 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100861 * \note This function requires providing the key type for which the policy is
862 * being validated, since some algorithm policy definitions (e.g. MAC)
863 * have different properties depending on what kind of cipher it is
864 * combined with.
865 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100866 * \retval PSA_SUCCESS When \p alg is a specific algorithm
867 * allowed by the \p policy.
868 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
869 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
870 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100871 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100872static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100873 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100874 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100875{
Steven Cooremand788fab2021-02-25 11:29:17 +0100876 /* '0' is not a valid algorithm */
877 if( alg == 0 )
878 return( PSA_ERROR_INVALID_ARGUMENT );
879
Steven Cooreman7e39f052021-02-23 14:18:32 +0100880 /* A requested algorithm cannot be a wildcard. */
881 if( PSA_ALG_IS_WILDCARD( alg ) )
882 return( PSA_ERROR_INVALID_ARGUMENT );
883
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100884 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
885 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100886 return( PSA_SUCCESS );
887 else
888 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100889}
890
Gilles Peskinef603c712019-01-19 13:40:11 +0100891/** Restrict a key policy based on a constraint.
892 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100893 * \note This function requires providing the key type for which the policy is
894 * being restricted, since some algorithm policy definitions (e.g. MAC)
895 * have different properties depending on what kind of cipher it is
896 * combined with.
897 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100898 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100899 * \param[in,out] policy The policy to restrict.
900 * \param[in] constraint The policy constraint to apply.
901 *
902 * \retval #PSA_SUCCESS
903 * \c *policy contains the intersection of the original value of
904 * \c *policy and \c *constraint.
905 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100906 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100907 * \c *policy is unchanged.
908 */
909static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100910 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100911 psa_key_policy_t *policy,
912 const psa_key_policy_t *constraint )
913{
914 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100915 psa_key_policy_algorithm_intersection( key_type, policy->alg,
916 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200917 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100918 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
919 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100920 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
921 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200922 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
923 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100924 policy->usage &= constraint->usage;
925 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200926 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100927 return( PSA_SUCCESS );
928}
929
Ronald Cron5c522922020-11-14 16:35:34 +0100930/** Get the description of a key given its identifier and policy constraints
931 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200932 *
Ronald Cron5c522922020-11-14 16:35:34 +0100933 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100934 * nonzero, the key must allow operations with this algorithm. If \p alg is
935 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100936 *
Ronald Cron5c522922020-11-14 16:35:34 +0100937 * In case of a persistent key, the function loads the description of the key
938 * into a key slot if not already done.
939 *
940 * On success, the returned key slot is locked. It is the responsibility of
941 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200942 */
Ronald Cron5c522922020-11-14 16:35:34 +0100943static psa_status_t psa_get_and_lock_key_slot_with_policy(
944 mbedtls_svc_key_id_t key,
945 psa_key_slot_t **p_slot,
946 psa_key_usage_t usage,
947 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100948{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200949 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
950 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100951
Ronald Cron5c522922020-11-14 16:35:34 +0100952 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100953 if( status != PSA_SUCCESS )
954 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200955 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100956
957 /* Enforce that usage policy for the key slot contains all the flags
958 * required by the usage parameter. There is one exception: public
959 * keys can always be exported, so we treat public key objects as
960 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200961 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100962 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200963
Gilles Peskine8e338702019-07-30 20:06:31 +0200964 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100965 {
966 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100968 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100969
970 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100971 if( alg != 0 )
972 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100973 status = psa_key_policy_permits( &slot->attr.policy,
974 slot->attr.type,
975 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100976 if( status != PSA_SUCCESS )
977 goto error;
978 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100979
Darryl Green06fd18d2018-07-16 11:21:11 +0100980 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200981
982error:
983 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100984 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200985
986 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100987}
Darryl Green940d72c2018-07-13 13:18:51 +0100988
Ronald Cron5c522922020-11-14 16:35:34 +0100989/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200990 *
991 * A transparent key is a key for which the key material is directly
992 * available, as opposed to a key in a secure element.
993 *
Ronald Cron5c522922020-11-14 16:35:34 +0100994 * This is a temporary function to use instead of
995 * psa_get_and_lock_key_slot_with_policy() until secure element support is
996 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200997 *
Ronald Cron5c522922020-11-14 16:35:34 +0100998 * On success, the returned key slot is locked. It is the responsibility of the
999 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001000 */
1001#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001002static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1003 mbedtls_svc_key_id_t key,
1004 psa_key_slot_t **p_slot,
1005 psa_key_usage_t usage,
1006 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001007{
Ronald Cron5c522922020-11-14 16:35:34 +01001008 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1009 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001010 if( status != PSA_SUCCESS )
1011 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001012
Gilles Peskineadad8132019-07-25 11:31:23 +02001013 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001014 {
Ronald Cron5c522922020-11-14 16:35:34 +01001015 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001016 *p_slot = NULL;
1017 return( PSA_ERROR_NOT_SUPPORTED );
1018 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001019
Gilles Peskine28f8f302019-07-24 13:30:31 +02001020 return( PSA_SUCCESS );
1021}
1022#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1023/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001024#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1025 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001026#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1027
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001028/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001029static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001030{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001031 /* Data pointer will always be either a valid pointer or NULL in an
1032 * initialized slot, so we can just free it. */
1033 if( slot->key.data != NULL )
1034 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1035
1036 mbedtls_free( slot->key.data );
1037 slot->key.data = NULL;
1038 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001039
1040 return( PSA_SUCCESS );
1041}
1042
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001043/** Completely wipe a slot in memory, including its policy.
1044 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001045psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001046{
1047 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001048
1049 /*
1050 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001051 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001052 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1053 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001054 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001055 */
Ronald Cron5c522922020-11-14 16:35:34 +01001056 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001057 {
1058#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001059 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001060#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001061 status = PSA_ERROR_CORRUPTION_DETECTED;
1062 }
1063
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001064 /* Multipart operations may still be using the key. This is safe
1065 * because all multipart operation objects are independent from
1066 * the key slot: if they need to access the key after the setup
1067 * phase, they have a copy of the key. Note that this means that
1068 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001069 /* At this point, key material and other type-specific content has
1070 * been wiped. Clear remaining metadata. We can call memset and not
1071 * zeroize because the metadata is not particularly sensitive. */
1072 memset( slot, 0, sizeof( *slot ) );
1073 return( status );
1074}
1075
Ronald Croncf56a0a2020-08-04 09:51:30 +02001076psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001077{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001078 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 psa_status_t status; /* status of the last operation */
1080 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001081#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1082 psa_se_drv_table_entry_t *driver;
1083#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001084
Ronald Croncf56a0a2020-08-04 09:51:30 +02001085 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001086 return( PSA_SUCCESS );
1087
Ronald Cronf2911112020-10-29 17:51:10 +01001088 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001089 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001090 * key, this will load the key description from persistent memory if not
1091 * done yet. We cannot avoid this loading as without it we don't know if
1092 * the key is operated by an SE or not and this information is needed by
1093 * the current implementation.
1094 */
Ronald Cron5c522922020-11-14 16:35:34 +01001095 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001096 if( status != PSA_SUCCESS )
1097 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001098
Ronald Cronf2911112020-10-29 17:51:10 +01001099 /*
1100 * If the key slot containing the key description is under access by the
1101 * library (apart from the present access), the key cannot be destroyed
1102 * yet. For the time being, just return in error. Eventually (to be
1103 * implemented), the key should be destroyed when all accesses have
1104 * stopped.
1105 */
Ronald Cron5c522922020-11-14 16:35:34 +01001106 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001107 {
Ronald Cron5c522922020-11-14 16:35:34 +01001108 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001109 return( PSA_ERROR_GENERIC_ERROR );
1110 }
1111
Gilles Peskine354f7672019-07-12 23:46:38 +02001112#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001113 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001114 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001115 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001116 /* For a key in a secure element, we need to do three things:
1117 * remove the key file in internal storage, destroy the
1118 * key inside the secure element, and update the driver's
1119 * persistent data. Start a transaction that will encompass these
1120 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001121 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001122 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001123 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001124 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001125 status = psa_crypto_save_transaction( );
1126 if( status != PSA_SUCCESS )
1127 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001128 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 /* We should still try to destroy the key in the secure
1130 * element and the key metadata in storage. This is especially
1131 * important if the error is that the storage is full.
1132 * But how to do it exactly without risking an inconsistent
1133 * state after a reset?
1134 * https://github.com/ARMmbed/mbed-crypto/issues/215
1135 */
1136 overall_status = status;
1137 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001138 }
1139
Ronald Cronea0f8a62020-11-25 17:52:23 +01001140 status = psa_destroy_se_key( driver,
1141 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001142 if( overall_status == PSA_SUCCESS )
1143 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001144 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001145#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1146
Darryl Greend49a4992018-06-18 17:27:26 +01001147#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001148 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001149 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001150 status = psa_destroy_persistent_key( slot->attr.id );
1151 if( overall_status == PSA_SUCCESS )
1152 overall_status = status;
1153
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001154 /* TODO: other slots may have a copy of the same key. We should
1155 * invalidate them.
1156 * https://github.com/ARMmbed/mbed-crypto/issues/214
1157 */
Darryl Greend49a4992018-06-18 17:27:26 +01001158 }
1159#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001160
Gilles Peskinefc762652019-07-22 19:30:34 +02001161#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1162 if( driver != NULL )
1163 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001164 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001165 if( overall_status == PSA_SUCCESS )
1166 overall_status = status;
1167 status = psa_crypto_stop_transaction( );
1168 if( overall_status == PSA_SUCCESS )
1169 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001170 }
1171#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1172
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001173#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1174exit:
1175#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001176 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001177 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1178 if( overall_status == PSA_SUCCESS )
1179 overall_status = status;
1180 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001181}
1182
John Durkop07cc04a2020-11-16 22:08:34 -08001183#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001184 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001185static psa_status_t psa_get_rsa_public_exponent(
1186 const mbedtls_rsa_context *rsa,
1187 psa_key_attributes_t *attributes )
1188{
1189 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001190 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001191 uint8_t *buffer = NULL;
1192 size_t buflen;
1193 mbedtls_mpi_init( &mpi );
1194
1195 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1196 if( ret != 0 )
1197 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001198 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1199 {
1200 /* It's the default value, which is reported as an empty string,
1201 * so there's nothing to do. */
1202 goto exit;
1203 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001204
1205 buflen = mbedtls_mpi_size( &mpi );
1206 buffer = mbedtls_calloc( 1, buflen );
1207 if( buffer == NULL )
1208 {
1209 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1210 goto exit;
1211 }
1212 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1213 if( ret != 0 )
1214 goto exit;
1215 attributes->domain_parameters = buffer;
1216 attributes->domain_parameters_size = buflen;
1217
1218exit:
1219 mbedtls_mpi_free( &mpi );
1220 if( ret != 0 )
1221 mbedtls_free( buffer );
1222 return( mbedtls_to_psa_error( ret ) );
1223}
John Durkop07cc04a2020-11-16 22:08:34 -08001224#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001225 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001226
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001227/** Retrieve all the publicly-accessible attributes of a key.
1228 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001229psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001230 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001231{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001232 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001233 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001234 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001235
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001236 psa_reset_key_attributes( attributes );
1237
Ronald Cron5c522922020-11-14 16:35:34 +01001238 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001239 if( status != PSA_SUCCESS )
1240 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001241
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001242 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001243 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1244 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1245
1246#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1247 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001248 psa_set_key_slot_number( attributes,
1249 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001250#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001251
Gilles Peskine8e338702019-07-30 20:06:31 +02001252 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001253 {
John Durkop07cc04a2020-11-16 22:08:34 -08001254#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001255 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001256 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001257 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001258#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001259 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001260 * is not yet implemented.
1261 * https://github.com/ARMmbed/mbed-crypto/issues/216
1262 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001263 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001264 break;
1265#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001266 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001267 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001268
Ronald Cron90857082020-11-25 14:58:33 +01001269 status = mbedtls_psa_rsa_load_representation(
1270 slot->attr.type,
1271 slot->key.data,
1272 slot->key.bytes,
1273 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001274 if( status != PSA_SUCCESS )
1275 break;
1276
Steven Cooremana2371e52020-07-28 14:30:39 +02001277 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001278 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001279 mbedtls_rsa_free( rsa );
1280 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001281 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001282 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001283#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001284 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001285 default:
1286 /* Nothing else to do. */
1287 break;
1288 }
1289
1290 if( status != PSA_SUCCESS )
1291 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001292
Ronald Cron5c522922020-11-14 16:35:34 +01001293 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001294
Ronald Cron5c522922020-11-14 16:35:34 +01001295 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001296}
1297
Gilles Peskinec8000c02019-08-02 20:15:51 +02001298#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1299psa_status_t psa_get_key_slot_number(
1300 const psa_key_attributes_t *attributes,
1301 psa_key_slot_number_t *slot_number )
1302{
1303 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1304 {
1305 *slot_number = attributes->slot_number;
1306 return( PSA_SUCCESS );
1307 }
1308 else
1309 return( PSA_ERROR_INVALID_ARGUMENT );
1310}
1311#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1312
Ronald Crond18b5f82020-11-25 16:46:05 +01001313static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1314 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001315 uint8_t *data,
1316 size_t data_size,
1317 size_t *data_length )
1318{
Ronald Crond18b5f82020-11-25 16:46:05 +01001319 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001320 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001321 memcpy( data, key_buffer, key_buffer_size );
1322 memset( data + key_buffer_size, 0,
1323 data_size - key_buffer_size );
1324 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001325 return( PSA_SUCCESS );
1326}
1327
Ronald Cron7285cda2020-11-26 14:46:37 +01001328psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001329 const psa_key_attributes_t *attributes,
1330 const uint8_t *key_buffer, size_t key_buffer_size,
1331 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001332{
Ronald Crond18b5f82020-11-25 16:46:05 +01001333 psa_key_type_t type = attributes->core.type;
1334
Ronald Crond18b5f82020-11-25 16:46:05 +01001335 if( key_type_is_raw_bytes( type ) ||
1336 PSA_KEY_TYPE_IS_RSA( type ) ||
1337 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001338 {
1339 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 key_buffer, key_buffer_size,
1341 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342 }
1343 else
1344 {
1345 /* This shouldn't happen in the reference implementation, but
1346 it is valid for a special-purpose implementation to omit
1347 support for exporting certain key types. */
1348 return( PSA_ERROR_NOT_SUPPORTED );
1349 }
1350}
1351
1352psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1353 uint8_t *data,
1354 size_t data_size,
1355 size_t *data_length )
1356{
1357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1358 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1359 psa_key_slot_t *slot;
1360
Ronald Crone907e552021-01-18 13:22:38 +01001361 /* Reject a zero-length output buffer now, since this can never be a
1362 * valid key representation. This way we know that data must be a valid
1363 * pointer and we can do things like memset(data, ..., data_size). */
1364 if( data_size == 0 )
1365 return( PSA_ERROR_BUFFER_TOO_SMALL );
1366
Ronald Cron9486f9d2020-11-26 13:36:23 +01001367 /* Set the key to empty now, so that even when there are errors, we always
1368 * set data_length to a value between 0 and data_size. On error, setting
1369 * the key to empty is a good choice because an empty key representation is
1370 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001371 *data_length = 0;
1372
Ronald Cron9486f9d2020-11-26 13:36:23 +01001373 /* Export requires the EXPORT flag. There is an exception for public keys,
1374 * which don't require any flag, but
1375 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1376 */
1377 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1378 PSA_KEY_USAGE_EXPORT, 0 );
1379 if( status != PSA_SUCCESS )
1380 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001381
Ronald Crond18b5f82020-11-25 16:46:05 +01001382 psa_key_attributes_t attributes = {
1383 .core = slot->attr
1384 };
Ronald Cron67227982020-11-26 15:16:05 +01001385 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001386 slot->key.data, slot->key.bytes,
1387 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001388
Ronald Cron9486f9d2020-11-26 13:36:23 +01001389 unlock_status = psa_unlock_key_slot( slot );
1390
1391 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1392}
1393
Ronald Cron7285cda2020-11-26 14:46:37 +01001394psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001395 const psa_key_attributes_t *attributes,
1396 const uint8_t *key_buffer,
1397 size_t key_buffer_size,
1398 uint8_t *data,
1399 size_t data_size,
1400 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001401{
Ronald Crond18b5f82020-11-25 16:46:05 +01001402 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001403
Ronald Crond18b5f82020-11-25 16:46:05 +01001404 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001405 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001406 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001407 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001408 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001409 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001410 key_buffer, key_buffer_size,
1411 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001412 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001413
Ronald Crond18b5f82020-11-25 16:46:05 +01001414 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001415 {
John Durkop0e005192020-10-31 22:06:54 -07001416#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1417 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001418 return( mbedtls_psa_rsa_export_public_key( attributes,
1419 key_buffer,
1420 key_buffer_size,
1421 data,
1422 data_size,
1423 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001424#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001425 /* We don't know how to convert a private RSA key to public. */
1426 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001427#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1428 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001429 }
1430 else
Moran Pekera998bc62018-04-16 18:16:20 +03001431 {
John Durkop6ba40d12020-11-10 08:50:04 -08001432#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1433 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001434 return( mbedtls_psa_ecp_export_public_key( attributes,
1435 key_buffer,
1436 key_buffer_size,
1437 data,
1438 data_size,
1439 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001440#else
1441 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001442 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001443#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1444 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001445 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001446 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001447 else
1448 {
1449 /* This shouldn't happen in the reference implementation, but
1450 it is valid for a special-purpose implementation to omit
1451 support for exporting certain key types. */
1452 return( PSA_ERROR_NOT_SUPPORTED );
1453 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001454}
Ronald Crond18b5f82020-11-25 16:46:05 +01001455
Ronald Croncf56a0a2020-08-04 09:51:30 +02001456psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001457 uint8_t *data,
1458 size_t data_size,
1459 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001460{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001461 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001462 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001463 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001464
Ronald Crone907e552021-01-18 13:22:38 +01001465 /* Reject a zero-length output buffer now, since this can never be a
1466 * valid key representation. This way we know that data must be a valid
1467 * pointer and we can do things like memset(data, ..., data_size). */
1468 if( data_size == 0 )
1469 return( PSA_ERROR_BUFFER_TOO_SMALL );
1470
Darryl Greendd8fb772018-11-07 16:00:44 +00001471 /* Set the key to empty now, so that even when there are errors, we always
1472 * set data_length to a value between 0 and data_size. On error, setting
1473 * the key to empty is a good choice because an empty key representation is
1474 * unlikely to be accepted anywhere. */
1475 *data_length = 0;
1476
1477 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001478 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001479 if( status != PSA_SUCCESS )
1480 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001481
Ronald Cron9486f9d2020-11-26 13:36:23 +01001482 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1483 {
1484 status = PSA_ERROR_INVALID_ARGUMENT;
1485 goto exit;
1486 }
1487
Ronald Crond18b5f82020-11-25 16:46:05 +01001488 psa_key_attributes_t attributes = {
1489 .core = slot->attr
1490 };
Ronald Cron67227982020-11-26 15:16:05 +01001491 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001492 &attributes, slot->key.data, slot->key.bytes,
1493 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001494
1495exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001496 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001497
Ronald Cron5c522922020-11-14 16:35:34 +01001498 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001499}
1500
Gilles Peskine91e8c332019-08-02 19:19:39 +02001501#if defined(static_assert)
1502static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1503 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001504static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001505 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001506static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001507 "One or more key attribute flag is listed as both internal-only and external-only" );
1508#endif
1509
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001510/** Validate that a key policy is internally well-formed.
1511 *
1512 * This function only rejects invalid policies. It does not validate the
1513 * consistency of the policy with respect to other attributes of the key
1514 * such as the key type.
1515 */
1516static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001517{
1518 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001519 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001520 PSA_KEY_USAGE_ENCRYPT |
1521 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001522 PSA_KEY_USAGE_SIGN_HASH |
1523 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001524 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1525 return( PSA_ERROR_INVALID_ARGUMENT );
1526
Gilles Peskine4747d192019-04-17 15:05:45 +02001527 return( PSA_SUCCESS );
1528}
1529
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001530/** Validate the internal consistency of key attributes.
1531 *
1532 * This function only rejects invalid attribute values. If does not
1533 * validate the consistency of the attributes with any key data that may
1534 * be involved in the creation of the key.
1535 *
1536 * Call this function early in the key creation process.
1537 *
1538 * \param[in] attributes Key attributes for the new key.
1539 * \param[out] p_drv On any return, the driver for the key, if any.
1540 * NULL for a transparent key.
1541 *
1542 */
1543static psa_status_t psa_validate_key_attributes(
1544 const psa_key_attributes_t *attributes,
1545 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001546{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001547 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001548 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001549 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001550
Ronald Cron54b90082020-10-29 15:26:43 +01001551 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001552 if( status != PSA_SUCCESS )
1553 return( status );
1554
Ronald Crond2ed4812020-07-17 16:11:30 +02001555 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001556 if( status != PSA_SUCCESS )
1557 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001558
Ronald Cron65f38a32020-10-23 17:11:13 +02001559 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1560 {
1561 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1562 return( PSA_ERROR_INVALID_ARGUMENT );
1563 }
1564 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001565 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001566 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1567 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001568 }
1569
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001570 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001571 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001572 return( status );
1573
1574 /* Refuse to create overly large keys.
1575 * Note that this doesn't trigger on import if the attributes don't
1576 * explicitly specify a size (so psa_get_key_bits returns 0), so
1577 * psa_import_key() needs its own checks. */
1578 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1579 return( PSA_ERROR_NOT_SUPPORTED );
1580
Gilles Peskine91e8c332019-08-02 19:19:39 +02001581 /* Reject invalid flags. These should not be reachable through the API. */
1582 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1583 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1584 return( PSA_ERROR_INVALID_ARGUMENT );
1585
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001586 return( PSA_SUCCESS );
1587}
1588
Gilles Peskine4747d192019-04-17 15:05:45 +02001589/** Prepare a key slot to receive key material.
1590 *
1591 * This function allocates a key slot and sets its metadata.
1592 *
1593 * If this function fails, call psa_fail_key_creation().
1594 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001595 * This function is intended to be used as follows:
1596 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001597 * it with the specified attributes, and in case of a volatile key assign it
1598 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001599 * -# Populate the slot with the key material.
1600 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1601 * In case of failure at any step, stop the sequence and call
1602 * psa_fail_key_creation().
1603 *
Ronald Cron5c522922020-11-14 16:35:34 +01001604 * On success, the key slot is locked. It is the responsibility of the caller
1605 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001606 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001607 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001608 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001609 * \param[out] p_slot On success, a pointer to the prepared slot.
1610 * \param[out] p_drv On any return, the driver for the key, if any.
1611 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001612 *
1613 * \retval #PSA_SUCCESS
1614 * The key slot is ready to receive key material.
1615 * \return If this function fails, the key slot is an invalid state.
1616 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001617 */
1618static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001619 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001620 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001621 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001622 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001623{
1624 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001625 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001626 psa_key_slot_t *slot;
1627
Gilles Peskinedf179142019-07-15 22:02:14 +02001628 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001629 *p_drv = NULL;
1630
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001631 status = psa_validate_key_attributes( attributes, p_drv );
1632 if( status != PSA_SUCCESS )
1633 return( status );
1634
Ronald Cronc4d1b512020-07-31 11:26:37 +02001635 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001636 if( status != PSA_SUCCESS )
1637 return( status );
1638 slot = *p_slot;
1639
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001640 /* We're storing the declared bit-size of the key. It's up to each
1641 * creation mechanism to verify that this information is correct.
1642 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001643 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001644 * is optional (import, copy). In case of a volatile key, assign it the
1645 * volatile key identifier associated to the slot returned to contain its
1646 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001647
1648 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001649 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1650 {
1651#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1652 slot->attr.id = volatile_key_id;
1653#else
1654 slot->attr.id.key_id = volatile_key_id;
1655#endif
1656 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001657
Gilles Peskine91e8c332019-08-02 19:19:39 +02001658 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001659 * external-only flags, query `attributes`. Thanks to the check
1660 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001661 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001662 * may have set. */
1663 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001664
Gilles Peskinecbaff462019-07-12 23:46:04 +02001665#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001666 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001667 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001668 * create the key file in internal storage, create the
1669 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001670 * persistent data. This is done by starting a transaction that will
1671 * encompass these three actions.
1672 * For registering a volatile key, we just need to find an appropriate
1673 * slot number inside the SE. Since the key is designated volatile, creating
1674 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001675 /* The first thing to do is to find a slot number for the new key.
1676 * We save the slot number in persistent storage as part of the
1677 * transaction data. It will be needed to recover if the power
1678 * fails during the key creation process, to clean up on the secure
1679 * element side after restarting. Obtaining a slot number from the
1680 * secure element driver updates its persistent state, but we do not yet
1681 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001682 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001683 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001684 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001685 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001686 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001687 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001688 if( status != PSA_SUCCESS )
1689 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001690
1691 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001692 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001693 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1694 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001695 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001696 psa_crypto_transaction.key.id = slot->attr.id;
1697 status = psa_crypto_save_transaction( );
1698 if( status != PSA_SUCCESS )
1699 {
1700 (void) psa_crypto_stop_transaction( );
1701 return( status );
1702 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001703 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001704
1705 status = psa_copy_key_material_into_slot(
1706 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001707 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001708
1709 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1710 {
1711 /* Key registration only makes sense with a secure element. */
1712 return( PSA_ERROR_INVALID_ARGUMENT );
1713 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001714#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1715
Ronald Cronc4d1b512020-07-31 11:26:37 +02001716 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001717}
Gilles Peskine4747d192019-04-17 15:05:45 +02001718
1719/** Finalize the creation of a key once its key material has been set.
1720 *
1721 * This entails writing the key to persistent storage.
1722 *
1723 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001724 * See the documentation of psa_start_key_creation() for the intended use
1725 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 *
Ronald Cron5c522922020-11-14 16:35:34 +01001727 * If the finalization succeeds, the function unlocks the key slot (it was
1728 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1729 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001730 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001731 * \param[in,out] slot Pointer to the slot with key material.
1732 * \param[in] driver The secure element driver for the key,
1733 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001734 * \param[out] key On success, identifier of the key. Note that the
1735 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001736 *
1737 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001738 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001739 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1740 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1741 * \retval #PSA_ERROR_ALREADY_EXISTS
1742 * \retval #PSA_ERROR_DATA_INVALID
1743 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001744 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001745 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001746 * \return If this function fails, the key slot is an invalid state.
1747 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001748 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001749static psa_status_t psa_finish_key_creation(
1750 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001751 psa_se_drv_table_entry_t *driver,
1752 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001753{
1754 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001755 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001756 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001757
1758#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001759 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001760 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001761#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1762 if( driver != NULL )
1763 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001764 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001765 psa_key_slot_number_t slot_number =
1766 psa_key_slot_get_slot_number( slot ) ;
1767
Gilles Peskineb46bef22019-07-30 21:32:04 +02001768#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001769 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001770 sizeof( data.slot_number ),
1771 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001772#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001773 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001774 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001775 (uint8_t*) &data,
1776 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001777 }
1778 else
1779#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1780 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001781 /* Key material is saved in export representation in the slot, so
1782 * just pass the slot buffer for storage. */
1783 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001784 slot->key.data,
1785 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001786 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001788#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1789
Gilles Peskinecbaff462019-07-12 23:46:04 +02001790#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001791 /* Finish the transaction for a key creation. This does not
1792 * happen when registering an existing key. Detect this case
1793 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001794 * creation of a persistent key in a secure element requires a transaction,
1795 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001796 if( driver != NULL &&
1797 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001798 {
1799 status = psa_save_se_persistent_data( driver );
1800 if( status != PSA_SUCCESS )
1801 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001802 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001803 return( status );
1804 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001805 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001806 }
1807#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1808
Ronald Cron50972942020-11-14 11:28:25 +01001809 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001810 {
1811 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001812 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001813 if( status != PSA_SUCCESS )
1814 *key = MBEDTLS_SVC_KEY_ID_INIT;
1815 }
Ronald Cron50972942020-11-14 11:28:25 +01001816
Gilles Peskine4747d192019-04-17 15:05:45 +02001817 return( status );
1818}
1819
1820/** Abort the creation of a key.
1821 *
1822 * You may call this function after calling psa_start_key_creation(),
1823 * or after psa_finish_key_creation() fails. In other circumstances, this
1824 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001825 * See the documentation of psa_start_key_creation() for the intended use
1826 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001827 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001828 * \param[in,out] slot Pointer to the slot with key material.
1829 * \param[in] driver The secure element driver for the key,
1830 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001831 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001832static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001833 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001834{
Gilles Peskine011e4282019-06-26 18:34:38 +02001835 (void) driver;
1836
Gilles Peskine4747d192019-04-17 15:05:45 +02001837 if( slot == NULL )
1838 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001839
1840#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001841 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001842 * element, and the failure happened later (when saving metadata
1843 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001844 * element.
1845 * https://github.com/ARMmbed/mbed-crypto/issues/217
1846 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001847
Gilles Peskined7729582019-08-05 15:55:54 +02001848 /* Abort the ongoing transaction if any (there may not be one if
1849 * the creation process failed before starting one, or if the
1850 * key creation is a registration of a key in a secure element).
1851 * Earlier functions must already have done what it takes to undo any
1852 * partial creation. All that's left is to update the transaction data
1853 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001854 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001855#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1856
Gilles Peskine4747d192019-04-17 15:05:45 +02001857 psa_wipe_key_slot( slot );
1858}
1859
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001860/** Validate optional attributes during key creation.
1861 *
1862 * Some key attributes are optional during key creation. If they are
1863 * specified in the attributes structure, check that they are consistent
1864 * with the data in the slot.
1865 *
1866 * This function should be called near the end of key creation, after
1867 * the slot in memory is fully populated but before saving persistent data.
1868 */
1869static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001870 const psa_key_slot_t *slot,
1871 const psa_key_attributes_t *attributes )
1872{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001873 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001874 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001875 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876 return( PSA_ERROR_INVALID_ARGUMENT );
1877 }
1878
1879 if( attributes->domain_parameters_size != 0 )
1880 {
John Durkop0e005192020-10-31 22:06:54 -07001881#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1882 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001883 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001885 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001886 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001888
Ronald Cron90857082020-11-25 14:58:33 +01001889 psa_status_t status = mbedtls_psa_rsa_load_representation(
1890 slot->attr.type,
1891 slot->key.data,
1892 slot->key.bytes,
1893 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001894 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001895 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001896
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001897 mbedtls_mpi_init( &actual );
1898 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001899 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001900 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001901 mbedtls_rsa_free( rsa );
1902 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 if( ret != 0 )
1904 goto rsa_exit;
1905 ret = mbedtls_mpi_read_binary( &required,
1906 attributes->domain_parameters,
1907 attributes->domain_parameters_size );
1908 if( ret != 0 )
1909 goto rsa_exit;
1910 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1911 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1912 rsa_exit:
1913 mbedtls_mpi_free( &actual );
1914 mbedtls_mpi_free( &required );
1915 if( ret != 0)
1916 return( mbedtls_to_psa_error( ret ) );
1917 }
1918 else
John Durkop9814fa22020-11-04 12:28:15 -08001919#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1920 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 {
1922 return( PSA_ERROR_INVALID_ARGUMENT );
1923 }
1924 }
1925
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001926 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001927 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001928 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001929 return( PSA_ERROR_INVALID_ARGUMENT );
1930 }
1931
1932 return( PSA_SUCCESS );
1933}
1934
Gilles Peskine4747d192019-04-17 15:05:45 +02001935psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001936 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001937 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001938 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001939{
1940 psa_status_t status;
1941 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001942 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001943 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001944
Ronald Cron81709fc2020-11-14 12:10:32 +01001945 *key = MBEDTLS_SVC_KEY_ID_INIT;
1946
Gilles Peskine0f84d622019-09-12 19:03:13 +02001947 /* Reject zero-length symmetric keys (including raw data key objects).
1948 * This also rejects any key which might be encoded as an empty string,
1949 * which is never valid. */
1950 if( data_length == 0 )
1951 return( PSA_ERROR_INVALID_ARGUMENT );
1952
Gilles Peskinedf179142019-07-15 22:02:14 +02001953 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001954 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955 if( status != PSA_SUCCESS )
1956 goto exit;
1957
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001958 /* In the case of a transparent key or an opaque key stored in local
1959 * storage (thus not in the case of generating a key in a secure element
1960 * or cryptoprocessor with storage), we have to allocate a buffer to
1961 * hold the generated key material. */
1962 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001963 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001964 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001965 if( status != PSA_SUCCESS )
1966 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001967 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001968
1969 bits = slot->attr.bits;
1970 status = psa_driver_wrapper_import_key( attributes,
1971 data, data_length,
1972 slot->key.data,
1973 slot->key.bytes,
1974 &slot->key.bytes, &bits );
1975 if( status != PSA_SUCCESS )
1976 goto exit;
1977
1978 if( slot->attr.bits == 0 )
1979 slot->attr.bits = (psa_key_bits_t) bits;
1980 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001981 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001982 status = PSA_ERROR_INVALID_ARGUMENT;
1983 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001984 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001985
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001986 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001987 if( status != PSA_SUCCESS )
1988 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001989
Ronald Cron81709fc2020-11-14 12:10:32 +01001990 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001991exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001992 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001993 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001994
Gilles Peskine4747d192019-04-17 15:05:45 +02001995 return( status );
1996}
1997
Gilles Peskined7729582019-08-05 15:55:54 +02001998#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1999psa_status_t mbedtls_psa_register_se_key(
2000 const psa_key_attributes_t *attributes )
2001{
2002 psa_status_t status;
2003 psa_key_slot_t *slot = NULL;
2004 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002005 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002006
2007 /* Leaving attributes unspecified is not currently supported.
2008 * It could make sense to query the key type and size from the
2009 * secure element, but not all secure elements support this
2010 * and the driver HAL doesn't currently support it. */
2011 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2012 return( PSA_ERROR_NOT_SUPPORTED );
2013 if( psa_get_key_bits( attributes ) == 0 )
2014 return( PSA_ERROR_NOT_SUPPORTED );
2015
2016 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002017 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002018 if( status != PSA_SUCCESS )
2019 goto exit;
2020
Ronald Cron81709fc2020-11-14 12:10:32 +01002021 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002022
2023exit:
2024 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002025 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002026
Gilles Peskined7729582019-08-05 15:55:54 +02002027 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002028 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002029 return( status );
2030}
2031#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2032
Gilles Peskinef603c712019-01-19 13:40:11 +01002033static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002034 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002035{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002036 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002037 source->key.data,
2038 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002039 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002040 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002041
Steven Cooreman398aee52020-10-13 14:35:45 +02002042 target->attr.type = source->attr.type;
2043 target->attr.bits = source->attr.bits;
2044
2045 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002046}
2047
Ronald Croncf56a0a2020-08-04 09:51:30 +02002048psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002049 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002050 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002051{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002052 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002053 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002054 psa_key_slot_t *source_slot = NULL;
2055 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002056 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002057 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002058
Ronald Cron81709fc2020-11-14 12:10:32 +01002059 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2060
Ronald Cron5c522922020-11-14 16:35:34 +01002061 status = psa_get_and_lock_transparent_key_slot_with_policy(
2062 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002063 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002064 goto exit;
2065
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002066 status = psa_validate_optional_attributes( source_slot,
2067 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002068 if( status != PSA_SUCCESS )
2069 goto exit;
2070
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002071 status = psa_restrict_key_policy( source_slot->attr.type,
2072 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002073 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074 if( status != PSA_SUCCESS )
2075 goto exit;
2076
Ronald Cron81709fc2020-11-14 12:10:32 +01002077 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2078 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002079 if( status != PSA_SUCCESS )
2080 goto exit;
2081
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002082#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2083 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002084 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002085 /* Copying to a secure element is not implemented yet. */
2086 status = PSA_ERROR_NOT_SUPPORTED;
2087 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002088 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002089#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002090
Ronald Cron6cc66312021-04-02 12:27:47 +02002091 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2092 {
2093 /*
2094 * Copying through an opaque driver is not implemented yet, consider
2095 * a lifetime with an external location as an invalid parameter for
2096 * now.
2097 */
2098 status = PSA_ERROR_INVALID_ARGUMENT;
2099 goto exit;
2100 }
2101
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002102 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002103 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002104 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002105
Ronald Cron81709fc2020-11-14 12:10:32 +01002106 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002107exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002108 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002109 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002110
Ronald Cron5c522922020-11-14 16:35:34 +01002111 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002112
Ronald Cron5c522922020-11-14 16:35:34 +01002113 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002114}
2115
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002116
2117
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002118/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002119/* Message digests */
2120/****************************************************************/
2121
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002122psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2123{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002124 /* Aborting a non-active operation is allowed */
2125 if( operation->id == 0 )
2126 return( PSA_SUCCESS );
2127
2128 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2129 operation->id = 0;
2130
2131 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002132}
2133
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002134psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002135 psa_algorithm_t alg )
2136{
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002137 /* A context must be freshly initialized before it can be set up. */
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002138 if( operation->id != 0 )
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002139 return( PSA_ERROR_BAD_STATE );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002140
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002141 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002142 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002143
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002144 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2145 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002146 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2147
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002148 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002149}
2150
2151psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2152 const uint8_t *input,
2153 size_t input_length )
2154{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002155 if( operation->id == 0 )
2156 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002157
2158 /* Don't require hash implementations to behave correctly on a
2159 * zero-length input, which may have an invalid pointer. */
2160 if( input_length == 0 )
2161 return( PSA_SUCCESS );
2162
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2164 input, input_length );
2165 if( status != PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166 psa_hash_abort( operation );
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002167
2168 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169}
2170
2171psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2172 uint8_t *hash,
2173 size_t hash_size,
2174 size_t *hash_length )
2175{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002176 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002177 if( operation->id == 0 )
2178 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002179
Steven Cooreman1e582352021-02-18 17:24:37 +01002180 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002181 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002182 psa_hash_abort( operation );
2183 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002184}
2185
Gilles Peskine2d277862018-06-18 15:41:12 +02002186psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2187 const uint8_t *hash,
2188 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002189{
2190 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2191 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002192 psa_status_t status = psa_hash_finish(
2193 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002194 actual_hash, sizeof( actual_hash ),
2195 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002196 if( status != PSA_SUCCESS )
2197 return( status );
2198 if( actual_hash_length != hash_length )
2199 return( PSA_ERROR_INVALID_SIGNATURE );
2200 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2201 return( PSA_ERROR_INVALID_SIGNATURE );
2202 return( PSA_SUCCESS );
2203}
2204
Gilles Peskine0a749c82019-11-28 19:33:58 +01002205psa_status_t psa_hash_compute( psa_algorithm_t alg,
2206 const uint8_t *input, size_t input_length,
2207 uint8_t *hash, size_t hash_size,
2208 size_t *hash_length )
2209{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002210 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002211 if( !PSA_ALG_IS_HASH( alg ) )
2212 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002213
Steven Cooreman1e582352021-02-18 17:24:37 +01002214 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2215 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002216}
2217
2218psa_status_t psa_hash_compare( psa_algorithm_t alg,
2219 const uint8_t *input, size_t input_length,
2220 const uint8_t *hash, size_t hash_length )
2221{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002222 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2223 size_t actual_hash_length;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002224
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002225 if( !PSA_ALG_IS_HASH( alg ) )
2226 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002227
Steven Cooreman1e582352021-02-18 17:24:37 +01002228 psa_status_t status = psa_driver_wrapper_hash_compute(
2229 alg, input, input_length,
2230 actual_hash, sizeof(actual_hash),
2231 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002232 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002233 return( status );
2234 if( actual_hash_length != hash_length )
2235 return( PSA_ERROR_INVALID_SIGNATURE );
2236 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2237 return( PSA_ERROR_INVALID_SIGNATURE );
2238 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002239}
2240
Gilles Peskineeb35d782019-01-22 17:56:16 +01002241psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2242 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002243{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002244 if( source_operation->id == 0 ||
2245 target_operation->id != 0 )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002246 {
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002247 return( PSA_ERROR_BAD_STATE );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002248 }
2249
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002250 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2251 target_operation );
2252 if( status != PSA_SUCCESS )
2253 psa_hash_abort( target_operation );
2254
2255 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002256}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002257
2258
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002260/* MAC */
2261/****************************************************************/
2262
John Durkop6ba40d12020-11-10 08:50:04 -08002263#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002264static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002265{
Gilles Peskine2d277862018-06-18 15:41:12 +02002266 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002267 {
2268 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002269 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002270 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002271 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002272 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002273 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002274 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002275 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002276 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002277 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002278 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002279 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002280 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002281 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002282 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002283 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002284 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002285 return( 128 );
2286 default:
2287 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002288 }
2289}
John Durkop07cc04a2020-11-16 22:08:34 -08002290#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002291
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002292/* Initialize the MAC operation structure. Once this function has been
2293 * called, psa_mac_abort can run and will do the right thing. */
2294static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2295 psa_algorithm_t alg )
2296{
2297 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2298
Steven Cooreman15472f82021-03-02 16:16:22 +01002299 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002300 operation->key_set = 0;
2301 operation->iv_set = 0;
2302 operation->iv_required = 0;
2303 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002304 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002305
Ronald Cron3d471812021-03-18 13:40:31 +01002306#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002307 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002308 {
2309 operation->iv_required = 0;
2310 mbedtls_cipher_init( &operation->ctx.cmac );
2311 status = PSA_SUCCESS;
2312 }
2313 else
Ronald Cron3d471812021-03-18 13:40:31 +01002314#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002315#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002316 if( PSA_ALG_IS_HMAC( operation->alg ) )
2317 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002318 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002319 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002320 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002321 }
2322 else
John Durkopd0321952020-10-29 21:37:36 -07002323#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002324 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002325 if( ! PSA_ALG_IS_MAC( alg ) )
2326 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002327 }
2328
2329 if( status != PSA_SUCCESS )
2330 memset( operation, 0, sizeof( *operation ) );
2331 return( status );
2332}
2333
John Durkop6ba40d12020-11-10 08:50:04 -08002334#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002335static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2336{
Gilles Peskine3f108122018-12-07 18:14:53 +01002337 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002338 return( psa_hash_abort( &hmac->hash_ctx ) );
2339}
John Durkop6ba40d12020-11-10 08:50:04 -08002340#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002341
Gilles Peskine8c9def32018-02-08 10:02:12 +01002342psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2343{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002344 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002345 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002346 /* The object has (apparently) been initialized but it is not
2347 * in use. It's ok to call abort on such an object, and there's
2348 * nothing to do. */
2349 return( PSA_SUCCESS );
2350 }
2351 else
Ronald Cron3d471812021-03-18 13:40:31 +01002352#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002353 if( operation->alg == PSA_ALG_CMAC )
2354 {
2355 mbedtls_cipher_free( &operation->ctx.cmac );
2356 }
2357 else
Ronald Cron3d471812021-03-18 13:40:31 +01002358#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002359#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002360 if( PSA_ALG_IS_HMAC( operation->alg ) )
2361 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002362 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002363 }
2364 else
John Durkopd0321952020-10-29 21:37:36 -07002365#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002366 {
2367 /* Sanity check (shouldn't happen: operation->alg should
2368 * always have been initialized to a valid value). */
2369 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002370 }
Moran Peker41deec42018-04-04 15:43:05 +03002371
Gilles Peskine8c9def32018-02-08 10:02:12 +01002372 operation->alg = 0;
2373 operation->key_set = 0;
2374 operation->iv_set = 0;
2375 operation->iv_required = 0;
2376 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002377 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002378
Gilles Peskine8c9def32018-02-08 10:02:12 +01002379 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002380
2381bad_state:
2382 /* If abort is called on an uninitialized object, we can't trust
2383 * anything. Wipe the object in case it contains confidential data.
2384 * This may result in a memory leak if a pointer gets overwritten,
2385 * but it's too late to do anything about this. */
2386 memset( operation, 0, sizeof( *operation ) );
2387 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002388}
2389
Ronald Cron3d471812021-03-18 13:40:31 +01002390#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002391static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2392 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002393{
Janos Follath24eed8d2019-11-22 13:21:35 +00002394 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002395 const mbedtls_cipher_info_t *cipher_info =
2396 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2397 slot->attr.type, slot->attr.bits,
2398 NULL );
2399 if( cipher_info == NULL )
2400 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002401
2402 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2403 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002404 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002405
2406 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002407 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002408 slot->attr.bits );
2409exit:
2410 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002411}
Ronald Cron3d471812021-03-18 13:40:31 +01002412#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002413
John Durkop6ba40d12020-11-10 08:50:04 -08002414#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002415static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2416 const uint8_t *key,
2417 size_t key_length,
2418 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002419{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002420 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002421 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002422 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002423 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002424 psa_status_t status;
2425
Steven Cooreman0e307642021-02-18 16:18:32 +01002426 hmac->alg = hash_alg;
2427
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002428 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2429 * overflow below. This should never trigger if the hash algorithm
2430 * is implemented correctly. */
2431 /* The size checks against the ipad and opad buffers cannot be written
2432 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2433 * because that triggers -Wlogical-op on GCC 7.3. */
2434 if( block_size > sizeof( ipad ) )
2435 return( PSA_ERROR_NOT_SUPPORTED );
2436 if( block_size > sizeof( hmac->opad ) )
2437 return( PSA_ERROR_NOT_SUPPORTED );
2438 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002439 return( PSA_ERROR_NOT_SUPPORTED );
2440
Gilles Peskined223b522018-06-11 18:12:58 +02002441 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002442 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002443 status = psa_hash_compute( hash_alg, key, key_length,
2444 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002445 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002446 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002447 }
Gilles Peskine96889972018-07-12 17:07:03 +02002448 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2449 * but it is permitted. It is common when HMAC is used in HKDF, for
2450 * example. Don't call `memcpy` in the 0-length because `key` could be
2451 * an invalid pointer which would make the behavior undefined. */
2452 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002453 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002454
Gilles Peskined223b522018-06-11 18:12:58 +02002455 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2456 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002457 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002458 ipad[i] ^= 0x36;
2459 memset( ipad + key_length, 0x36, block_size - key_length );
2460
2461 /* Copy the key material from ipad to opad, flipping the requisite bits,
2462 * and filling the rest of opad with the requisite constant. */
2463 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002464 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2465 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002466
Gilles Peskine01126fa2018-07-12 17:04:55 +02002467 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002468 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002469 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002470
Gilles Peskine01126fa2018-07-12 17:04:55 +02002471 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002472
2473cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002474 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002475
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002476 return( status );
2477}
John Durkop6ba40d12020-11-10 08:50:04 -08002478#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002479
Gilles Peskine89167cb2018-07-08 20:12:23 +02002480static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002481 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002482 psa_algorithm_t alg,
2483 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002486 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002487 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002488 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002489 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002490
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002491 /* A context must be freshly initialized before it can be set up. */
2492 if( operation->alg != 0 )
2493 {
2494 return( PSA_ERROR_BAD_STATE );
2495 }
2496
Steven Cooreman15472f82021-03-02 16:16:22 +01002497 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002498 if( status != PSA_SUCCESS )
2499 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002500 if( is_sign )
2501 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002502
Ronald Cron5c522922020-11-14 16:35:34 +01002503 status = psa_get_and_lock_transparent_key_slot_with_policy(
2504 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002505 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002506 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002507
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002508 /* Validate the combination of key type and algorithm */
2509 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002510 if( status != PSA_SUCCESS )
2511 goto exit;
2512
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002513 /* Get the output length for the algorithm and key combination. None of the
2514 * currently supported algorithms have an output length dependent on actual
2515 * key size, so setting it to a bogus value is currently OK. */
2516 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002517
2518 if( operation->mac_size < 4 )
2519 {
2520 /* A very short MAC is too short for security since it can be
2521 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2522 * so we make this our minimum, even though 32 bits is still
2523 * too small for security. */
2524 status = PSA_ERROR_NOT_SUPPORTED;
2525 goto exit;
2526 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002527
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002528 if( operation->mac_size >
2529 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2530 {
2531 /* It's impossible to "truncate" to a larger length than the full length
2532 * of the algorithm. */
2533 status = PSA_ERROR_INVALID_ARGUMENT;
2534 goto exit;
2535 }
2536
Ronald Cron3d471812021-03-18 13:40:31 +01002537#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002538 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002539 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002540 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002541 }
2542 else
Ronald Cron3d471812021-03-18 13:40:31 +01002543#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002544#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002545 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002546 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002547 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002548 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002549 {
2550 status = PSA_ERROR_NOT_SUPPORTED;
2551 goto exit;
2552 }
2553
Gilles Peskine8e338702019-07-30 20:06:31 +02002554 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002555 {
2556 status = PSA_ERROR_INVALID_ARGUMENT;
2557 goto exit;
2558 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002559
Gilles Peskine01126fa2018-07-12 17:04:55 +02002560 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002561 slot->key.data,
2562 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002563 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002564 }
2565 else
John Durkopd0321952020-10-29 21:37:36 -07002566#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002567 {
2568 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002569 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002570
Gilles Peskinefbfac682018-07-08 20:51:54 +02002571exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002572 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002573 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002574 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002575 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002576 else
2577 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002578 operation->key_set = 1;
2579 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002580
Ronald Cron5c522922020-11-14 16:35:34 +01002581 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002582
Ronald Cron5c522922020-11-14 16:35:34 +01002583 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002584}
2585
Gilles Peskine89167cb2018-07-08 20:12:23 +02002586psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002587 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002588 psa_algorithm_t alg )
2589{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002590 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002591}
2592
2593psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002594 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002595 psa_algorithm_t alg )
2596{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002597 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002598}
2599
Gilles Peskine8c9def32018-02-08 10:02:12 +01002600psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2601 const uint8_t *input,
2602 size_t input_length )
2603{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002604 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002606 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002607 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002608 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002609 operation->has_input = 1;
2610
Ronald Cron3d471812021-03-18 13:40:31 +01002611#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002612 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002613 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002614 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2615 input, input_length );
2616 status = mbedtls_to_psa_error( ret );
2617 }
2618 else
Ronald Cron3d471812021-03-18 13:40:31 +01002619#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002620#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002621 if( PSA_ALG_IS_HMAC( operation->alg ) )
2622 {
2623 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2624 input_length );
2625 }
2626 else
John Durkopd0321952020-10-29 21:37:36 -07002627#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002628 {
2629 /* This shouldn't happen if `operation` was initialized by
2630 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002631 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002632 }
2633
Gilles Peskinefbfac682018-07-08 20:51:54 +02002634 if( status != PSA_SUCCESS )
2635 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002636 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002637}
2638
John Durkop6ba40d12020-11-10 08:50:04 -08002639#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002640static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2641 uint8_t *mac,
2642 size_t mac_size )
2643{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002644 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002645 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002646 size_t hash_size = 0;
2647 size_t block_size = psa_get_hash_block_size( hash_alg );
2648 psa_status_t status;
2649
Gilles Peskine01126fa2018-07-12 17:04:55 +02002650 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2651 if( status != PSA_SUCCESS )
2652 return( status );
2653 /* From here on, tmp needs to be wiped. */
2654
2655 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2656 if( status != PSA_SUCCESS )
2657 goto exit;
2658
2659 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2660 if( status != PSA_SUCCESS )
2661 goto exit;
2662
2663 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2664 if( status != PSA_SUCCESS )
2665 goto exit;
2666
Gilles Peskined911eb72018-08-14 15:18:45 +02002667 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2668 if( status != PSA_SUCCESS )
2669 goto exit;
2670
2671 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002672
2673exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002674 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002675 return( status );
2676}
John Durkop6ba40d12020-11-10 08:50:04 -08002677#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002678
mohammad16036df908f2018-04-02 08:34:15 -07002679static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002680 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002681 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002682{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002683 if( ! operation->key_set )
2684 return( PSA_ERROR_BAD_STATE );
2685 if( operation->iv_required && ! operation->iv_set )
2686 return( PSA_ERROR_BAD_STATE );
2687
Gilles Peskine8c9def32018-02-08 10:02:12 +01002688 if( mac_size < operation->mac_size )
2689 return( PSA_ERROR_BUFFER_TOO_SMALL );
2690
Ronald Cron3d471812021-03-18 13:40:31 +01002691#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002692 if( operation->alg == PSA_ALG_CMAC )
2693 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002694 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002695 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2696 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002697 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002698 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002699 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002700 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002701 else
Ronald Cron3d471812021-03-18 13:40:31 +01002702#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002703#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002704 if( PSA_ALG_IS_HMAC( operation->alg ) )
2705 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002706 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002707 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002708 }
2709 else
John Durkopd0321952020-10-29 21:37:36 -07002710#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002711 {
2712 /* This shouldn't happen if `operation` was initialized by
2713 * a setup function. */
2714 return( PSA_ERROR_BAD_STATE );
2715 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002716}
2717
Gilles Peskineacd4be32018-07-08 19:56:25 +02002718psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2719 uint8_t *mac,
2720 size_t mac_size,
2721 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002722{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002723 psa_status_t status;
2724
Jaeden Amero252ef282019-02-15 14:05:35 +00002725 if( operation->alg == 0 )
2726 {
2727 return( PSA_ERROR_BAD_STATE );
2728 }
2729
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002730 /* Fill the output buffer with something that isn't a valid mac
2731 * (barring an attack on the mac and deliberately-crafted input),
2732 * in case the caller doesn't check the return status properly. */
2733 *mac_length = mac_size;
2734 /* If mac_size is 0 then mac may be NULL and then the
2735 * call to memset would have undefined behavior. */
2736 if( mac_size != 0 )
2737 memset( mac, '!', mac_size );
2738
Gilles Peskine89167cb2018-07-08 20:12:23 +02002739 if( ! operation->is_sign )
2740 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002741 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002742 }
mohammad16036df908f2018-04-02 08:34:15 -07002743
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002744 status = psa_mac_finish_internal( operation, mac, mac_size );
2745
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002746 if( status == PSA_SUCCESS )
2747 {
2748 status = psa_mac_abort( operation );
2749 if( status == PSA_SUCCESS )
2750 *mac_length = operation->mac_size;
2751 else
2752 memset( mac, '!', mac_size );
2753 }
2754 else
2755 psa_mac_abort( operation );
2756 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002757}
2758
Gilles Peskineacd4be32018-07-08 19:56:25 +02002759psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2760 const uint8_t *mac,
2761 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002762{
Gilles Peskine828ed142018-06-18 23:25:51 +02002763 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002764 psa_status_t status;
2765
Jaeden Amero252ef282019-02-15 14:05:35 +00002766 if( operation->alg == 0 )
2767 {
2768 return( PSA_ERROR_BAD_STATE );
2769 }
2770
Gilles Peskine89167cb2018-07-08 20:12:23 +02002771 if( operation->is_sign )
2772 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002773 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002774 }
2775 if( operation->mac_size != mac_length )
2776 {
2777 status = PSA_ERROR_INVALID_SIGNATURE;
2778 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002779 }
mohammad16036df908f2018-04-02 08:34:15 -07002780
2781 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002782 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002783 if( status != PSA_SUCCESS )
2784 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002785
2786 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2787 status = PSA_ERROR_INVALID_SIGNATURE;
2788
2789cleanup:
2790 if( status == PSA_SUCCESS )
2791 status = psa_mac_abort( operation );
2792 else
2793 psa_mac_abort( operation );
2794
Gilles Peskine3f108122018-12-07 18:14:53 +01002795 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002796
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002797 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798}
2799
2800
Gilles Peskine20035e32018-02-03 22:44:14 +01002801
Gilles Peskine20035e32018-02-03 22:44:14 +01002802/****************************************************************/
2803/* Asymmetric cryptography */
2804/****************************************************************/
2805
Ronald Cron67b1eb32020-12-08 17:37:27 +01002806psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002807 const psa_key_attributes_t *attributes,
2808 const uint8_t *key_buffer, size_t key_buffer_size,
2809 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2810 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002811{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002812 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002813 {
Ronald Cron4501c982021-03-19 20:09:32 +01002814 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2815 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002816 {
Gilles Peskine20035e32018-02-03 22:44:14 +01002817#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2818 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron4501c982021-03-19 20:09:32 +01002819 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002820 attributes,
2821 key_buffer, key_buffer_size,
2822 alg, hash, hash_length,
2823 signature, signature_size, signature_length ) );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03002824#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02002825 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002826 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002827 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002828 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002829 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002830 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002831 }
2832 else
Ronald Cron4501c982021-03-19 20:09:32 +01002833 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002834 {
Ronald Cron4501c982021-03-19 20:09:32 +01002835 if( PSA_ALG_IS_ECDSA( alg ) )
2836 {
2837#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2838 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2839 return( mbedtls_psa_ecdsa_sign_hash(
2840 attributes,
2841 key_buffer, key_buffer_size,
2842 alg, hash, hash_length,
2843 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002844#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2845 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002846 }
2847 else
2848 {
2849 return( PSA_ERROR_INVALID_ARGUMENT );
2850 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002851 }
Ronald Cron4501c982021-03-19 20:09:32 +01002852
2853 (void)key_buffer;
2854 (void)key_buffer_size;
2855 (void)hash;
2856 (void)hash_length;
2857 (void)signature;
2858 (void)signature_size;
2859 (void)signature_length;
2860
2861 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002862}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002863
2864psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2865 psa_algorithm_t alg,
2866 const uint8_t *hash,
2867 size_t hash_length,
2868 uint8_t *signature,
2869 size_t signature_size,
2870 size_t *signature_length )
2871{
2872 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2873 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2874 psa_key_slot_t *slot;
2875
2876 *signature_length = signature_size;
2877 /* Immediately reject a zero-length signature buffer. This guarantees
2878 * that signature must be a valid pointer. (On the other hand, the hash
2879 * buffer can in principle be empty since it doesn't actually have
2880 * to be a hash.) */
2881 if( signature_size == 0 )
2882 return( PSA_ERROR_BUFFER_TOO_SMALL );
2883
2884 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
2885 PSA_KEY_USAGE_SIGN_HASH,
2886 alg );
2887 if( status != PSA_SUCCESS )
2888 goto exit;
2889 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2890 {
2891 status = PSA_ERROR_INVALID_ARGUMENT;
2892 goto exit;
2893 }
2894
Ronald Cron9f17aa42020-12-08 17:07:25 +01002895 psa_key_attributes_t attributes = {
2896 .core = slot->attr
2897 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002898
Ronald Cron9f17aa42020-12-08 17:07:25 +01002899 status = psa_driver_wrapper_sign_hash(
2900 &attributes, slot->key.data, slot->key.bytes,
2901 alg, hash, hash_length,
2902 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002903
2904exit:
2905 /* Fill the unused part of the output buffer (the whole buffer on error,
2906 * the trailing part on success) with something that isn't a valid mac
2907 * (barring an attack on the mac and deliberately-crafted input),
2908 * in case the caller doesn't check the return status properly. */
2909 if( status == PSA_SUCCESS )
2910 memset( signature + *signature_length, '!',
2911 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02002912 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002913 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002914 /* If signature_size is 0 then we have nothing to do. We must not call
2915 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02002916
Ronald Cron5c522922020-11-14 16:35:34 +01002917 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002918
Ronald Cron5c522922020-11-14 16:35:34 +01002919 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03002920}
2921
Ronald Cron67b1eb32020-12-08 17:37:27 +01002922psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002923 const psa_key_attributes_t *attributes,
2924 const uint8_t *key_buffer, size_t key_buffer_size,
2925 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2926 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002927{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002928 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002929 {
Ronald Cron4501c982021-03-19 20:09:32 +01002930 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2931 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002932 {
Ronald Cron4501c982021-03-19 20:09:32 +01002933#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2934 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2935 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002936 attributes,
2937 key_buffer, key_buffer_size,
2938 alg, hash, hash_length,
2939 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002940#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2941 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002942 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002943 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002944 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002945 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002946 }
itayzafrir5c753392018-05-08 11:18:38 +03002947 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002948 else
Ronald Cron4501c982021-03-19 20:09:32 +01002949 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002950 {
Ronald Cron4501c982021-03-19 20:09:32 +01002951 if( PSA_ALG_IS_ECDSA( alg ) )
2952 {
2953#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2954 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2955 return( mbedtls_psa_ecdsa_verify_hash(
2956 attributes,
2957 key_buffer, key_buffer_size,
2958 alg, hash, hash_length,
2959 signature, signature_length ) );
2960#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2961 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2962 }
2963 else
2964 {
2965 return( PSA_ERROR_INVALID_ARGUMENT );
2966 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002967 }
Ronald Cron4501c982021-03-19 20:09:32 +01002968
2969 (void)key_buffer;
2970 (void)key_buffer_size;
2971 (void)hash;
2972 (void)hash_length;
2973 (void)signature;
2974 (void)signature_length;
2975
2976 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002977}
2978
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002979psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2980 psa_algorithm_t alg,
2981 const uint8_t *hash,
2982 size_t hash_length,
2983 const uint8_t *signature,
2984 size_t signature_length )
2985{
2986 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2987 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03002988 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002989
2990 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002991 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02002992 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002993 if( status != PSA_SUCCESS )
2994 return( status );
2995
Ronald Cron9f17aa42020-12-08 17:07:25 +01002996 psa_key_attributes_t attributes = {
2997 .core = slot->attr
2998 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002999
Ronald Cron9f17aa42020-12-08 17:07:25 +01003000 status = psa_driver_wrapper_verify_hash(
3001 &attributes, slot->key.data, slot->key.bytes,
3002 alg, hash, hash_length,
3003 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003004
Ronald Cron5c522922020-11-14 16:35:34 +01003005 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003006
Ronald Cron5c522922020-11-14 16:35:34 +01003007 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003008}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003009
John Durkop0e005192020-10-31 22:06:54 -07003010#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003011static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3012 mbedtls_rsa_context *rsa )
3013{
3014 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3015 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3016 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3017 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3018}
John Durkop0e005192020-10-31 22:06:54 -07003019#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003020
Ronald Croncf56a0a2020-08-04 09:51:30 +02003021psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003022 psa_algorithm_t alg,
3023 const uint8_t *input,
3024 size_t input_length,
3025 const uint8_t *salt,
3026 size_t salt_length,
3027 uint8_t *output,
3028 size_t output_size,
3029 size_t *output_length )
3030{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003032 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003033 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003034
Darryl Green5cc689a2018-07-24 15:34:10 +01003035 (void) input;
3036 (void) input_length;
3037 (void) salt;
3038 (void) output;
3039 (void) output_size;
3040
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041 *output_length = 0;
3042
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003043 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3044 return( PSA_ERROR_INVALID_ARGUMENT );
3045
Ronald Cron5c522922020-11-14 16:35:34 +01003046 status = psa_get_and_lock_transparent_key_slot_with_policy(
3047 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003048 if( status != PSA_SUCCESS )
3049 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003050 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3051 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003052 {
3053 status = PSA_ERROR_INVALID_ARGUMENT;
3054 goto exit;
3055 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003056
John Durkop6ba40d12020-11-10 08:50:04 -08003057#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3058 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003059 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003060 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003061 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003062 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3063 slot->key.data,
3064 slot->key.bytes,
3065 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003066 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003067 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003068
3069 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003070 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003071 status = PSA_ERROR_BUFFER_TOO_SMALL;
3072 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003073 }
John Durkop0e005192020-10-31 22:06:54 -07003074#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3076 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003077 status = mbedtls_to_psa_error(
3078 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003079 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003080 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003081 MBEDTLS_RSA_PUBLIC,
3082 input_length,
3083 input,
3084 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003085 }
3086 else
John Durkop0e005192020-10-31 22:06:54 -07003087#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3088#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003089 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3090 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003091 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003092 status = mbedtls_to_psa_error(
3093 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003094 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003095 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003096 MBEDTLS_RSA_PUBLIC,
3097 salt, salt_length,
3098 input_length,
3099 input,
3100 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101 }
3102 else
John Durkop0e005192020-10-31 22:06:54 -07003103#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003105 status = PSA_ERROR_INVALID_ARGUMENT;
3106 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003107 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003108rsa_exit:
3109 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003110 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003111
Steven Cooremana2371e52020-07-28 14:30:39 +02003112 mbedtls_rsa_free( rsa );
3113 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114 }
3115 else
John Durkop9814fa22020-11-04 12:28:15 -08003116#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003117 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003118 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003119 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003121
3122exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003123 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003124
Ronald Cron5c522922020-11-14 16:35:34 +01003125 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003126}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127
Ronald Croncf56a0a2020-08-04 09:51:30 +02003128psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003129 psa_algorithm_t alg,
3130 const uint8_t *input,
3131 size_t input_length,
3132 const uint8_t *salt,
3133 size_t salt_length,
3134 uint8_t *output,
3135 size_t output_size,
3136 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003137{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003138 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003139 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003140 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003141
Darryl Green5cc689a2018-07-24 15:34:10 +01003142 (void) input;
3143 (void) input_length;
3144 (void) salt;
3145 (void) output;
3146 (void) output_size;
3147
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003148 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003149
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003150 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3151 return( PSA_ERROR_INVALID_ARGUMENT );
3152
Ronald Cron5c522922020-11-14 16:35:34 +01003153 status = psa_get_and_lock_transparent_key_slot_with_policy(
3154 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003155 if( status != PSA_SUCCESS )
3156 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003157 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003158 {
3159 status = PSA_ERROR_INVALID_ARGUMENT;
3160 goto exit;
3161 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162
John Durkop6ba40d12020-11-10 08:50:04 -08003163#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3164 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003165 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003167 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003168 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3169 slot->key.data,
3170 slot->key.bytes,
3171 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003172 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003173 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003174
Steven Cooremana2371e52020-07-28 14:30:39 +02003175 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003176 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003177 status = PSA_ERROR_INVALID_ARGUMENT;
3178 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003179 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003180
John Durkop0e005192020-10-31 22:06:54 -07003181#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003182 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003183 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003184 status = mbedtls_to_psa_error(
3185 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003186 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003187 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003188 MBEDTLS_RSA_PRIVATE,
3189 output_length,
3190 input,
3191 output,
3192 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003193 }
3194 else
John Durkop0e005192020-10-31 22:06:54 -07003195#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3196#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003197 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003198 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003199 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003200 status = mbedtls_to_psa_error(
3201 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003202 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003203 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003204 MBEDTLS_RSA_PRIVATE,
3205 salt, salt_length,
3206 output_length,
3207 input,
3208 output,
3209 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210 }
3211 else
John Durkop0e005192020-10-31 22:06:54 -07003212#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003213 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003214 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003215 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003216
Steven Cooreman4fed4552020-08-03 14:46:03 +02003217rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003218 mbedtls_rsa_free( rsa );
3219 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003220 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003221 else
John Durkop6ba40d12020-11-10 08:50:04 -08003222#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3223 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003224 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003225 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003226 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003227
3228exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003229 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003230
Ronald Cron5c522922020-11-14 16:35:34 +01003231 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003232}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003233
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003234
3235
mohammad1603503973b2018-03-12 15:59:30 +02003236/****************************************************************/
3237/* Symmetric cryptography */
3238/****************************************************************/
3239
Gilles Peskinee553c652018-06-04 16:22:46 +02003240static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003241 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003242 psa_algorithm_t alg,
3243 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003244{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003246 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003247 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003248 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3249 PSA_KEY_USAGE_ENCRYPT :
3250 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003251
Steven Cooremand3feccd2020-09-01 15:56:14 +02003252 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003253 if( operation->id != 0 )
Steven Cooremand3feccd2020-09-01 15:56:14 +02003254 return( PSA_ERROR_BAD_STATE );
3255
Steven Cooremana07b9972020-09-10 14:54:14 +02003256 /* The requested algorithm must be one that can be processed by cipher. */
3257 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003258 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003259
Steven Cooremanef8575e2020-09-11 11:44:50 +02003260 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003261 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003262 if( status != PSA_SUCCESS )
3263 goto exit;
3264
Ronald Cron49fafa92021-03-10 08:34:23 +01003265 /* Initialize the operation struct members, except for id. The id member
Steven Cooremanef8575e2020-09-11 11:44:50 +02003266 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003267 * so we only set it (in the driver wrapper) after resources have been
3268 * allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003269 operation->iv_set = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003270 if( alg == PSA_ALG_ECB_NO_PADDING )
3271 operation->iv_required = 0;
3272 else
3273 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003274 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003275
Ronald Crona4af55f2020-12-14 14:36:06 +01003276 psa_key_attributes_t attributes = {
3277 .core = slot->attr
3278 };
Steven Cooremana07b9972020-09-10 14:54:14 +02003279
Steven Cooremana07b9972020-09-10 14:54:14 +02003280 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003281 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003282 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3283 &attributes,
3284 slot->key.data,
3285 slot->key.bytes,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003286 alg );
3287 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003288 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3289 &attributes,
3290 slot->key.data,
3291 slot->key.bytes,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003292 alg );
3293
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003294exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003295 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003296 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003297
Ronald Cron5c522922020-11-14 16:35:34 +01003298 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003299
Ronald Cron5c522922020-11-14 16:35:34 +01003300 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003301}
3302
Gilles Peskinefe119512018-07-08 21:39:34 +02003303psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003304 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003305 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003306{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003307 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003308}
3309
Gilles Peskinefe119512018-07-08 21:39:34 +02003310psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003311 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003312 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003313{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003314 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003315}
3316
Gilles Peskinefe119512018-07-08 21:39:34 +02003317psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003318 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003319 size_t iv_size,
3320 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003321{
Ronald Cron6d051732020-10-01 14:10:20 +02003322 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003323
Ronald Cron5618a392021-03-26 09:52:26 +01003324 *iv_length = 0;
3325
Ronald Cron49fafa92021-03-10 08:34:23 +01003326 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003327 {
3328 return( PSA_ERROR_BAD_STATE );
3329 }
3330
Steven Cooreman7df02922020-09-09 15:28:49 +02003331 if( operation->iv_set || ! operation->iv_required )
3332 {
3333 return( PSA_ERROR_BAD_STATE );
3334 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003335
Ronald Cron5618a392021-03-26 09:52:26 +01003336 if( iv_size < operation->default_iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003337 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003338 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003339 goto exit;
3340 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003341
Ronald Cron5618a392021-03-26 09:52:26 +01003342 status = psa_generate_random( iv, operation->default_iv_length );
3343 if( status != PSA_SUCCESS )
3344 goto exit;
3345
3346 status = psa_driver_wrapper_cipher_set_iv( operation,
3347 iv,
3348 operation->default_iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003349
Moran Peker395db872018-05-31 14:07:14 +03003350exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003351 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003352 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003353 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003354 *iv_length = operation->default_iv_length;
3355 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003356 else
Moran Peker395db872018-05-31 14:07:14 +03003357 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003358
itayzafrir534bd7c2018-08-02 13:56:32 +03003359 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003360}
3361
Gilles Peskinefe119512018-07-08 21:39:34 +02003362psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003363 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003364 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003365{
Ronald Cron6d051732020-10-01 14:10:20 +02003366 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003367
Ronald Cron49fafa92021-03-10 08:34:23 +01003368 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003369 return( PSA_ERROR_BAD_STATE );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003370
mohammad1603503973b2018-03-12 15:59:30 +02003371 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03003372 return( PSA_ERROR_BAD_STATE );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003373
Ronald Crona0d68172021-03-26 10:15:08 +01003374 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3375 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad1603503973b2018-03-12 15:59:30 +02003376
Ronald Crondd24c9b2020-12-15 14:10:01 +01003377 status = psa_driver_wrapper_cipher_set_iv( operation,
3378 iv,
3379 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003380
itayzafrir534bd7c2018-08-02 13:56:32 +03003381 if( status == PSA_SUCCESS )
3382 operation->iv_set = 1;
3383 else
mohammad1603503973b2018-03-12 15:59:30 +02003384 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003385 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003386}
3387
Gilles Peskinee553c652018-06-04 16:22:46 +02003388psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3389 const uint8_t *input,
3390 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003391 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003392 size_t output_size,
3393 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003394{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003396
Ronald Cron49fafa92021-03-10 08:34:23 +01003397 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003398 {
3399 return( PSA_ERROR_BAD_STATE );
3400 }
3401 if( operation->iv_required && ! operation->iv_set )
3402 {
3403 return( PSA_ERROR_BAD_STATE );
3404 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003405
Ronald Crondd24c9b2020-12-15 14:10:01 +01003406 status = psa_driver_wrapper_cipher_update( operation,
3407 input,
3408 input_length,
3409 output,
3410 output_size,
3411 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003412 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003413 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003414
itayzafrir534bd7c2018-08-02 13:56:32 +03003415 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003416}
3417
Gilles Peskinee553c652018-06-04 16:22:46 +02003418psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3419 uint8_t *output,
3420 size_t output_size,
3421 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003422{
David Saadab4ecc272019-02-14 13:48:10 +02003423 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003424
Ronald Cron49fafa92021-03-10 08:34:23 +01003425 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003426 {
3427 return( PSA_ERROR_BAD_STATE );
3428 }
3429 if( operation->iv_required && ! operation->iv_set )
3430 {
3431 return( PSA_ERROR_BAD_STATE );
3432 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003433
Ronald Crondd24c9b2020-12-15 14:10:01 +01003434 status = psa_driver_wrapper_cipher_finish( operation,
3435 output,
3436 output_size,
3437 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003438 if( status == PSA_SUCCESS )
3439 return( psa_cipher_abort( operation ) );
3440 else
3441 {
3442 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003443 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003444
Steven Cooremanef8575e2020-09-11 11:44:50 +02003445 return( status );
3446 }
mohammad1603503973b2018-03-12 15:59:30 +02003447}
3448
Gilles Peskinee553c652018-06-04 16:22:46 +02003449psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3450{
Ronald Cron49fafa92021-03-10 08:34:23 +01003451 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003452 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003453 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003454 * in use. It's ok to call abort on such an object, and there's
3455 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003456 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003457 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003458
Ronald Crondd24c9b2020-12-15 14:10:01 +01003459 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003460
Ronald Cron49fafa92021-03-10 08:34:23 +01003461 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003462 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003463 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003464
Moran Peker395db872018-05-31 14:07:14 +03003465 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003466}
3467
mohammad16035955c982018-04-26 00:53:03 +03003468/****************************************************************/
3469/* AEAD */
3470/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003471
Ronald Croncf56a0a2020-08-04 09:51:30 +02003472psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003473 psa_algorithm_t alg,
3474 const uint8_t *nonce,
3475 size_t nonce_length,
3476 const uint8_t *additional_data,
3477 size_t additional_data_length,
3478 const uint8_t *plaintext,
3479 size_t plaintext_length,
3480 uint8_t *ciphertext,
3481 size_t ciphertext_size,
3482 size_t *ciphertext_length )
3483{
Ronald Cron215633c2021-03-16 17:15:37 +01003484 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3485 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003486
mohammad1603f08a5502018-06-03 15:05:47 +03003487 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003488
Steven Cooremanea7ab132021-03-17 16:28:00 +01003489 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3490 return( PSA_ERROR_NOT_SUPPORTED );
3491
Ronald Cron9a986162021-03-26 12:40:07 +01003492 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003493 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003494 if( status != PSA_SUCCESS )
3495 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003496
Ronald Cron215633c2021-03-16 17:15:37 +01003497 psa_key_attributes_t attributes = {
3498 .core = slot->attr
3499 };
mohammad16035955c982018-04-26 00:53:03 +03003500
Ronald Cronde822812021-03-17 16:08:20 +01003501 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003502 &attributes, slot->key.data, slot->key.bytes,
3503 alg,
3504 nonce, nonce_length,
3505 additional_data, additional_data_length,
3506 plaintext, plaintext_length,
3507 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003508
Gilles Peskineedf9a652018-08-17 18:11:56 +02003509 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3510 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003511
Ronald Cron9f310172021-03-16 16:36:37 +01003512 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003513
mohammad16035955c982018-04-26 00:53:03 +03003514 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003515}
3516
Ronald Croncf56a0a2020-08-04 09:51:30 +02003517psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003518 psa_algorithm_t alg,
3519 const uint8_t *nonce,
3520 size_t nonce_length,
3521 const uint8_t *additional_data,
3522 size_t additional_data_length,
3523 const uint8_t *ciphertext,
3524 size_t ciphertext_length,
3525 uint8_t *plaintext,
3526 size_t plaintext_size,
3527 size_t *plaintext_length )
3528{
Ronald Cron215633c2021-03-16 17:15:37 +01003529 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3530 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003531
Gilles Peskineee652a32018-06-01 19:23:52 +02003532 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003533
Steven Cooremanea7ab132021-03-17 16:28:00 +01003534 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3535 return( PSA_ERROR_NOT_SUPPORTED );
3536
Ronald Cron9a986162021-03-26 12:40:07 +01003537 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003538 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003539 if( status != PSA_SUCCESS )
3540 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003541
Ronald Cron215633c2021-03-16 17:15:37 +01003542 psa_key_attributes_t attributes = {
3543 .core = slot->attr
3544 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003545
Ronald Cronde822812021-03-17 16:08:20 +01003546 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003547 &attributes, slot->key.data, slot->key.bytes,
3548 alg,
3549 nonce, nonce_length,
3550 additional_data, additional_data_length,
3551 ciphertext, ciphertext_length,
3552 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003553
Gilles Peskineedf9a652018-08-17 18:11:56 +02003554 if( status != PSA_SUCCESS && plaintext_size != 0 )
3555 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003556
Ronald Cron215633c2021-03-16 17:15:37 +01003557 psa_unlock_key_slot( slot );
3558
Gilles Peskineedf9a652018-08-17 18:11:56 +02003559 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003560}
3561
Gilles Peskinee59236f2018-01-27 23:32:46 +01003562/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003563/* Generators */
3564/****************************************************************/
3565
John Durkop07cc04a2020-11-16 22:08:34 -08003566#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3567 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3568 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3569#define AT_LEAST_ONE_BUILTIN_KDF
3570#endif
3571
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003572#define HKDF_STATE_INIT 0 /* no input yet */
3573#define HKDF_STATE_STARTED 1 /* got salt */
3574#define HKDF_STATE_KEYED 2 /* got key */
3575#define HKDF_STATE_OUTPUT 3 /* output started */
3576
Gilles Peskinecbe66502019-05-16 16:59:18 +02003577static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003578 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003579{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003580 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3581 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003582 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003583 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003584}
3585
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003586psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003587{
3588 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003589 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003590 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003591 {
3592 /* The object has (apparently) been initialized but it is not
3593 * in use. It's ok to call abort on such an object, and there's
3594 * nothing to do. */
3595 }
3596 else
John Durkopd0321952020-10-29 21:37:36 -07003597#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003598 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003599 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003600 mbedtls_free( operation->ctx.hkdf.info );
3601 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003602 }
John Durkop07cc04a2020-11-16 22:08:34 -08003603 else
3604#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3605#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3606 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3607 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003608 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003609 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003610 {
Janos Follath6a1d2622019-06-11 10:37:28 +01003611 if( operation->ctx.tls12_prf.seed != NULL )
3612 {
3613 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3614 operation->ctx.tls12_prf.seed_length );
3615 mbedtls_free( operation->ctx.tls12_prf.seed );
3616 }
3617
3618 if( operation->ctx.tls12_prf.label != NULL )
3619 {
3620 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3621 operation->ctx.tls12_prf.label_length );
3622 mbedtls_free( operation->ctx.tls12_prf.label );
3623 }
3624
3625 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
3626
3627 /* We leave the fields Ai and output_block to be erased safely by the
3628 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003629 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003630 else
John Durkop07cc04a2020-11-16 22:08:34 -08003631#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3632 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003633 {
3634 status = PSA_ERROR_BAD_STATE;
3635 }
Janos Follath083036a2019-06-11 10:22:26 +01003636 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003637 return( status );
3638}
3639
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003640psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003641 size_t *capacity)
3642{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003643 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003644 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003645 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003646 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003647 }
3648
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003649 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003650 return( PSA_SUCCESS );
3651}
3652
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003653psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003654 size_t capacity )
3655{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003656 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003657 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003658 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003659 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003660 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003661 return( PSA_SUCCESS );
3662}
3663
John Durkopd0321952020-10-29 21:37:36 -07003664#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003665/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003666 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003667static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003668 psa_algorithm_t hash_alg,
3669 uint8_t *output,
3670 size_t output_length )
3671{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003672 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003673 psa_status_t status;
3674
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003675 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3676 return( PSA_ERROR_BAD_STATE );
3677 hkdf->state = HKDF_STATE_OUTPUT;
3678
Gilles Peskinebef7f142018-07-12 17:22:21 +02003679 while( output_length != 0 )
3680 {
3681 /* Copy what remains of the current block */
3682 uint8_t n = hash_length - hkdf->offset_in_block;
3683 if( n > output_length )
3684 n = (uint8_t) output_length;
3685 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3686 output += n;
3687 output_length -= n;
3688 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003689 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003690 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003691 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003692 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003693 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003694 * object was corrupted or if this function is called directly
3695 * inside the library. */
3696 if( hkdf->block_number == 0xff )
3697 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003698
3699 /* We need a new block */
3700 ++hkdf->block_number;
3701 hkdf->offset_in_block = 0;
3702 status = psa_hmac_setup_internal( &hkdf->hmac,
3703 hkdf->prk, hash_length,
3704 hash_alg );
3705 if( status != PSA_SUCCESS )
3706 return( status );
3707 if( hkdf->block_number != 1 )
3708 {
3709 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3710 hkdf->output_block,
3711 hash_length );
3712 if( status != PSA_SUCCESS )
3713 return( status );
3714 }
3715 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3716 hkdf->info,
3717 hkdf->info_length );
3718 if( status != PSA_SUCCESS )
3719 return( status );
3720 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3721 &hkdf->block_number, 1 );
3722 if( status != PSA_SUCCESS )
3723 return( status );
3724 status = psa_hmac_finish_internal( &hkdf->hmac,
3725 hkdf->output_block,
3726 sizeof( hkdf->output_block ) );
3727 if( status != PSA_SUCCESS )
3728 return( status );
3729 }
3730
3731 return( PSA_SUCCESS );
3732}
John Durkop07cc04a2020-11-16 22:08:34 -08003733#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003734
John Durkop07cc04a2020-11-16 22:08:34 -08003735#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3736 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003737static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3738 psa_tls12_prf_key_derivation_t *tls12_prf,
3739 psa_algorithm_t alg )
3740{
3741 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003742 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01003743 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
3744 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003745
Janos Follath7742fee2019-06-17 12:58:10 +01003746 /* We can't be wanting more output after block 0xff, otherwise
3747 * the capacity check in psa_key_derivation_output_bytes() would have
3748 * prevented this call. It could happen only if the operation
3749 * object was corrupted or if this function is called directly
3750 * inside the library. */
3751 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003752 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003753
3754 /* We need a new block */
3755 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003756 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003757
3758 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3759 *
3760 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3761 *
3762 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3763 * HMAC_hash(secret, A(2) + seed) +
3764 * HMAC_hash(secret, A(3) + seed) + ...
3765 *
3766 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003767 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003768 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003769 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003770 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003771 * is currently extracted as `output_block` and where i is
3772 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003773 */
3774
Janos Follathea29bfb2019-06-19 12:21:20 +01003775 /* Save the hash context before using it, to preserve the hash state with
3776 * only the inner padding in it. We need this, because inner padding depends
3777 * on the key (secret in the RFC's terminology). */
3778 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
3779 if( status != PSA_SUCCESS )
3780 goto cleanup;
3781
3782 /* Calculate A(i) where i = tls12_prf->block_number. */
3783 if( tls12_prf->block_number == 1 )
3784 {
3785 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3786 * the variable seed and in this instance means it in the context of the
3787 * P_hash function, where seed = label + seed.) */
3788 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3789 tls12_prf->label, tls12_prf->label_length );
3790 if( status != PSA_SUCCESS )
3791 goto cleanup;
3792 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3793 tls12_prf->seed, tls12_prf->seed_length );
3794 if( status != PSA_SUCCESS )
3795 goto cleanup;
3796 }
3797 else
3798 {
3799 /* A(i) = HMAC_hash(secret, A(i-1)) */
3800 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3801 tls12_prf->Ai, hash_length );
3802 if( status != PSA_SUCCESS )
3803 goto cleanup;
3804 }
3805
3806 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3807 tls12_prf->Ai, hash_length );
3808 if( status != PSA_SUCCESS )
3809 goto cleanup;
3810 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3811 if( status != PSA_SUCCESS )
3812 goto cleanup;
3813
3814 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
3815 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3816 tls12_prf->Ai, hash_length );
3817 if( status != PSA_SUCCESS )
3818 goto cleanup;
3819 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3820 tls12_prf->label, tls12_prf->label_length );
3821 if( status != PSA_SUCCESS )
3822 goto cleanup;
3823 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3824 tls12_prf->seed, tls12_prf->seed_length );
3825 if( status != PSA_SUCCESS )
3826 goto cleanup;
3827 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3828 tls12_prf->output_block, hash_length );
3829 if( status != PSA_SUCCESS )
3830 goto cleanup;
3831 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3832 if( status != PSA_SUCCESS )
3833 goto cleanup;
3834
Janos Follath7742fee2019-06-17 12:58:10 +01003835
3836cleanup:
3837
Janos Follathea29bfb2019-06-19 12:21:20 +01003838 cleanup_status = psa_hash_abort( &backup );
3839 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3840 status = cleanup_status;
3841
3842 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003843}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003844
Janos Follath844eb0e2019-06-19 12:10:49 +01003845static psa_status_t psa_key_derivation_tls12_prf_read(
3846 psa_tls12_prf_key_derivation_t *tls12_prf,
3847 psa_algorithm_t alg,
3848 uint8_t *output,
3849 size_t output_length )
3850{
3851 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003852 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003853 psa_status_t status;
3854 uint8_t offset, length;
3855
3856 while( output_length != 0 )
3857 {
3858 /* Check if we have fully processed the current block. */
3859 if( tls12_prf->left_in_block == 0 )
3860 {
3861 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3862 alg );
3863 if( status != PSA_SUCCESS )
3864 return( status );
3865
3866 continue;
3867 }
3868
3869 if( tls12_prf->left_in_block > output_length )
3870 length = (uint8_t) output_length;
3871 else
3872 length = tls12_prf->left_in_block;
3873
3874 offset = hash_length - tls12_prf->left_in_block;
3875 memcpy( output, tls12_prf->output_block + offset, length );
3876 output += length;
3877 output_length -= length;
3878 tls12_prf->left_in_block -= length;
3879 }
3880
3881 return( PSA_SUCCESS );
3882}
John Durkop07cc04a2020-11-16 22:08:34 -08003883#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3884 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003885
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003886psa_status_t psa_key_derivation_output_bytes(
3887 psa_key_derivation_operation_t *operation,
3888 uint8_t *output,
3889 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003890{
3891 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003892 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003893
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003894 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003895 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003896 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003897 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003898 }
3899
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003900 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003901 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003902 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003903 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003904 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003905 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003906 goto exit;
3907 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003908 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003909 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003910 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003911 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003912 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3913 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003914 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003915 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003916 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003917 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003918 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003919
John Durkopd0321952020-10-29 21:37:36 -07003920#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003921 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003922 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003923 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003924 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003925 output, output_length );
3926 }
Janos Follathadbec812019-06-14 11:05:39 +01003927 else
John Durkop07cc04a2020-11-16 22:08:34 -08003928#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3929#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3930 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003931 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003932 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003933 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003934 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003935 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003936 output_length );
3937 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003938 else
John Durkop07cc04a2020-11-16 22:08:34 -08003939#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3940 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003941 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003942 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003943 return( PSA_ERROR_BAD_STATE );
3944 }
3945
3946exit:
3947 if( status != PSA_SUCCESS )
3948 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003949 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003950 * This allows us to differentiate between exhausted operations and
3951 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3952 * operations. */
3953 psa_algorithm_t alg = operation->alg;
3954 psa_key_derivation_abort( operation );
3955 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003956 memset( output, '!', output_length );
3957 }
3958 return( status );
3959}
3960
David Brown7807bf72021-02-09 16:28:23 -07003961#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003962static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3963{
3964 if( data_size >= 8 )
3965 mbedtls_des_key_set_parity( data );
3966 if( data_size >= 16 )
3967 mbedtls_des_key_set_parity( data + 8 );
3968 if( data_size >= 24 )
3969 mbedtls_des_key_set_parity( data + 16 );
3970}
David Brown7807bf72021-02-09 16:28:23 -07003971#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003972
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003973static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003974 psa_key_slot_t *slot,
3975 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003976 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003977{
3978 uint8_t *data = NULL;
3979 size_t bytes = PSA_BITS_TO_BYTES( bits );
3980 psa_status_t status;
3981
Gilles Peskine8e338702019-07-30 20:06:31 +02003982 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003983 return( PSA_ERROR_INVALID_ARGUMENT );
3984 if( bits % 8 != 0 )
3985 return( PSA_ERROR_INVALID_ARGUMENT );
3986 data = mbedtls_calloc( 1, bytes );
3987 if( data == NULL )
3988 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3989
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003990 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003991 if( status != PSA_SUCCESS )
3992 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003993#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003994 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003995 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003996#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003997
3998 status = psa_allocate_buffer_to_slot( slot, bytes );
3999 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004000 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004001
Ronald Cronbf33c932020-11-28 18:06:53 +01004002 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004003 psa_key_attributes_t attributes = {
4004 .core = slot->attr
4005 };
4006
Ronald Cronbf33c932020-11-28 18:06:53 +01004007 status = psa_driver_wrapper_import_key( &attributes,
4008 data, bytes,
4009 slot->key.data,
4010 slot->key.bytes,
4011 &slot->key.bytes, &bits );
4012 if( bits != slot->attr.bits )
4013 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004014
4015exit:
4016 mbedtls_free( data );
4017 return( status );
4018}
4019
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004020psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004021 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004022 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004023{
4024 psa_status_t status;
4025 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004026 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004027
Ronald Cron81709fc2020-11-14 12:10:32 +01004028 *key = MBEDTLS_SVC_KEY_ID_INIT;
4029
Gilles Peskine0f84d622019-09-12 19:03:13 +02004030 /* Reject any attempt to create a zero-length key so that we don't
4031 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4032 if( psa_get_key_bits( attributes ) == 0 )
4033 return( PSA_ERROR_INVALID_ARGUMENT );
4034
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004035 if( ! operation->can_output_key )
4036 return( PSA_ERROR_NOT_PERMITTED );
4037
Ronald Cron81709fc2020-11-14 12:10:32 +01004038 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4039 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4041 if( driver != NULL )
4042 {
4043 /* Deriving a key in a secure element is not implemented yet. */
4044 status = PSA_ERROR_NOT_SUPPORTED;
4045 }
4046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004047 if( status == PSA_SUCCESS )
4048 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004049 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004050 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004051 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004052 }
4053 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004054 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004055 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004056 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004057
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004058 return( status );
4059}
4060
Gilles Peskineeab56e42018-07-12 17:12:33 +02004061
4062
4063/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004064/* Key derivation */
4065/****************************************************************/
4066
Steven Cooreman932ffb72021-02-15 12:14:32 +01004067#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004068static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004069 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004070 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004071{
John Durkop07cc04a2020-11-16 22:08:34 -08004072 int is_kdf_alg_supported;
4073
Janos Follath5fe19732019-06-20 15:09:30 +01004074 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4075 * initialisers for this union leave some bytes unspecified.) */
4076 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4077
Gilles Peskine969c5d62019-01-16 15:53:06 +01004078 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004079#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004080 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4081 is_kdf_alg_supported = 1;
4082 else
4083#endif
4084#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4085 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4086 is_kdf_alg_supported = 1;
4087 else
4088#endif
4089#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4090 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4091 is_kdf_alg_supported = 1;
4092 else
4093#endif
4094 is_kdf_alg_supported = 0;
4095
4096 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004097 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004098 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004099 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004100 if( hash_size == 0 )
4101 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004102 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4103 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004104 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004105 {
4106 return( PSA_ERROR_NOT_SUPPORTED );
4107 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004108 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004109 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004110 }
John Durkop07cc04a2020-11-16 22:08:34 -08004111
4112 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004113}
John Durkop07cc04a2020-11-16 22:08:34 -08004114#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004115
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004116psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004117 psa_algorithm_t alg )
4118{
4119 psa_status_t status;
4120
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004121 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004122 return( PSA_ERROR_BAD_STATE );
4123
Gilles Peskine6843c292019-01-18 16:44:49 +01004124 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4125 return( PSA_ERROR_INVALID_ARGUMENT );
4126 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004127 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004128#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004129 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004130 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004131#else
4132 return( PSA_ERROR_NOT_SUPPORTED );
4133#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004134 }
4135 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4136 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004137#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004138 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004139#else
4140 return( PSA_ERROR_NOT_SUPPORTED );
4141#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004142 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004143 else
4144 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004145
4146 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004147 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004148 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004149}
4150
John Durkopd0321952020-10-29 21:37:36 -07004151#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004152static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004153 psa_algorithm_t hash_alg,
4154 psa_key_derivation_step_t step,
4155 const uint8_t *data,
4156 size_t data_length )
4157{
4158 psa_status_t status;
4159 switch( step )
4160 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004161 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004162 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004163 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004164 status = psa_hmac_setup_internal( &hkdf->hmac,
4165 data, data_length,
4166 hash_alg );
4167 if( status != PSA_SUCCESS )
4168 return( status );
4169 hkdf->state = HKDF_STATE_STARTED;
4170 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004171 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004172 /* If no salt was provided, use an empty salt. */
4173 if( hkdf->state == HKDF_STATE_INIT )
4174 {
4175 status = psa_hmac_setup_internal( &hkdf->hmac,
4176 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004177 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004178 if( status != PSA_SUCCESS )
4179 return( status );
4180 hkdf->state = HKDF_STATE_STARTED;
4181 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004182 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004183 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004184 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4185 data, data_length );
4186 if( status != PSA_SUCCESS )
4187 return( status );
4188 status = psa_hmac_finish_internal( &hkdf->hmac,
4189 hkdf->prk,
4190 sizeof( hkdf->prk ) );
4191 if( status != PSA_SUCCESS )
4192 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004193 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004194 hkdf->block_number = 0;
4195 hkdf->state = HKDF_STATE_KEYED;
4196 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004197 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004198 if( hkdf->state == HKDF_STATE_OUTPUT )
4199 return( PSA_ERROR_BAD_STATE );
4200 if( hkdf->info_set )
4201 return( PSA_ERROR_BAD_STATE );
4202 hkdf->info_length = data_length;
4203 if( data_length != 0 )
4204 {
4205 hkdf->info = mbedtls_calloc( 1, data_length );
4206 if( hkdf->info == NULL )
4207 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4208 memcpy( hkdf->info, data, data_length );
4209 }
4210 hkdf->info_set = 1;
4211 return( PSA_SUCCESS );
4212 default:
4213 return( PSA_ERROR_INVALID_ARGUMENT );
4214 }
4215}
John Durkop07cc04a2020-11-16 22:08:34 -08004216#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004217
John Durkop07cc04a2020-11-16 22:08:34 -08004218#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4219 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004220static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4221 const uint8_t *data,
4222 size_t data_length )
4223{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004224 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004225 return( PSA_ERROR_BAD_STATE );
4226
Janos Follathd6dce9f2019-07-04 09:11:38 +01004227 if( data_length != 0 )
4228 {
4229 prf->seed = mbedtls_calloc( 1, data_length );
4230 if( prf->seed == NULL )
4231 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004232
Janos Follathd6dce9f2019-07-04 09:11:38 +01004233 memcpy( prf->seed, data, data_length );
4234 prf->seed_length = data_length;
4235 }
Janos Follathf08e2652019-06-13 09:05:41 +01004236
Gilles Peskine43f958b2020-12-13 14:55:14 +01004237 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004238
4239 return( PSA_SUCCESS );
4240}
4241
Janos Follath81550542019-06-13 14:26:34 +01004242static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4243 psa_algorithm_t hash_alg,
4244 const uint8_t *data,
4245 size_t data_length )
4246{
4247 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004248 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004249 return( PSA_ERROR_BAD_STATE );
4250
4251 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4252 if( status != PSA_SUCCESS )
4253 return( status );
4254
Gilles Peskine43f958b2020-12-13 14:55:14 +01004255 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004256
4257 return( PSA_SUCCESS );
4258}
4259
Janos Follath63028dd2019-06-13 09:15:47 +01004260static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4261 const uint8_t *data,
4262 size_t data_length )
4263{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004264 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004265 return( PSA_ERROR_BAD_STATE );
4266
Janos Follathd6dce9f2019-07-04 09:11:38 +01004267 if( data_length != 0 )
4268 {
4269 prf->label = mbedtls_calloc( 1, data_length );
4270 if( prf->label == NULL )
4271 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004272
Janos Follathd6dce9f2019-07-04 09:11:38 +01004273 memcpy( prf->label, data, data_length );
4274 prf->label_length = data_length;
4275 }
Janos Follath63028dd2019-06-13 09:15:47 +01004276
Gilles Peskine43f958b2020-12-13 14:55:14 +01004277 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004278
4279 return( PSA_SUCCESS );
4280}
4281
Janos Follathb03233e2019-06-11 15:30:30 +01004282static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4283 psa_algorithm_t hash_alg,
4284 psa_key_derivation_step_t step,
4285 const uint8_t *data,
4286 size_t data_length )
4287{
Janos Follathb03233e2019-06-11 15:30:30 +01004288 switch( step )
4289 {
Janos Follathf08e2652019-06-13 09:05:41 +01004290 case PSA_KEY_DERIVATION_INPUT_SEED:
4291 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004292 case PSA_KEY_DERIVATION_INPUT_SECRET:
4293 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004294 case PSA_KEY_DERIVATION_INPUT_LABEL:
4295 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004296 default:
4297 return( PSA_ERROR_INVALID_ARGUMENT );
4298 }
4299}
John Durkop07cc04a2020-11-16 22:08:34 -08004300#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4301 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4302
4303#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4304static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4305 psa_tls12_prf_key_derivation_t *prf,
4306 psa_algorithm_t hash_alg,
4307 const uint8_t *data,
4308 size_t data_length )
4309{
4310 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004311 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004312 uint8_t *cur = pms;
4313
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004314 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004315 return( PSA_ERROR_INVALID_ARGUMENT );
4316
4317 /* Quoting RFC 4279, Section 2:
4318 *
4319 * The premaster secret is formed as follows: if the PSK is N octets
4320 * long, concatenate a uint16 with the value N, N zero octets, a second
4321 * uint16 with the value N, and the PSK itself.
4322 */
4323
4324 *cur++ = ( data_length >> 8 ) & 0xff;
4325 *cur++ = ( data_length >> 0 ) & 0xff;
4326 memset( cur, 0, data_length );
4327 cur += data_length;
4328 *cur++ = pms[0];
4329 *cur++ = pms[1];
4330 memcpy( cur, data, data_length );
4331 cur += data_length;
4332
4333 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
4334
4335 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4336 return( status );
4337}
Janos Follath6660f0e2019-06-17 08:44:03 +01004338
4339static psa_status_t psa_tls12_prf_psk_to_ms_input(
4340 psa_tls12_prf_key_derivation_t *prf,
4341 psa_algorithm_t hash_alg,
4342 psa_key_derivation_step_t step,
4343 const uint8_t *data,
4344 size_t data_length )
4345{
4346 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004347 {
Janos Follath6660f0e2019-06-17 08:44:03 +01004348 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
4349 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004350 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004351
4352 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
4353}
John Durkop07cc04a2020-11-16 22:08:34 -08004354#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004355
Gilles Peskineb8965192019-09-24 16:21:10 +02004356/** Check whether the given key type is acceptable for the given
4357 * input step of a key derivation.
4358 *
4359 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4360 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4361 * Both secret and non-secret inputs can alternatively have the type
4362 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4363 * that the input was passed as a buffer rather than via a key object.
4364 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004365static int psa_key_derivation_check_input_type(
4366 psa_key_derivation_step_t step,
4367 psa_key_type_t key_type )
4368{
4369 switch( step )
4370 {
4371 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004372 if( key_type == PSA_KEY_TYPE_DERIVE )
4373 return( PSA_SUCCESS );
4374 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004375 return( PSA_SUCCESS );
4376 break;
4377 case PSA_KEY_DERIVATION_INPUT_LABEL:
4378 case PSA_KEY_DERIVATION_INPUT_SALT:
4379 case PSA_KEY_DERIVATION_INPUT_INFO:
4380 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004381 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4382 return( PSA_SUCCESS );
4383 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004384 return( PSA_SUCCESS );
4385 break;
4386 }
4387 return( PSA_ERROR_INVALID_ARGUMENT );
4388}
4389
Janos Follathb80a94e2019-06-12 15:54:46 +01004390static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004391 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004392 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004393 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004394 const uint8_t *data,
4395 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004396{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004397 psa_status_t status;
4398 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4399
4400 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004401 if( status != PSA_SUCCESS )
4402 goto exit;
4403
John Durkopd0321952020-10-29 21:37:36 -07004404#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004405 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004406 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004407 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004408 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004409 step, data, data_length );
4410 }
John Durkop07cc04a2020-11-16 22:08:34 -08004411 else
4412#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4413#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4414 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004415 {
Janos Follathb03233e2019-06-11 15:30:30 +01004416 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
4417 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4418 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004419 }
John Durkop07cc04a2020-11-16 22:08:34 -08004420 else
4421#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4422#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4423 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004424 {
4425 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
4426 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4427 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004428 }
4429 else
John Durkop07cc04a2020-11-16 22:08:34 -08004430#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004431 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004432 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004433 (void) data;
4434 (void) data_length;
4435 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004436 return( PSA_ERROR_BAD_STATE );
4437 }
4438
Gilles Peskine224b0d62019-09-23 18:13:17 +02004439exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004440 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004441 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004442 return( status );
4443}
4444
Janos Follath51f4a0f2019-06-14 11:35:55 +01004445psa_status_t psa_key_derivation_input_bytes(
4446 psa_key_derivation_operation_t *operation,
4447 psa_key_derivation_step_t step,
4448 const uint8_t *data,
4449 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004450{
Gilles Peskineb8965192019-09-24 16:21:10 +02004451 return( psa_key_derivation_input_internal( operation, step,
4452 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004453 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004454}
4455
Janos Follath51f4a0f2019-06-14 11:35:55 +01004456psa_status_t psa_key_derivation_input_key(
4457 psa_key_derivation_operation_t *operation,
4458 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004459 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004460{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004461 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004462 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004463 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004464
Ronald Cron5c522922020-11-14 16:35:34 +01004465 status = psa_get_and_lock_transparent_key_slot_with_policy(
4466 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004467 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004468 {
4469 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004470 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004471 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004472
4473 /* Passing a key object as a SECRET input unlocks the permission
4474 * to output to a key object. */
4475 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4476 operation->can_output_key = 1;
4477
Ronald Cronf95a2b12020-10-22 15:24:49 +02004478 status = psa_key_derivation_input_internal( operation,
4479 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004480 slot->key.data,
4481 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004482
Ronald Cron5c522922020-11-14 16:35:34 +01004483 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004484
Ronald Cron5c522922020-11-14 16:35:34 +01004485 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004486}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004487
4488
4489
4490/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004491/* Key agreement */
4492/****************************************************************/
4493
John Durkop6ba40d12020-11-10 08:50:04 -08004494#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004495static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4496 size_t peer_key_length,
4497 const mbedtls_ecp_keypair *our_key,
4498 uint8_t *shared_secret,
4499 size_t shared_secret_size,
4500 size_t *shared_secret_length )
4501{
Steven Cooremand4867872020-08-05 16:31:39 +02004502 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004503 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004504 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004505 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004506 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004507 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004508
Ronald Cron90857082020-11-25 14:58:33 +01004509 status = mbedtls_psa_ecp_load_representation(
4510 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004511 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004512 peer_key,
4513 peer_key_length,
4514 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004515 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004516 goto exit;
4517
Jaeden Amero97271b32019-01-10 19:38:51 +00004518 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004519 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004520 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004521 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004522 status = mbedtls_to_psa_error(
4523 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4524 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004525 goto exit;
4526
Jaeden Amero97271b32019-01-10 19:38:51 +00004527 status = mbedtls_to_psa_error(
4528 mbedtls_ecdh_calc_secret( &ecdh,
4529 shared_secret_length,
4530 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004531 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004532 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004533 if( status != PSA_SUCCESS )
4534 goto exit;
4535 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4536 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004537
4538exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004539 if( status != PSA_SUCCESS )
4540 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004541 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004542 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004543 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004544
Jaeden Amero97271b32019-01-10 19:38:51 +00004545 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004546}
John Durkop6ba40d12020-11-10 08:50:04 -08004547#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004548
Gilles Peskine01d718c2018-09-18 12:01:02 +02004549#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4550
Gilles Peskine0216fe12019-04-11 21:23:21 +02004551static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4552 psa_key_slot_t *private_key,
4553 const uint8_t *peer_key,
4554 size_t peer_key_length,
4555 uint8_t *shared_secret,
4556 size_t shared_secret_size,
4557 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004558{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004559 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004560 {
John Durkop6ba40d12020-11-10 08:50:04 -08004561#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004562 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004563 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004564 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004565 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004566 psa_status_t status = mbedtls_psa_ecp_load_representation(
4567 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004568 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004569 private_key->key.data,
4570 private_key->key.bytes,
4571 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004572 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004573 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004574 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004575 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004576 shared_secret, shared_secret_size,
4577 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004578 mbedtls_ecp_keypair_free( ecp );
4579 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004580 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004581#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004582 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004583 (void) private_key;
4584 (void) peer_key;
4585 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004586 (void) shared_secret;
4587 (void) shared_secret_size;
4588 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004589 return( PSA_ERROR_NOT_SUPPORTED );
4590 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004591}
4592
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004593/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004594 * to potentially free embedded data structures and wipe confidential data.
4595 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004596static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004597 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004598 psa_key_slot_t *private_key,
4599 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004600 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004601{
4602 psa_status_t status;
4603 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4604 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004605 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004606
4607 /* Step 1: run the secret agreement algorithm to generate the shared
4608 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004609 status = psa_key_agreement_raw_internal( ka_alg,
4610 private_key,
4611 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004612 shared_secret,
4613 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004614 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004615 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004616 goto exit;
4617
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004618 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004619 * the shared secret. A shared secret is permitted wherever a key
4620 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004621 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004622 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004623 shared_secret,
4624 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004625exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004626 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004627 return( status );
4628}
4629
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004630psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004631 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004632 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004633 const uint8_t *peer_key,
4634 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004635{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004636 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004637 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004638 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004639
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004640 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004641 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004642 status = psa_get_and_lock_transparent_key_slot_with_policy(
4643 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004644 if( status != PSA_SUCCESS )
4645 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004646 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004647 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004648 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004649 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004650 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004651 else
4652 {
4653 /* If a private key has been added as SECRET, we allow the derived
4654 * key material to be used as a key in PSA Crypto. */
4655 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4656 operation->can_output_key = 1;
4657 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004658
Ronald Cron5c522922020-11-14 16:35:34 +01004659 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004660
Ronald Cron5c522922020-11-14 16:35:34 +01004661 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004662}
4663
Gilles Peskinebe697d82019-05-16 18:00:41 +02004664psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004665 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004666 const uint8_t *peer_key,
4667 size_t peer_key_length,
4668 uint8_t *output,
4669 size_t output_size,
4670 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004671{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004672 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004673 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004674 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004675
4676 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4677 {
4678 status = PSA_ERROR_INVALID_ARGUMENT;
4679 goto exit;
4680 }
Ronald Cron5c522922020-11-14 16:35:34 +01004681 status = psa_get_and_lock_transparent_key_slot_with_policy(
4682 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004683 if( status != PSA_SUCCESS )
4684 goto exit;
4685
4686 status = psa_key_agreement_raw_internal( alg, slot,
4687 peer_key, peer_key_length,
4688 output, output_size,
4689 output_length );
4690
4691exit:
4692 if( status != PSA_SUCCESS )
4693 {
4694 /* If an error happens and is not handled properly, the output
4695 * may be used as a key to protect sensitive data. Arrange for such
4696 * a key to be random, which is likely to result in decryption or
4697 * verification errors. This is better than filling the buffer with
4698 * some constant data such as zeros, which would result in the data
4699 * being protected with a reproducible, easily knowable key.
4700 */
4701 psa_generate_random( output, output_size );
4702 *output_length = output_size;
4703 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004704
Ronald Cron5c522922020-11-14 16:35:34 +01004705 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004706
Ronald Cron5c522922020-11-14 16:35:34 +01004707 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004708}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004709
4710
Gilles Peskine30524eb2020-11-13 17:02:26 +01004711
Gilles Peskine86a440b2018-11-12 18:39:40 +01004712/****************************************************************/
4713/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004714/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004715
Gilles Peskine30524eb2020-11-13 17:02:26 +01004716/** Initialize the PSA random generator.
4717 */
4718static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4719{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004720#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4721 memset( rng, 0, sizeof( *rng ) );
4722#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4723
Gilles Peskine30524eb2020-11-13 17:02:26 +01004724 /* Set default configuration if
4725 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4726 if( rng->entropy_init == NULL )
4727 rng->entropy_init = mbedtls_entropy_init;
4728 if( rng->entropy_free == NULL )
4729 rng->entropy_free = mbedtls_entropy_free;
4730
4731 rng->entropy_init( &rng->entropy );
4732#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4733 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4734 /* The PSA entropy injection feature depends on using NV seed as an entropy
4735 * source. Add NV seed as an entropy source for PSA entropy injection. */
4736 mbedtls_entropy_add_source( &rng->entropy,
4737 mbedtls_nv_seed_poll, NULL,
4738 MBEDTLS_ENTROPY_BLOCK_SIZE,
4739 MBEDTLS_ENTROPY_SOURCE_STRONG );
4740#endif
4741
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004742 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004743#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004744}
4745
4746/** Deinitialize the PSA random generator.
4747 */
4748static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4749{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004750#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4751 memset( rng, 0, sizeof( *rng ) );
4752#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004753 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004754 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004755#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004756}
4757
4758/** Seed the PSA random generator.
4759 */
4760static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4761{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004762#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4763 /* Do nothing: the external RNG seeds itself. */
4764 (void) rng;
4765 return( PSA_SUCCESS );
4766#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004767 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004768 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4769 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004770 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004771#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004772}
4773
Gilles Peskinee59236f2018-01-27 23:32:46 +01004774psa_status_t psa_generate_random( uint8_t *output,
4775 size_t output_size )
4776{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004777 GUARD_MODULE_INITIALIZED;
4778
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004779#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4780
4781 size_t output_length = 0;
4782 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4783 output, output_size,
4784 &output_length );
4785 if( status != PSA_SUCCESS )
4786 return( status );
4787 /* Breaking up a request into smaller chunks is currently not supported
4788 * for the extrernal RNG interface. */
4789 if( output_length != output_size )
4790 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4791 return( PSA_SUCCESS );
4792
4793#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4794
Gilles Peskine71ddab92021-01-04 21:01:07 +01004795 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004796 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004797 size_t request_size =
4798 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4799 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4800 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004801 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4802 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004803 if( ret != 0 )
4804 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004805 output_size -= request_size;
4806 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004807 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004808 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004809#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004810}
4811
Gilles Peskine8814fc42020-12-14 15:33:44 +01004812/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004813 *
4814 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4815 * `psa_generate_random(...)`. The state parameter is ignored since the
4816 * PSA API doesn't support passing an explicit state.
4817 *
4818 * In the non-external case, psa_generate_random() calls an
4819 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4820 * and semantics as mbedtls_psa_get_random(). As an optimization,
4821 * instead of doing this back-and-forth between the PSA API and the
4822 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4823 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004824 */
4825#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4826int mbedtls_psa_get_random( void *p_rng,
4827 unsigned char *output,
4828 size_t output_size )
4829{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004830 /* This function takes a pointer to the RNG state because that's what
4831 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4832 * its own state internally and doesn't let the caller access that state.
4833 * So we just ignore the state parameter, and in practice we'll pass
4834 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004835 (void) p_rng;
4836 psa_status_t status = psa_generate_random( output, output_size );
4837 if( status == PSA_SUCCESS )
4838 return( 0 );
4839 else
4840 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4841}
4842#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4843
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004844#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004845#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004846
Gilles Peskine7228da22019-07-15 11:06:15 +02004847psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004848 size_t seed_size )
4849{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004850 if( global_data.initialized )
4851 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004852
4853 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4854 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4855 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4856 return( PSA_ERROR_INVALID_ARGUMENT );
4857
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004858 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004859}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004860#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004861
Ronald Cron3772afe2021-02-08 16:10:05 +01004862/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004863 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004864 * \param type The key type
4865 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004866 *
4867 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004868 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004869 * \retval #PSA_ERROR_INVALID_ARGUMENT
4870 * The size in bits of the key is not valid.
4871 * \retval #PSA_ERROR_NOT_SUPPORTED
4872 * The type and/or the size in bits of the key or the combination of
4873 * the two is not supported.
4874 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004875static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4876 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004877{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004878 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004879
Gilles Peskinee59236f2018-01-27 23:32:46 +01004880 if( key_type_is_raw_bytes( type ) )
4881 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004882 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004883 if( status != PSA_SUCCESS )
4884 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004885 }
4886 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004887#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004888 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4889 {
4890 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4891 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004892
Ronald Cron01b2aba2020-10-05 09:42:02 +02004893 /* Accept only byte-aligned keys, for the same reasons as
4894 * in psa_import_rsa_key(). */
4895 if( bits % 8 != 0 )
4896 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004897 }
4898 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004899#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004900
Ronald Cron5c4d3862020-12-07 11:07:24 +01004901#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004902 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4903 {
Ronald Crond81ab562021-02-16 09:01:16 +01004904 /* To avoid empty block, return successfully here. */
4905 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004906 }
4907 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004908#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004909 {
4910 return( PSA_ERROR_NOT_SUPPORTED );
4911 }
4912
4913 return( PSA_SUCCESS );
4914}
4915
Ronald Cron55ed0592020-10-05 10:30:40 +02004916psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004917 const psa_key_attributes_t *attributes,
4918 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004919{
4920 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004921 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004922
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004923 if( ( attributes->domain_parameters == NULL ) &&
4924 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004925 return( PSA_ERROR_INVALID_ARGUMENT );
4926
Ronald Cron01b2aba2020-10-05 09:42:02 +02004927 if( key_type_is_raw_bytes( type ) )
4928 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004929 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004930 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004931 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004932
David Brown12ca5032021-02-11 11:02:00 -07004933#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004934 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004935 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004936#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004937 }
4938 else
4939
John Durkop07cc04a2020-11-16 22:08:34 -08004940#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004941 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004942 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004943 return( mbedtls_psa_rsa_generate_key( attributes,
4944 key_buffer,
4945 key_buffer_size,
4946 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004947 }
4948 else
John Durkop07cc04a2020-11-16 22:08:34 -08004949#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004950
John Durkop9814fa22020-11-04 12:28:15 -08004951#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004952 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004953 {
Ronald Cron7023db52020-11-20 18:17:42 +01004954 return( mbedtls_psa_ecp_generate_key( attributes,
4955 key_buffer,
4956 key_buffer_size,
4957 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004958 }
4959 else
John Durkop9814fa22020-11-04 12:28:15 -08004960#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004961 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004962 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004963 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004964 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004965
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004966 return( PSA_SUCCESS );
4967}
Darryl Green0c6575a2018-11-07 16:05:30 +00004968
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004969psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004970 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004971{
4972 psa_status_t status;
4973 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004974 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004975 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004976
Ronald Cron81709fc2020-11-14 12:10:32 +01004977 *key = MBEDTLS_SVC_KEY_ID_INIT;
4978
Gilles Peskine0f84d622019-09-12 19:03:13 +02004979 /* Reject any attempt to create a zero-length key so that we don't
4980 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4981 if( psa_get_key_bits( attributes ) == 0 )
4982 return( PSA_ERROR_INVALID_ARGUMENT );
4983
Ronald Cron81709fc2020-11-14 12:10:32 +01004984 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4985 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004986 if( status != PSA_SUCCESS )
4987 goto exit;
4988
Ronald Cron977c2472020-10-13 08:32:21 +02004989 /* In the case of a transparent key or an opaque key stored in local
4990 * storage (thus not in the case of generating a key in a secure element
4991 * or cryptoprocessor with storage), we have to allocate a buffer to
4992 * hold the generated key material. */
4993 if( slot->key.data == NULL )
4994 {
4995 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4996 PSA_KEY_LOCATION_LOCAL_STORAGE )
4997 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004998 status = psa_validate_key_type_and_size_for_key_generation(
4999 attributes->core.type, attributes->core.bits );
5000 if( status != PSA_SUCCESS )
5001 goto exit;
5002
5003 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5004 attributes->core.type,
5005 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005006 }
5007 else
5008 {
5009 status = psa_driver_wrapper_get_key_buffer_size(
5010 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005011 if( status != PSA_SUCCESS )
5012 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005013 }
Ronald Cron977c2472020-10-13 08:32:21 +02005014
5015 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5016 if( status != PSA_SUCCESS )
5017 goto exit;
5018 }
5019
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005020 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005021 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005022
Ronald Cron2b56bc82020-10-05 10:02:26 +02005023 if( status != PSA_SUCCESS )
5024 psa_remove_key_data_from_memory( slot );
5025
Gilles Peskine11792082019-08-06 18:36:36 +02005026exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005027 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005028 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005029 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005030 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005031
Darryl Green0c6575a2018-11-07 16:05:30 +00005032 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005033}
5034
Gilles Peskinee59236f2018-01-27 23:32:46 +01005035/****************************************************************/
5036/* Module setup */
5037/****************************************************************/
5038
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005039#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005040psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5041 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5042 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5043{
5044 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5045 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005046 global_data.rng.entropy_init = entropy_init;
5047 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005048 return( PSA_SUCCESS );
5049}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005050#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005051
Gilles Peskinee59236f2018-01-27 23:32:46 +01005052void mbedtls_psa_crypto_free( void )
5053{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005054 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005055 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5056 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005057 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005058 }
5059 /* Wipe all remaining data, including configuration.
5060 * In particular, this sets all state indicator to the value
5061 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005062 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005063#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005064 /* Unregister all secure element drivers, so that we restart from
5065 * a pristine state. */
5066 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005067#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005068}
5069
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005070#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5071/** Recover a transaction that was interrupted by a power failure.
5072 *
5073 * This function is called during initialization, before psa_crypto_init()
5074 * returns. If this function returns a failure status, the initialization
5075 * fails.
5076 */
5077static psa_status_t psa_crypto_recover_transaction(
5078 const psa_crypto_transaction_t *transaction )
5079{
5080 switch( transaction->unknown.type )
5081 {
5082 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5083 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005084 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005085 * is implemented.
5086 * https://github.com/ARMmbed/mbed-crypto/issues/218
5087 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005088 default:
5089 /* We found an unsupported transaction in the storage.
5090 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005091 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005092 }
5093}
5094#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5095
Gilles Peskinee59236f2018-01-27 23:32:46 +01005096psa_status_t psa_crypto_init( void )
5097{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005098 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005099
Gilles Peskinec6b69072018-11-20 21:42:52 +01005100 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005101 if( global_data.initialized != 0 )
5102 return( PSA_SUCCESS );
5103
Gilles Peskine30524eb2020-11-13 17:02:26 +01005104 /* Initialize and seed the random generator. */
5105 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005106 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005107 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005108 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005109 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005110 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005111
Gilles Peskine66fb1262018-12-10 16:29:04 +01005112 status = psa_initialize_key_slots( );
5113 if( status != PSA_SUCCESS )
5114 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005115
Gilles Peskined9348f22019-10-01 15:22:29 +02005116#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5117 status = psa_init_all_se_drivers( );
5118 if( status != PSA_SUCCESS )
5119 goto exit;
5120#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5121
Gilles Peskine4b734222019-07-24 15:56:31 +02005122#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005123 status = psa_crypto_load_transaction( );
5124 if( status == PSA_SUCCESS )
5125 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005126 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5127 if( status != PSA_SUCCESS )
5128 goto exit;
5129 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005130 }
5131 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5132 {
5133 /* There's no transaction to complete. It's all good. */
5134 status = PSA_SUCCESS;
5135 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005136#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005137
Gilles Peskinec6b69072018-11-20 21:42:52 +01005138 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005139 global_data.initialized = 1;
5140
5141exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005142 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005143 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005144 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005145}
5146
5147#endif /* MBEDTLS_PSA_CRYPTO_C */