blob: f91e5c3227d5f8977a9eb3ec5b82cd12621bad22 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020061#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000062#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020063#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/blowfish.h"
65#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020066#include "mbedtls/chacha20.h"
67#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/cipher.h"
69#include "mbedtls/ccm.h"
70#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020072#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010073#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010074#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/error.h"
76#include "mbedtls/gcm.h"
77#include "mbedtls/md2.h"
78#include "mbedtls/md4.h"
79#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010080#include "mbedtls/md.h"
81#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010082#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010084#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000085#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010086#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010087#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010088#include "mbedtls/sha1.h"
89#include "mbedtls/sha256.h"
90#include "mbedtls/sha512.h"
91#include "mbedtls/xtea.h"
92
Gilles Peskine996deb12018-08-01 15:45:45 +020093#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
94
Gilles Peskine9ef733f2018-02-07 21:05:37 +010095/* constant-time buffer comparison */
96static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
97{
98 size_t i;
99 unsigned char diff = 0;
100
101 for( i = 0; i < n; i++ )
102 diff |= a[i] ^ b[i];
103
104 return( diff );
105}
106
107
108
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100109/****************************************************************/
110/* Global data, support functions and library management */
111/****************************************************************/
112
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200113static int key_type_is_raw_bytes( psa_key_type_t type )
114{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200115 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200116}
117
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100118/* Values for psa_global_data_t::rng_state */
119#define RNG_NOT_INITIALIZED 0
120#define RNG_INITIALIZED 1
121#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100122
Gilles Peskine2d277862018-06-18 15:41:12 +0200123typedef struct
124{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100125 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100126 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100127 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100128} psa_global_data_t;
129
130static psa_global_data_t global_data;
131
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100132#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
133mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
134 &global_data.rng.drbg;
135#endif
136
itayzafrir0adf0fc2018-09-06 16:24:41 +0300137#define GUARD_MODULE_INITIALIZED \
138 if( global_data.initialized == 0 ) \
139 return( PSA_ERROR_BAD_STATE );
140
Steven Cooreman01164162020-07-20 15:31:37 +0200141psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100142{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100143 /* Mbed TLS error codes can combine a high-level error code and a
144 * low-level error code. The low-level error usually reflects the
145 * root cause better, so dispatch on that preferably. */
146 int low_level_ret = - ( -ret & 0x007f );
147 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100148 {
149 case 0:
150 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100151
152 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
153 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
154 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
155 return( PSA_ERROR_NOT_SUPPORTED );
156 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
157 return( PSA_ERROR_HARDWARE_FAILURE );
158
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200159 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
160 return( PSA_ERROR_HARDWARE_FAILURE );
161
Gilles Peskine9a944802018-06-21 09:35:35 +0200162 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
163 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
164 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
165 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
166 case MBEDTLS_ERR_ASN1_INVALID_DATA:
167 return( PSA_ERROR_INVALID_ARGUMENT );
168 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
169 return( PSA_ERROR_INSUFFICIENT_MEMORY );
170 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
171 return( PSA_ERROR_BUFFER_TOO_SMALL );
172
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000174 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000175#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
176 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
177#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100178 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
179 return( PSA_ERROR_NOT_SUPPORTED );
180 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
181 return( PSA_ERROR_HARDWARE_FAILURE );
182
Jaeden Amero93e21112019-02-20 13:57:28 +0000183#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000184 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000185#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
186 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
187#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100188 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
191 return( PSA_ERROR_HARDWARE_FAILURE );
192
193 case MBEDTLS_ERR_CCM_BAD_INPUT:
194 return( PSA_ERROR_INVALID_ARGUMENT );
195 case MBEDTLS_ERR_CCM_AUTH_FAILED:
196 return( PSA_ERROR_INVALID_SIGNATURE );
197 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
198 return( PSA_ERROR_HARDWARE_FAILURE );
199
Gilles Peskine26869f22019-05-06 15:25:00 +0200200 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
201 return( PSA_ERROR_INVALID_ARGUMENT );
202
203 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
204 return( PSA_ERROR_BAD_STATE );
205 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
206 return( PSA_ERROR_INVALID_SIGNATURE );
207
Gilles Peskinea5905292018-02-07 20:59:33 +0100208 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
209 return( PSA_ERROR_NOT_SUPPORTED );
210 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
211 return( PSA_ERROR_INVALID_ARGUMENT );
212 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
213 return( PSA_ERROR_INSUFFICIENT_MEMORY );
214 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
215 return( PSA_ERROR_INVALID_PADDING );
216 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
219 return( PSA_ERROR_INVALID_SIGNATURE );
220 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200221 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
223 return( PSA_ERROR_HARDWARE_FAILURE );
224
225 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
226 return( PSA_ERROR_HARDWARE_FAILURE );
227
Gilles Peskine82e57d12020-11-13 21:31:17 +0100228#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
229 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100230 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
231 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100232 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
233 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
234 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
235 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
236 return( PSA_ERROR_NOT_SUPPORTED );
237 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
238 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100239#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100240
241 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
242 return( PSA_ERROR_NOT_SUPPORTED );
243 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
244 return( PSA_ERROR_HARDWARE_FAILURE );
245
Gilles Peskinee59236f2018-01-27 23:32:46 +0100246 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
247 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
248 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100250
251 case MBEDTLS_ERR_GCM_AUTH_FAILED:
252 return( PSA_ERROR_INVALID_SIGNATURE );
253 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200254 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
256 return( PSA_ERROR_HARDWARE_FAILURE );
257
Gilles Peskine82e57d12020-11-13 21:31:17 +0100258#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
259 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100260 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
261 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100262 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
263 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
264 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
265 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
268 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
269#endif
270
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200271 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
272 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
273 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
274 return( PSA_ERROR_HARDWARE_FAILURE );
275
Gilles Peskinea5905292018-02-07 20:59:33 +0100276 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
277 return( PSA_ERROR_NOT_SUPPORTED );
278 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_MD_ALLOC_FAILED:
281 return( PSA_ERROR_INSUFFICIENT_MEMORY );
282 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
283 return( PSA_ERROR_STORAGE_FAILURE );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200284 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
285 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100286
Gilles Peskinef76aa772018-10-29 19:24:33 +0100287 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
288 return( PSA_ERROR_STORAGE_FAILURE );
289 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
290 return( PSA_ERROR_INVALID_ARGUMENT );
291 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
292 return( PSA_ERROR_INVALID_ARGUMENT );
293 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
294 return( PSA_ERROR_BUFFER_TOO_SMALL );
295 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
296 return( PSA_ERROR_INVALID_ARGUMENT );
297 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
298 return( PSA_ERROR_INVALID_ARGUMENT );
299 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
300 return( PSA_ERROR_INVALID_ARGUMENT );
301 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
303
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100304 case MBEDTLS_ERR_PK_ALLOC_FAILED:
305 return( PSA_ERROR_INSUFFICIENT_MEMORY );
306 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
307 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
308 return( PSA_ERROR_INVALID_ARGUMENT );
309 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100310 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100311 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
312 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
313 return( PSA_ERROR_INVALID_ARGUMENT );
314 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
315 return( PSA_ERROR_NOT_SUPPORTED );
316 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
317 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
318 return( PSA_ERROR_NOT_PERMITTED );
319 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
320 return( PSA_ERROR_INVALID_ARGUMENT );
321 case MBEDTLS_ERR_PK_INVALID_ALG:
322 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
323 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
324 return( PSA_ERROR_NOT_SUPPORTED );
325 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
326 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329
Gilles Peskineff2d2002019-05-06 15:26:23 +0200330 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
331 return( PSA_ERROR_HARDWARE_FAILURE );
332 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
333 return( PSA_ERROR_NOT_SUPPORTED );
334
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200335 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
336 return( PSA_ERROR_HARDWARE_FAILURE );
337
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
339 return( PSA_ERROR_INVALID_ARGUMENT );
340 case MBEDTLS_ERR_RSA_INVALID_PADDING:
341 return( PSA_ERROR_INVALID_PADDING );
342 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
343 return( PSA_ERROR_HARDWARE_FAILURE );
344 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
345 return( PSA_ERROR_INVALID_ARGUMENT );
346 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
347 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200348 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100349 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
350 return( PSA_ERROR_INVALID_SIGNATURE );
351 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
352 return( PSA_ERROR_BUFFER_TOO_SMALL );
353 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100354 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100355 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
356 return( PSA_ERROR_NOT_SUPPORTED );
357 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
358 return( PSA_ERROR_HARDWARE_FAILURE );
359
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200360 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
361 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
362 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
363 return( PSA_ERROR_HARDWARE_FAILURE );
364
Gilles Peskinea5905292018-02-07 20:59:33 +0100365 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
366 return( PSA_ERROR_INVALID_ARGUMENT );
367 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
368 return( PSA_ERROR_HARDWARE_FAILURE );
369
itayzafrir5c753392018-05-08 11:18:38 +0300370 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300372 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300373 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
374 return( PSA_ERROR_BUFFER_TOO_SMALL );
375 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
376 return( PSA_ERROR_NOT_SUPPORTED );
377 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
378 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
379 return( PSA_ERROR_INVALID_SIGNATURE );
380 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
381 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100382 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
383 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300384 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
385 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100386
Janos Follatha13b9052019-11-22 12:48:59 +0000387 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
388 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300389
Gilles Peskinee59236f2018-01-27 23:32:46 +0100390 default:
David Saadab4ecc272019-02-14 13:48:10 +0200391 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100392 }
393}
394
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200395
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200396
397
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100398/****************************************************************/
399/* Key management */
400/****************************************************************/
401
Gilles Peskine73167e12019-07-12 23:44:37 +0200402#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
403static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
404{
Gilles Peskine8e338702019-07-30 20:06:31 +0200405 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200406}
407#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
408
John Durkop07cc04a2020-11-16 22:08:34 -0800409/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
410 * current test driver in key_management.c is using this function
411 * when accelerators are used for ECC key pair and public key.
412 * Once that dependency is resolved these guards can be removed.
413 */
John Durkop9814fa22020-11-04 12:28:15 -0800414#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800415 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
416 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
417 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100418mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100419 size_t bits,
420 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200421{
422 switch( curve )
423 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100424 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100427#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100428 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100429 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100430#endif
431#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100432 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100433 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100434#endif
435#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100436 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100437 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100438#endif
439#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100440 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100441 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100442#endif
443#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100445 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100446 case 528:
447 if( bits_is_sloppy )
448 return( MBEDTLS_ECP_DP_SECP521R1 );
449 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100450#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100451 }
452 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100453
Paul Elliott8ff510a2020-06-02 17:19:28 +0100454 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100455 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100456 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100457#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100458 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100459 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100460#endif
461#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100462 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100463 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100464#endif
465#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100466 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100467 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100468#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100469 }
470 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100471
Paul Elliott8ff510a2020-06-02 17:19:28 +0100472 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100473 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100474 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100475#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100476 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100477 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100478 case 256:
479 if( bits_is_sloppy )
480 return( MBEDTLS_ECP_DP_CURVE25519 );
481 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100482#endif
483#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100484 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100485 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100486#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100487 }
488 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100489
Paul Elliott8ff510a2020-06-02 17:19:28 +0100490 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100491 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100492 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100493#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100494 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100495 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100496#endif
497#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100498 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100499 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100500#endif
501#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100502 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100503 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100504#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100505 }
506 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200507 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100508
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100509 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100510 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200511}
John Durkop9814fa22020-11-04 12:28:15 -0800512#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800513 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
514 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
515 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200516
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200517static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
518 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200519{
520 /* Check that the bit size is acceptable for the key type */
521 switch( type )
522 {
523 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200524 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200525 case PSA_KEY_TYPE_DERIVE:
526 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100527#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200528 case PSA_KEY_TYPE_AES:
529 if( bits != 128 && bits != 192 && bits != 256 )
530 return( PSA_ERROR_INVALID_ARGUMENT );
531 break;
532#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100533#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200534 case PSA_KEY_TYPE_CAMELLIA:
535 if( bits != 128 && bits != 192 && bits != 256 )
536 return( PSA_ERROR_INVALID_ARGUMENT );
537 break;
538#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100539#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200540 case PSA_KEY_TYPE_DES:
541 if( bits != 64 && bits != 128 && bits != 192 )
542 return( PSA_ERROR_INVALID_ARGUMENT );
543 break;
544#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100545#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200546 case PSA_KEY_TYPE_ARC4:
547 if( bits < 8 || bits > 2048 )
548 return( PSA_ERROR_INVALID_ARGUMENT );
549 break;
550#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100551#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200552 case PSA_KEY_TYPE_CHACHA20:
553 if( bits != 256 )
554 return( PSA_ERROR_INVALID_ARGUMENT );
555 break;
556#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200557 default:
558 return( PSA_ERROR_NOT_SUPPORTED );
559 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200560 if( bits % 8 != 0 )
561 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200562
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200563 return( PSA_SUCCESS );
564}
565
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100566/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100567 *
Steven Cooremancd640932021-03-08 12:00:27 +0100568 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
569 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100570 *
571 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100572 * \param[in] key_type The key type of the key to be used with the
573 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100574 *
575 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100576 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100577 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100578 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100579 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100580MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100581 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100582 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100583{
Steven Cooremancd640932021-03-08 12:00:27 +0100584 if( PSA_ALG_IS_HMAC( algorithm ) )
585 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100586 if( key_type == PSA_KEY_TYPE_HMAC )
587 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100588 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100589
590 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100591 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100592 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
593 * key. */
594 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
595 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
596 {
597 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
598 * the block length (larger than 1) for block ciphers. */
599 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
600 return( PSA_SUCCESS );
601 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100602 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100603
604 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100605}
606
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200607psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
608 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200609{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100610 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200611 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200612
Ronald Cronea0f8a62020-11-25 17:52:23 +0100613 slot->key.data = mbedtls_calloc( 1, buffer_length );
614 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200615 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200616
Ronald Cronea0f8a62020-11-25 17:52:23 +0100617 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200618 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200619}
620
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200621psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
622 const uint8_t* data,
623 size_t data_length )
624{
625 psa_status_t status = psa_allocate_buffer_to_slot( slot,
626 data_length );
627 if( status != PSA_SUCCESS )
628 return( status );
629
Ronald Cronea0f8a62020-11-25 17:52:23 +0100630 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200631 return( PSA_SUCCESS );
632}
633
Ronald Crona0fe59f2020-11-29 11:14:53 +0100634psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 const psa_key_attributes_t *attributes,
636 const uint8_t *data, size_t data_length,
637 uint8_t *key_buffer, size_t key_buffer_size,
638 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100639{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100640 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
641 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100642
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200643 /* zero-length keys are never supported. */
644 if( data_length == 0 )
645 return( PSA_ERROR_NOT_SUPPORTED );
646
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100647 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100648 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100649 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200650
Steven Cooreman75b74362020-07-28 14:30:13 +0200651 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
652 if( data_length > SIZE_MAX / 8 )
653 return( PSA_ERROR_NOT_SUPPORTED );
654
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200655 /* Enforce a size limit, and in particular ensure that the bit
656 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100657 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200658 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200659
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100660 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200661 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200662 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200663
Ronald Crondd04d422020-11-28 15:14:42 +0100664 /* Copy the key material. */
665 memcpy( key_buffer, data, data_length );
666 *key_buffer_length = data_length;
667 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200668
Steven Cooreman40120f62020-10-29 11:42:22 +0100669 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100670 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100671 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200672 {
John Durkop9814fa22020-11-04 12:28:15 -0800673#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
674 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100675 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200676 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100677 return( mbedtls_psa_ecp_import_key( attributes,
678 data, data_length,
679 key_buffer, key_buffer_size,
680 key_buffer_length,
681 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100682 }
John Durkop9814fa22020-11-04 12:28:15 -0800683#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
684 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700685#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
686 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100687 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200688 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100689 return( mbedtls_psa_rsa_import_key( attributes,
690 data, data_length,
691 key_buffer, key_buffer_size,
692 key_buffer_length,
693 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200694 }
John Durkop9814fa22020-11-04 12:28:15 -0800695#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
696 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100697 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100698
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100699 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100700}
701
Gilles Peskinef603c712019-01-19 13:40:11 +0100702/** Calculate the intersection of two algorithm usage policies.
703 *
704 * Return 0 (which allows no operation) on incompatibility.
705 */
706static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100707 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100708 psa_algorithm_t alg1,
709 psa_algorithm_t alg2 )
710{
Gilles Peskine549ea862019-05-22 11:45:59 +0200711 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100712 if( alg1 == alg2 )
713 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100714 /* If the policies are from the same hash-and-sign family, check
715 * if one is a wildcard. If so the other has the specific algorithm. */
716 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
717 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
718 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100719 {
Steven Cooreman03488022021-02-18 12:07:20 +0100720 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
721 return( alg2 );
722 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
723 return( alg1 );
724 }
725 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100726 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100727 * restrictive tag length. */
728 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
729 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
730 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
731 {
732 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
733 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100734 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100735
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100736 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100737 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
738 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100739 {
Steven Cooremancd640932021-03-08 12:00:27 +0100740 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
741 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100742 }
743 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100744 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100745 ( alg1_len <= alg2_len ) )
746 {
747 return( alg2 );
748 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100749 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100750 ( alg2_len <= alg1_len ) )
751 {
752 return( alg1 );
753 }
754 }
755 /* If the policies are from the same MAC family, check whether one
756 * of them is a minimum-MAC-length policy. Calculate the most
757 * restrictive tag length. */
758 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
759 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
760 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
761 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100762 /* Validate the combination of key type and algorithm. Since the base
763 * algorithm of alg1 and alg2 are the same, we only need this once. */
764 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100765 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100766
Steven Cooreman31a876d2021-03-03 20:47:40 +0100767 /* Get the (exact or at-least) output lengths for both sides of the
768 * requested intersection. None of the currently supported algorithms
769 * have an output length dependent on the actual key size, so setting it
770 * to a bogus value of 0 is currently OK.
771 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100772 * Note that for at-least-this-length wildcard algorithms, the output
773 * length is set to the shortest allowed length, which allows us to
774 * calculate the most restrictive tag length for the intersection. */
775 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
776 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100777 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100778
Steven Cooremana1d83222021-02-25 10:20:29 +0100779 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100780 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
781 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100782 {
Steven Cooremancd640932021-03-08 12:00:27 +0100783 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100784 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100785
786 /* If only one is an at-least-this-length policy, the intersection would
787 * be the other (fixed-length) policy as long as said fixed length is
788 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100789 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100790 {
Steven Cooremancd640932021-03-08 12:00:27 +0100791 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100792 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100793 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100794 {
Steven Cooremancd640932021-03-08 12:00:27 +0100795 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100796 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100797
Steven Cooremancd640932021-03-08 12:00:27 +0100798 /* If none of them are wildcards, check whether they define the same tag
799 * length. This is still possible here when one is default-length and
800 * the other specific-length. Ensure to always return the
801 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100802 if( alg1_len == alg2_len )
803 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100804 }
805 /* If the policies are incompatible, allow nothing. */
806 return( 0 );
807}
808
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809static int psa_key_algorithm_permits( psa_key_type_t key_type,
810 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200811 psa_algorithm_t requested_alg )
812{
Gilles Peskine549ea862019-05-22 11:45:59 +0200813 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200814 if( requested_alg == policy_alg )
815 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100816 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
817 * and requested_alg is the same hash-and-sign family with any hash,
818 * then requested_alg is compliant with policy_alg. */
819 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
820 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200821 {
Steven Cooreman03488022021-02-18 12:07:20 +0100822 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
823 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
824 }
825 /* If policy_alg is a wildcard AEAD algorithm of the same base as
826 * the requested algorithm, check the requested tag length to be
827 * equal-length or longer than the wildcard-specified length. */
828 if( PSA_ALG_IS_AEAD( policy_alg ) &&
829 PSA_ALG_IS_AEAD( requested_alg ) &&
830 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
831 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100832 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100833 {
834 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
835 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
836 }
Steven Cooremancd640932021-03-08 12:00:27 +0100837 /* If policy_alg is a MAC algorithm of the same base as the requested
838 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100839 if( PSA_ALG_IS_MAC( policy_alg ) &&
840 PSA_ALG_IS_MAC( requested_alg ) &&
841 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100842 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100843 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100844 /* Validate the combination of key type and algorithm. Since the policy
845 * and requested algorithms are the same, we only need this once. */
846 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100847 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100848
Steven Cooreman31a876d2021-03-03 20:47:40 +0100849 /* Get both the requested output length for the algorithm which is to be
850 * verified, and the default output length for the base algorithm.
851 * Note that none of the currently supported algorithms have an output
852 * length dependent on actual key size, so setting it to a bogus value
853 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100854 size_t requested_output_length = PSA_MAC_LENGTH(
855 key_type, 0, requested_alg );
856 size_t default_output_length = PSA_MAC_LENGTH(
857 key_type, 0,
858 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100859
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100860 /* If the policy is default-length, only allow an algorithm with
861 * a declared exact-length matching the default. */
862 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100863 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100864
865 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100866 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100867 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
868 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
869 {
870 return( 1 );
871 }
872
Steven Cooremancd640932021-03-08 12:00:27 +0100873 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
874 * check for the requested MAC length to be equal to or longer than the
875 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100876 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
877 {
878 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100879 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100880 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200881 }
Steven Cooremance48e852020-10-05 16:02:45 +0200882 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200883 * a key derivation with that key agreement should also be allowed. This
884 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200885 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
886 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
887 {
888 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
889 policy_alg );
890 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100891 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200892 return( 0 );
893}
894
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100895/** Test whether a policy permits an algorithm.
896 *
897 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100898 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100899 * \note This function requires providing the key type for which the policy is
900 * being validated, since some algorithm policy definitions (e.g. MAC)
901 * have different properties depending on what kind of cipher it is
902 * combined with.
903 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100904 * \retval PSA_SUCCESS When \p alg is a specific algorithm
905 * allowed by the \p policy.
906 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
907 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
908 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100909 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100910static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100911 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100912 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100913{
Steven Cooremand788fab2021-02-25 11:29:17 +0100914 /* '0' is not a valid algorithm */
915 if( alg == 0 )
916 return( PSA_ERROR_INVALID_ARGUMENT );
917
Steven Cooreman7e39f052021-02-23 14:18:32 +0100918 /* A requested algorithm cannot be a wildcard. */
919 if( PSA_ALG_IS_WILDCARD( alg ) )
920 return( PSA_ERROR_INVALID_ARGUMENT );
921
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100922 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
923 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 return( PSA_SUCCESS );
925 else
926 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100927}
928
Gilles Peskinef603c712019-01-19 13:40:11 +0100929/** Restrict a key policy based on a constraint.
930 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100931 * \note This function requires providing the key type for which the policy is
932 * being restricted, since some algorithm policy definitions (e.g. MAC)
933 * have different properties depending on what kind of cipher it is
934 * combined with.
935 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100936 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100937 * \param[in,out] policy The policy to restrict.
938 * \param[in] constraint The policy constraint to apply.
939 *
940 * \retval #PSA_SUCCESS
941 * \c *policy contains the intersection of the original value of
942 * \c *policy and \c *constraint.
943 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100944 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100945 * \c *policy is unchanged.
946 */
947static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100948 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100949 psa_key_policy_t *policy,
950 const psa_key_policy_t *constraint )
951{
952 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100953 psa_key_policy_algorithm_intersection( key_type, policy->alg,
954 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200955 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100956 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
957 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100958 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
959 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200960 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
961 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100962 policy->usage &= constraint->usage;
963 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200964 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100965 return( PSA_SUCCESS );
966}
967
Ronald Cron5c522922020-11-14 16:35:34 +0100968/** Get the description of a key given its identifier and policy constraints
969 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200970 *
Ronald Cron5c522922020-11-14 16:35:34 +0100971 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100972 * nonzero, the key must allow operations with this algorithm. If \p alg is
973 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100974 *
Ronald Cron5c522922020-11-14 16:35:34 +0100975 * In case of a persistent key, the function loads the description of the key
976 * into a key slot if not already done.
977 *
978 * On success, the returned key slot is locked. It is the responsibility of
979 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200980 */
Ronald Cron5c522922020-11-14 16:35:34 +0100981static psa_status_t psa_get_and_lock_key_slot_with_policy(
982 mbedtls_svc_key_id_t key,
983 psa_key_slot_t **p_slot,
984 psa_key_usage_t usage,
985 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100986{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
988 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100989
Ronald Cron5c522922020-11-14 16:35:34 +0100990 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100991 if( status != PSA_SUCCESS )
992 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200993 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100994
995 /* Enforce that usage policy for the key slot contains all the flags
996 * required by the usage parameter. There is one exception: public
997 * keys can always be exported, so we treat public key objects as
998 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200999 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001000 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001001
Gilles Peskine8e338702019-07-30 20:06:31 +02001002 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +01001003 {
1004 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001005 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001006 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001007
1008 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001009 if( alg != 0 )
1010 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001011 status = psa_key_policy_permits( &slot->attr.policy,
1012 slot->attr.type,
1013 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001014 if( status != PSA_SUCCESS )
1015 goto error;
1016 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001017
Darryl Green06fd18d2018-07-16 11:21:11 +01001018 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001019
1020error:
1021 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001022 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001023
1024 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001025}
Darryl Green940d72c2018-07-13 13:18:51 +01001026
Ronald Cron5c522922020-11-14 16:35:34 +01001027/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001028 *
1029 * A transparent key is a key for which the key material is directly
1030 * available, as opposed to a key in a secure element.
1031 *
Ronald Cron5c522922020-11-14 16:35:34 +01001032 * This is a temporary function to use instead of
1033 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1034 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001035 *
Ronald Cron5c522922020-11-14 16:35:34 +01001036 * On success, the returned key slot is locked. It is the responsibility of the
1037 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001038 */
1039#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001040static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1041 mbedtls_svc_key_id_t key,
1042 psa_key_slot_t **p_slot,
1043 psa_key_usage_t usage,
1044 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001045{
Ronald Cron5c522922020-11-14 16:35:34 +01001046 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1047 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001048 if( status != PSA_SUCCESS )
1049 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001050
Gilles Peskineadad8132019-07-25 11:31:23 +02001051 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001052 {
Ronald Cron5c522922020-11-14 16:35:34 +01001053 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001054 *p_slot = NULL;
1055 return( PSA_ERROR_NOT_SUPPORTED );
1056 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001057
Gilles Peskine28f8f302019-07-24 13:30:31 +02001058 return( PSA_SUCCESS );
1059}
1060#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1061/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001062#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1063 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001064#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1065
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001066psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001067{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001068 /* Data pointer will always be either a valid pointer or NULL in an
1069 * initialized slot, so we can just free it. */
1070 if( slot->key.data != NULL )
1071 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1072
1073 mbedtls_free( slot->key.data );
1074 slot->key.data = NULL;
1075 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001076
1077 return( PSA_SUCCESS );
1078}
1079
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001080/** Completely wipe a slot in memory, including its policy.
1081 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001082psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001083{
1084 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001085
1086 /*
1087 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001088 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001089 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1090 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001091 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001092 */
Ronald Cron5c522922020-11-14 16:35:34 +01001093 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001094 {
1095#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001096 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001097#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001098 status = PSA_ERROR_CORRUPTION_DETECTED;
1099 }
1100
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001101 /* Multipart operations may still be using the key. This is safe
1102 * because all multipart operation objects are independent from
1103 * the key slot: if they need to access the key after the setup
1104 * phase, they have a copy of the key. Note that this means that
1105 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001106 /* At this point, key material and other type-specific content has
1107 * been wiped. Clear remaining metadata. We can call memset and not
1108 * zeroize because the metadata is not particularly sensitive. */
1109 memset( slot, 0, sizeof( *slot ) );
1110 return( status );
1111}
1112
Ronald Croncf56a0a2020-08-04 09:51:30 +02001113psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001114{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001115 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001116 psa_status_t status; /* status of the last operation */
1117 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001118#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1119 psa_se_drv_table_entry_t *driver;
1120#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001121
Ronald Croncf56a0a2020-08-04 09:51:30 +02001122 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001123 return( PSA_SUCCESS );
1124
Ronald Cronf2911112020-10-29 17:51:10 +01001125 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001126 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001127 * key, this will load the key description from persistent memory if not
1128 * done yet. We cannot avoid this loading as without it we don't know if
1129 * the key is operated by an SE or not and this information is needed by
1130 * the current implementation.
1131 */
Ronald Cron5c522922020-11-14 16:35:34 +01001132 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001133 if( status != PSA_SUCCESS )
1134 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001135
Ronald Cronf2911112020-10-29 17:51:10 +01001136 /*
1137 * If the key slot containing the key description is under access by the
1138 * library (apart from the present access), the key cannot be destroyed
1139 * yet. For the time being, just return in error. Eventually (to be
1140 * implemented), the key should be destroyed when all accesses have
1141 * stopped.
1142 */
Ronald Cron5c522922020-11-14 16:35:34 +01001143 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001144 {
Ronald Cron5c522922020-11-14 16:35:34 +01001145 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001146 return( PSA_ERROR_GENERIC_ERROR );
1147 }
1148
Gilles Peskine354f7672019-07-12 23:46:38 +02001149#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001150 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001151 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001152 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001153 /* For a key in a secure element, we need to do three things:
1154 * remove the key file in internal storage, destroy the
1155 * key inside the secure element, and update the driver's
1156 * persistent data. Start a transaction that will encompass these
1157 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001158 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001159 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001160 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001161 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001162 status = psa_crypto_save_transaction( );
1163 if( status != PSA_SUCCESS )
1164 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001165 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001166 /* We should still try to destroy the key in the secure
1167 * element and the key metadata in storage. This is especially
1168 * important if the error is that the storage is full.
1169 * But how to do it exactly without risking an inconsistent
1170 * state after a reset?
1171 * https://github.com/ARMmbed/mbed-crypto/issues/215
1172 */
1173 overall_status = status;
1174 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001175 }
1176
Ronald Cronea0f8a62020-11-25 17:52:23 +01001177 status = psa_destroy_se_key( driver,
1178 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001179 if( overall_status == PSA_SUCCESS )
1180 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001181 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001182#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1183
Darryl Greend49a4992018-06-18 17:27:26 +01001184#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001185 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001186 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001187 status = psa_destroy_persistent_key( slot->attr.id );
1188 if( overall_status == PSA_SUCCESS )
1189 overall_status = status;
1190
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001191 /* TODO: other slots may have a copy of the same key. We should
1192 * invalidate them.
1193 * https://github.com/ARMmbed/mbed-crypto/issues/214
1194 */
Darryl Greend49a4992018-06-18 17:27:26 +01001195 }
1196#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001197
Gilles Peskinefc762652019-07-22 19:30:34 +02001198#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1199 if( driver != NULL )
1200 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001201 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001202 if( overall_status == PSA_SUCCESS )
1203 overall_status = status;
1204 status = psa_crypto_stop_transaction( );
1205 if( overall_status == PSA_SUCCESS )
1206 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001207 }
1208#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1209
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001210#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1211exit:
1212#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001213 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001214 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1215 if( overall_status == PSA_SUCCESS )
1216 overall_status = status;
1217 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001218}
1219
John Durkop07cc04a2020-11-16 22:08:34 -08001220#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001221 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001222static psa_status_t psa_get_rsa_public_exponent(
1223 const mbedtls_rsa_context *rsa,
1224 psa_key_attributes_t *attributes )
1225{
1226 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001227 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001228 uint8_t *buffer = NULL;
1229 size_t buflen;
1230 mbedtls_mpi_init( &mpi );
1231
1232 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1233 if( ret != 0 )
1234 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001235 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1236 {
1237 /* It's the default value, which is reported as an empty string,
1238 * so there's nothing to do. */
1239 goto exit;
1240 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001241
1242 buflen = mbedtls_mpi_size( &mpi );
1243 buffer = mbedtls_calloc( 1, buflen );
1244 if( buffer == NULL )
1245 {
1246 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1247 goto exit;
1248 }
1249 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1250 if( ret != 0 )
1251 goto exit;
1252 attributes->domain_parameters = buffer;
1253 attributes->domain_parameters_size = buflen;
1254
1255exit:
1256 mbedtls_mpi_free( &mpi );
1257 if( ret != 0 )
1258 mbedtls_free( buffer );
1259 return( mbedtls_to_psa_error( ret ) );
1260}
John Durkop07cc04a2020-11-16 22:08:34 -08001261#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001262 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001263
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001264/** Retrieve all the publicly-accessible attributes of a key.
1265 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001266psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001267 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001268{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001270 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001271 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001272
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001273 psa_reset_key_attributes( attributes );
1274
Ronald Cron5c522922020-11-14 16:35:34 +01001275 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001276 if( status != PSA_SUCCESS )
1277 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001278
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001279 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001280 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1281 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1282
1283#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1284 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001285 psa_set_key_slot_number( attributes,
1286 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001287#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001288
Gilles Peskine8e338702019-07-30 20:06:31 +02001289 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001290 {
John Durkop07cc04a2020-11-16 22:08:34 -08001291#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001292 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001293 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001294 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001295#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001296 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001297 * is not yet implemented.
1298 * https://github.com/ARMmbed/mbed-crypto/issues/216
1299 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001300 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001301 break;
1302#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001303 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001304 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001305
Ronald Cron90857082020-11-25 14:58:33 +01001306 status = mbedtls_psa_rsa_load_representation(
1307 slot->attr.type,
1308 slot->key.data,
1309 slot->key.bytes,
1310 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001311 if( status != PSA_SUCCESS )
1312 break;
1313
Steven Cooremana2371e52020-07-28 14:30:39 +02001314 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001315 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001316 mbedtls_rsa_free( rsa );
1317 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001318 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001319 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001320#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001321 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001322 default:
1323 /* Nothing else to do. */
1324 break;
1325 }
1326
1327 if( status != PSA_SUCCESS )
1328 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001329
Ronald Cron5c522922020-11-14 16:35:34 +01001330 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001331
Ronald Cron5c522922020-11-14 16:35:34 +01001332 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001333}
1334
Gilles Peskinec8000c02019-08-02 20:15:51 +02001335#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1336psa_status_t psa_get_key_slot_number(
1337 const psa_key_attributes_t *attributes,
1338 psa_key_slot_number_t *slot_number )
1339{
1340 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1341 {
1342 *slot_number = attributes->slot_number;
1343 return( PSA_SUCCESS );
1344 }
1345 else
1346 return( PSA_ERROR_INVALID_ARGUMENT );
1347}
1348#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1349
Ronald Crond18b5f82020-11-25 16:46:05 +01001350static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1351 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001352 uint8_t *data,
1353 size_t data_size,
1354 size_t *data_length )
1355{
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001357 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 memcpy( data, key_buffer, key_buffer_size );
1359 memset( data + key_buffer_size, 0,
1360 data_size - key_buffer_size );
1361 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001362 return( PSA_SUCCESS );
1363}
1364
Ronald Cron7285cda2020-11-26 14:46:37 +01001365psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001366 const psa_key_attributes_t *attributes,
1367 const uint8_t *key_buffer, size_t key_buffer_size,
1368 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001369{
Ronald Crond18b5f82020-11-25 16:46:05 +01001370 psa_key_type_t type = attributes->core.type;
1371
Ronald Crond18b5f82020-11-25 16:46:05 +01001372 if( key_type_is_raw_bytes( type ) ||
1373 PSA_KEY_TYPE_IS_RSA( type ) ||
1374 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001375 {
1376 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001377 key_buffer, key_buffer_size,
1378 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001379 }
1380 else
1381 {
1382 /* This shouldn't happen in the reference implementation, but
1383 it is valid for a special-purpose implementation to omit
1384 support for exporting certain key types. */
1385 return( PSA_ERROR_NOT_SUPPORTED );
1386 }
1387}
1388
1389psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1390 uint8_t *data,
1391 size_t data_size,
1392 size_t *data_length )
1393{
1394 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1395 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1396 psa_key_slot_t *slot;
1397
Ronald Crone907e552021-01-18 13:22:38 +01001398 /* Reject a zero-length output buffer now, since this can never be a
1399 * valid key representation. This way we know that data must be a valid
1400 * pointer and we can do things like memset(data, ..., data_size). */
1401 if( data_size == 0 )
1402 return( PSA_ERROR_BUFFER_TOO_SMALL );
1403
Ronald Cron9486f9d2020-11-26 13:36:23 +01001404 /* Set the key to empty now, so that even when there are errors, we always
1405 * set data_length to a value between 0 and data_size. On error, setting
1406 * the key to empty is a good choice because an empty key representation is
1407 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001408 *data_length = 0;
1409
Ronald Cron9486f9d2020-11-26 13:36:23 +01001410 /* Export requires the EXPORT flag. There is an exception for public keys,
1411 * which don't require any flag, but
1412 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1413 */
1414 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1415 PSA_KEY_USAGE_EXPORT, 0 );
1416 if( status != PSA_SUCCESS )
1417 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001418
Ronald Crond18b5f82020-11-25 16:46:05 +01001419 psa_key_attributes_t attributes = {
1420 .core = slot->attr
1421 };
Ronald Cron67227982020-11-26 15:16:05 +01001422 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001423 slot->key.data, slot->key.bytes,
1424 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001425
Ronald Cron9486f9d2020-11-26 13:36:23 +01001426 unlock_status = psa_unlock_key_slot( slot );
1427
1428 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1429}
1430
Ronald Cron7285cda2020-11-26 14:46:37 +01001431psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001432 const psa_key_attributes_t *attributes,
1433 const uint8_t *key_buffer,
1434 size_t key_buffer_size,
1435 uint8_t *data,
1436 size_t data_size,
1437 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001438{
Ronald Crond18b5f82020-11-25 16:46:05 +01001439 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001440
Ronald Crond18b5f82020-11-25 16:46:05 +01001441 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001442 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001443 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001444 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001445 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001446 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001447 key_buffer, key_buffer_size,
1448 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001449 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001450
Ronald Crond18b5f82020-11-25 16:46:05 +01001451 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001452 {
John Durkop0e005192020-10-31 22:06:54 -07001453#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1454 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001455 return( mbedtls_psa_rsa_export_public_key( attributes,
1456 key_buffer,
1457 key_buffer_size,
1458 data,
1459 data_size,
1460 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001461#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001462 /* We don't know how to convert a private RSA key to public. */
1463 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001464#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1465 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001466 }
1467 else
Moran Pekera998bc62018-04-16 18:16:20 +03001468 {
John Durkop6ba40d12020-11-10 08:50:04 -08001469#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1470 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001471 return( mbedtls_psa_ecp_export_public_key( attributes,
1472 key_buffer,
1473 key_buffer_size,
1474 data,
1475 data_size,
1476 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001477#else
1478 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001479 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001480#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1481 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001482 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001483 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001484 else
1485 {
1486 /* This shouldn't happen in the reference implementation, but
1487 it is valid for a special-purpose implementation to omit
1488 support for exporting certain key types. */
1489 return( PSA_ERROR_NOT_SUPPORTED );
1490 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001491}
Ronald Crond18b5f82020-11-25 16:46:05 +01001492
Ronald Croncf56a0a2020-08-04 09:51:30 +02001493psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001494 uint8_t *data,
1495 size_t data_size,
1496 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001497{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001498 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001499 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001500 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001501
Ronald Crone907e552021-01-18 13:22:38 +01001502 /* Reject a zero-length output buffer now, since this can never be a
1503 * valid key representation. This way we know that data must be a valid
1504 * pointer and we can do things like memset(data, ..., data_size). */
1505 if( data_size == 0 )
1506 return( PSA_ERROR_BUFFER_TOO_SMALL );
1507
Darryl Greendd8fb772018-11-07 16:00:44 +00001508 /* Set the key to empty now, so that even when there are errors, we always
1509 * set data_length to a value between 0 and data_size. On error, setting
1510 * the key to empty is a good choice because an empty key representation is
1511 * unlikely to be accepted anywhere. */
1512 *data_length = 0;
1513
1514 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001515 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001516 if( status != PSA_SUCCESS )
1517 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001518
Ronald Cron9486f9d2020-11-26 13:36:23 +01001519 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1520 {
1521 status = PSA_ERROR_INVALID_ARGUMENT;
1522 goto exit;
1523 }
1524
Ronald Crond18b5f82020-11-25 16:46:05 +01001525 psa_key_attributes_t attributes = {
1526 .core = slot->attr
1527 };
Ronald Cron67227982020-11-26 15:16:05 +01001528 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001529 &attributes, slot->key.data, slot->key.bytes,
1530 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001531
1532exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001533 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001534
Ronald Cron5c522922020-11-14 16:35:34 +01001535 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001536}
1537
Gilles Peskine91e8c332019-08-02 19:19:39 +02001538#if defined(static_assert)
1539static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1540 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001541static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001542 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001543static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001544 "One or more key attribute flag is listed as both internal-only and external-only" );
1545#endif
1546
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001547/** Validate that a key policy is internally well-formed.
1548 *
1549 * This function only rejects invalid policies. It does not validate the
1550 * consistency of the policy with respect to other attributes of the key
1551 * such as the key type.
1552 */
1553static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001554{
1555 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001556 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001557 PSA_KEY_USAGE_ENCRYPT |
1558 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001559 PSA_KEY_USAGE_SIGN_HASH |
1560 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001561 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1562 return( PSA_ERROR_INVALID_ARGUMENT );
1563
Gilles Peskine4747d192019-04-17 15:05:45 +02001564 return( PSA_SUCCESS );
1565}
1566
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001567/** Validate the internal consistency of key attributes.
1568 *
1569 * This function only rejects invalid attribute values. If does not
1570 * validate the consistency of the attributes with any key data that may
1571 * be involved in the creation of the key.
1572 *
1573 * Call this function early in the key creation process.
1574 *
1575 * \param[in] attributes Key attributes for the new key.
1576 * \param[out] p_drv On any return, the driver for the key, if any.
1577 * NULL for a transparent key.
1578 *
1579 */
1580static psa_status_t psa_validate_key_attributes(
1581 const psa_key_attributes_t *attributes,
1582 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001583{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001584 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001585 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001586 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001587
Ronald Cron54b90082020-10-29 15:26:43 +01001588 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001589 if( status != PSA_SUCCESS )
1590 return( status );
1591
Ronald Crond2ed4812020-07-17 16:11:30 +02001592 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001593 if( status != PSA_SUCCESS )
1594 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001595
Ronald Cron65f38a32020-10-23 17:11:13 +02001596 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1597 {
1598 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1599 return( PSA_ERROR_INVALID_ARGUMENT );
1600 }
1601 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001602 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001603 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1604 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001605 }
1606
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001607 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001608 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001609 return( status );
1610
1611 /* Refuse to create overly large keys.
1612 * Note that this doesn't trigger on import if the attributes don't
1613 * explicitly specify a size (so psa_get_key_bits returns 0), so
1614 * psa_import_key() needs its own checks. */
1615 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1616 return( PSA_ERROR_NOT_SUPPORTED );
1617
Gilles Peskine91e8c332019-08-02 19:19:39 +02001618 /* Reject invalid flags. These should not be reachable through the API. */
1619 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1620 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1621 return( PSA_ERROR_INVALID_ARGUMENT );
1622
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001623 return( PSA_SUCCESS );
1624}
1625
Gilles Peskine4747d192019-04-17 15:05:45 +02001626/** Prepare a key slot to receive key material.
1627 *
1628 * This function allocates a key slot and sets its metadata.
1629 *
1630 * If this function fails, call psa_fail_key_creation().
1631 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001632 * This function is intended to be used as follows:
1633 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001634 * it with the specified attributes, and in case of a volatile key assign it
1635 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001636 * -# Populate the slot with the key material.
1637 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1638 * In case of failure at any step, stop the sequence and call
1639 * psa_fail_key_creation().
1640 *
Ronald Cron5c522922020-11-14 16:35:34 +01001641 * On success, the key slot is locked. It is the responsibility of the caller
1642 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001643 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001644 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001645 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001646 * \param[out] p_slot On success, a pointer to the prepared slot.
1647 * \param[out] p_drv On any return, the driver for the key, if any.
1648 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001649 *
1650 * \retval #PSA_SUCCESS
1651 * The key slot is ready to receive key material.
1652 * \return If this function fails, the key slot is an invalid state.
1653 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001654 */
1655static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001656 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001657 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001658 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001659 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001660{
1661 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001662 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001663 psa_key_slot_t *slot;
1664
Gilles Peskinedf179142019-07-15 22:02:14 +02001665 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001666 *p_drv = NULL;
1667
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001668 status = psa_validate_key_attributes( attributes, p_drv );
1669 if( status != PSA_SUCCESS )
1670 return( status );
1671
Ronald Cronc4d1b512020-07-31 11:26:37 +02001672 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001673 if( status != PSA_SUCCESS )
1674 return( status );
1675 slot = *p_slot;
1676
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001677 /* We're storing the declared bit-size of the key. It's up to each
1678 * creation mechanism to verify that this information is correct.
1679 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001680 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001681 * is optional (import, copy). In case of a volatile key, assign it the
1682 * volatile key identifier associated to the slot returned to contain its
1683 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001684
1685 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001686 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1687 {
1688#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1689 slot->attr.id = volatile_key_id;
1690#else
1691 slot->attr.id.key_id = volatile_key_id;
1692#endif
1693 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001694
Gilles Peskine91e8c332019-08-02 19:19:39 +02001695 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001696 * external-only flags, query `attributes`. Thanks to the check
1697 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001698 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001699 * may have set. */
1700 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001701
Gilles Peskinecbaff462019-07-12 23:46:04 +02001702#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001703 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001704 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001705 * create the key file in internal storage, create the
1706 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001707 * persistent data. This is done by starting a transaction that will
1708 * encompass these three actions.
1709 * For registering a volatile key, we just need to find an appropriate
1710 * slot number inside the SE. Since the key is designated volatile, creating
1711 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001712 /* The first thing to do is to find a slot number for the new key.
1713 * We save the slot number in persistent storage as part of the
1714 * transaction data. It will be needed to recover if the power
1715 * fails during the key creation process, to clean up on the secure
1716 * element side after restarting. Obtaining a slot number from the
1717 * secure element driver updates its persistent state, but we do not yet
1718 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001719 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001720 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001721 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001722 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001723 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001724 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001725 if( status != PSA_SUCCESS )
1726 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001727
1728 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001729 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001730 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1731 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001732 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001733 psa_crypto_transaction.key.id = slot->attr.id;
1734 status = psa_crypto_save_transaction( );
1735 if( status != PSA_SUCCESS )
1736 {
1737 (void) psa_crypto_stop_transaction( );
1738 return( status );
1739 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001740 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741
1742 status = psa_copy_key_material_into_slot(
1743 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001744 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001745
1746 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1747 {
1748 /* Key registration only makes sense with a secure element. */
1749 return( PSA_ERROR_INVALID_ARGUMENT );
1750 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001751#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1752
Ronald Cronc4d1b512020-07-31 11:26:37 +02001753 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001754}
Gilles Peskine4747d192019-04-17 15:05:45 +02001755
1756/** Finalize the creation of a key once its key material has been set.
1757 *
1758 * This entails writing the key to persistent storage.
1759 *
1760 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001761 * See the documentation of psa_start_key_creation() for the intended use
1762 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001763 *
Ronald Cron5c522922020-11-14 16:35:34 +01001764 * If the finalization succeeds, the function unlocks the key slot (it was
1765 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1766 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001767 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001768 * \param[in,out] slot Pointer to the slot with key material.
1769 * \param[in] driver The secure element driver for the key,
1770 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001771 * \param[out] key On success, identifier of the key. Note that the
1772 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001773 *
1774 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001775 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001776 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1777 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1778 * \retval #PSA_ERROR_ALREADY_EXISTS
1779 * \retval #PSA_ERROR_DATA_INVALID
1780 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001781 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001782 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001783 * \return If this function fails, the key slot is an invalid state.
1784 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001786static psa_status_t psa_finish_key_creation(
1787 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001788 psa_se_drv_table_entry_t *driver,
1789 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001790{
1791 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001792 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001793 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001794
1795#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001796 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001797 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001798#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1799 if( driver != NULL )
1800 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001801 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001802 psa_key_slot_number_t slot_number =
1803 psa_key_slot_get_slot_number( slot ) ;
1804
Gilles Peskineb46bef22019-07-30 21:32:04 +02001805#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001806 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001807 sizeof( data.slot_number ),
1808 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001809#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001810 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001811 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001812 (uint8_t*) &data,
1813 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001814 }
1815 else
1816#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1817 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001818 /* Key material is saved in export representation in the slot, so
1819 * just pass the slot buffer for storage. */
1820 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001821 slot->key.data,
1822 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001823 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001824 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001825#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1826
Gilles Peskinecbaff462019-07-12 23:46:04 +02001827#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001828 /* Finish the transaction for a key creation. This does not
1829 * happen when registering an existing key. Detect this case
1830 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001831 * creation of a persistent key in a secure element requires a transaction,
1832 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001833 if( driver != NULL &&
1834 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001835 {
1836 status = psa_save_se_persistent_data( driver );
1837 if( status != PSA_SUCCESS )
1838 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001839 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001840 return( status );
1841 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001842 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001843 }
1844#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1845
Ronald Cron50972942020-11-14 11:28:25 +01001846 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001847 {
1848 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001849 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001850 if( status != PSA_SUCCESS )
1851 *key = MBEDTLS_SVC_KEY_ID_INIT;
1852 }
Ronald Cron50972942020-11-14 11:28:25 +01001853
Gilles Peskine4747d192019-04-17 15:05:45 +02001854 return( status );
1855}
1856
1857/** Abort the creation of a key.
1858 *
1859 * You may call this function after calling psa_start_key_creation(),
1860 * or after psa_finish_key_creation() fails. In other circumstances, this
1861 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001862 * See the documentation of psa_start_key_creation() for the intended use
1863 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001864 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001865 * \param[in,out] slot Pointer to the slot with key material.
1866 * \param[in] driver The secure element driver for the key,
1867 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001868 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001869static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001870 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001871{
Gilles Peskine011e4282019-06-26 18:34:38 +02001872 (void) driver;
1873
Gilles Peskine4747d192019-04-17 15:05:45 +02001874 if( slot == NULL )
1875 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001876
1877#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001878 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001879 * element, and the failure happened later (when saving metadata
1880 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001881 * element.
1882 * https://github.com/ARMmbed/mbed-crypto/issues/217
1883 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001884
Gilles Peskined7729582019-08-05 15:55:54 +02001885 /* Abort the ongoing transaction if any (there may not be one if
1886 * the creation process failed before starting one, or if the
1887 * key creation is a registration of a key in a secure element).
1888 * Earlier functions must already have done what it takes to undo any
1889 * partial creation. All that's left is to update the transaction data
1890 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001891 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001892#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1893
Gilles Peskine4747d192019-04-17 15:05:45 +02001894 psa_wipe_key_slot( slot );
1895}
1896
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001897/** Validate optional attributes during key creation.
1898 *
1899 * Some key attributes are optional during key creation. If they are
1900 * specified in the attributes structure, check that they are consistent
1901 * with the data in the slot.
1902 *
1903 * This function should be called near the end of key creation, after
1904 * the slot in memory is fully populated but before saving persistent data.
1905 */
1906static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 const psa_key_slot_t *slot,
1908 const psa_key_attributes_t *attributes )
1909{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001910 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001911 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001912 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001913 return( PSA_ERROR_INVALID_ARGUMENT );
1914 }
1915
1916 if( attributes->domain_parameters_size != 0 )
1917 {
John Durkop0e005192020-10-31 22:06:54 -07001918#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1919 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001920 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001922 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001923 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001924 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001925
Ronald Cron90857082020-11-25 14:58:33 +01001926 psa_status_t status = mbedtls_psa_rsa_load_representation(
1927 slot->attr.type,
1928 slot->key.data,
1929 slot->key.bytes,
1930 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001931 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001932 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001933
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934 mbedtls_mpi_init( &actual );
1935 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001936 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001937 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001938 mbedtls_rsa_free( rsa );
1939 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001940 if( ret != 0 )
1941 goto rsa_exit;
1942 ret = mbedtls_mpi_read_binary( &required,
1943 attributes->domain_parameters,
1944 attributes->domain_parameters_size );
1945 if( ret != 0 )
1946 goto rsa_exit;
1947 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1948 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1949 rsa_exit:
1950 mbedtls_mpi_free( &actual );
1951 mbedtls_mpi_free( &required );
1952 if( ret != 0)
1953 return( mbedtls_to_psa_error( ret ) );
1954 }
1955 else
John Durkop9814fa22020-11-04 12:28:15 -08001956#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1957 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958 {
1959 return( PSA_ERROR_INVALID_ARGUMENT );
1960 }
1961 }
1962
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001963 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001964 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001965 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001966 return( PSA_ERROR_INVALID_ARGUMENT );
1967 }
1968
1969 return( PSA_SUCCESS );
1970}
1971
Gilles Peskine4747d192019-04-17 15:05:45 +02001972psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001973 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001974 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001975 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001976{
1977 psa_status_t status;
1978 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001979 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001980 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001981
Ronald Cron81709fc2020-11-14 12:10:32 +01001982 *key = MBEDTLS_SVC_KEY_ID_INIT;
1983
Gilles Peskine0f84d622019-09-12 19:03:13 +02001984 /* Reject zero-length symmetric keys (including raw data key objects).
1985 * This also rejects any key which might be encoded as an empty string,
1986 * which is never valid. */
1987 if( data_length == 0 )
1988 return( PSA_ERROR_INVALID_ARGUMENT );
1989
Gilles Peskinedf179142019-07-15 22:02:14 +02001990 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001991 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001992 if( status != PSA_SUCCESS )
1993 goto exit;
1994
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001995 /* In the case of a transparent key or an opaque key stored in local
1996 * storage (thus not in the case of generating a key in a secure element
1997 * or cryptoprocessor with storage), we have to allocate a buffer to
1998 * hold the generated key material. */
1999 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02002000 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002001 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002002 if( status != PSA_SUCCESS )
2003 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002004 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002005
2006 bits = slot->attr.bits;
2007 status = psa_driver_wrapper_import_key( attributes,
2008 data, data_length,
2009 slot->key.data,
2010 slot->key.bytes,
2011 &slot->key.bytes, &bits );
2012 if( status != PSA_SUCCESS )
2013 goto exit;
2014
2015 if( slot->attr.bits == 0 )
2016 slot->attr.bits = (psa_key_bits_t) bits;
2017 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002018 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002019 status = PSA_ERROR_INVALID_ARGUMENT;
2020 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002021 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002022
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002023 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002024 if( status != PSA_SUCCESS )
2025 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002026
Ronald Cron81709fc2020-11-14 12:10:32 +01002027 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002028exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002029 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002030 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002031
Gilles Peskine4747d192019-04-17 15:05:45 +02002032 return( status );
2033}
2034
Gilles Peskined7729582019-08-05 15:55:54 +02002035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2036psa_status_t mbedtls_psa_register_se_key(
2037 const psa_key_attributes_t *attributes )
2038{
2039 psa_status_t status;
2040 psa_key_slot_t *slot = NULL;
2041 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002042 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002043
2044 /* Leaving attributes unspecified is not currently supported.
2045 * It could make sense to query the key type and size from the
2046 * secure element, but not all secure elements support this
2047 * and the driver HAL doesn't currently support it. */
2048 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2049 return( PSA_ERROR_NOT_SUPPORTED );
2050 if( psa_get_key_bits( attributes ) == 0 )
2051 return( PSA_ERROR_NOT_SUPPORTED );
2052
2053 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002054 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002055 if( status != PSA_SUCCESS )
2056 goto exit;
2057
Ronald Cron81709fc2020-11-14 12:10:32 +01002058 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002059
2060exit:
2061 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002062 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002063
Gilles Peskined7729582019-08-05 15:55:54 +02002064 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002065 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002066 return( status );
2067}
2068#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2069
Gilles Peskinef603c712019-01-19 13:40:11 +01002070static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002071 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002072{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002073 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002074 source->key.data,
2075 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002076 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002077 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002078
Steven Cooreman398aee52020-10-13 14:35:45 +02002079 target->attr.type = source->attr.type;
2080 target->attr.bits = source->attr.bits;
2081
2082 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002083}
2084
Ronald Croncf56a0a2020-08-04 09:51:30 +02002085psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002086 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002087 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002088{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002090 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002091 psa_key_slot_t *source_slot = NULL;
2092 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002093 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002094 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002095
Ronald Cron81709fc2020-11-14 12:10:32 +01002096 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2097
Ronald Cron5c522922020-11-14 16:35:34 +01002098 status = psa_get_and_lock_transparent_key_slot_with_policy(
2099 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002100 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002101 goto exit;
2102
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002103 status = psa_validate_optional_attributes( source_slot,
2104 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002105 if( status != PSA_SUCCESS )
2106 goto exit;
2107
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002108 status = psa_restrict_key_policy( source_slot->attr.type,
2109 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002110 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002111 if( status != PSA_SUCCESS )
2112 goto exit;
2113
Ronald Cron81709fc2020-11-14 12:10:32 +01002114 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2115 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002116 if( status != PSA_SUCCESS )
2117 goto exit;
2118
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002119#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2120 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002121 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002122 /* Copying to a secure element is not implemented yet. */
2123 status = PSA_ERROR_NOT_SUPPORTED;
2124 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002125 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002126#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002127
Ronald Cron6cc66312021-04-02 12:27:47 +02002128 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2129 {
2130 /*
2131 * Copying through an opaque driver is not implemented yet, consider
2132 * a lifetime with an external location as an invalid parameter for
2133 * now.
2134 */
2135 status = PSA_ERROR_INVALID_ARGUMENT;
2136 goto exit;
2137 }
2138
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002139 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002140 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002141 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002142
Ronald Cron81709fc2020-11-14 12:10:32 +01002143 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002144exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002145 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002146 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002147
Ronald Cron5c522922020-11-14 16:35:34 +01002148 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002149
Ronald Cron5c522922020-11-14 16:35:34 +01002150 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002151}
2152
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002153
2154
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002155/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002156/* Message digests */
2157/****************************************************************/
2158
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002159psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2160{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002161 /* Aborting a non-active operation is allowed */
2162 if( operation->id == 0 )
2163 return( PSA_SUCCESS );
2164
2165 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2166 operation->id = 0;
2167
2168 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169}
2170
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002171psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172 psa_algorithm_t alg )
2173{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002174 /* A context must be freshly initialized before it can be set up. */
2175 if( operation->id != 0 )
2176 return( PSA_ERROR_BAD_STATE );
2177
2178 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002179 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002180
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002181 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2182 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002183 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2184
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002185 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002186}
2187
2188psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2189 const uint8_t *input,
2190 size_t input_length )
2191{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002192 if( operation->id == 0 )
2193 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002194
Steven Cooremanc8288352021-03-04 14:02:19 +01002195 /* Don't require hash implementations to behave correctly on a
2196 * zero-length input, which may have an invalid pointer. */
2197 if( input_length == 0 )
2198 return( PSA_SUCCESS );
2199
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002200 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2201 input, input_length );
2202 if( status != PSA_SUCCESS )
2203 psa_hash_abort( operation );
2204
2205 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002206}
2207
2208psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2209 uint8_t *hash,
2210 size_t hash_size,
2211 size_t *hash_length )
2212{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002213 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002214 if( operation->id == 0 )
2215 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002216
Steven Cooreman1e582352021-02-18 17:24:37 +01002217 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002218 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002219 psa_hash_abort( operation );
2220 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221}
2222
Gilles Peskine2d277862018-06-18 15:41:12 +02002223psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2224 const uint8_t *hash,
2225 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002226{
2227 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2228 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002229 psa_status_t status = psa_hash_finish(
2230 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002231 actual_hash, sizeof( actual_hash ),
2232 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002233 if( status != PSA_SUCCESS )
2234 return( status );
2235 if( actual_hash_length != hash_length )
2236 return( PSA_ERROR_INVALID_SIGNATURE );
2237 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2238 return( PSA_ERROR_INVALID_SIGNATURE );
2239 return( PSA_SUCCESS );
2240}
2241
Gilles Peskine0a749c82019-11-28 19:33:58 +01002242psa_status_t psa_hash_compute( psa_algorithm_t alg,
2243 const uint8_t *input, size_t input_length,
2244 uint8_t *hash, size_t hash_size,
2245 size_t *hash_length )
2246{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002247 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002248 if( !PSA_ALG_IS_HASH( alg ) )
2249 return( PSA_ERROR_INVALID_ARGUMENT );
2250
Steven Cooreman1e582352021-02-18 17:24:37 +01002251 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2252 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002253}
2254
2255psa_status_t psa_hash_compare( psa_algorithm_t alg,
2256 const uint8_t *input, size_t input_length,
2257 const uint8_t *hash, size_t hash_length )
2258{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002259 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2260 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002261
2262 if( !PSA_ALG_IS_HASH( alg ) )
2263 return( PSA_ERROR_INVALID_ARGUMENT );
2264
Steven Cooreman1e582352021-02-18 17:24:37 +01002265 psa_status_t status = psa_driver_wrapper_hash_compute(
2266 alg, input, input_length,
2267 actual_hash, sizeof(actual_hash),
2268 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002269 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002270 return( status );
2271 if( actual_hash_length != hash_length )
2272 return( PSA_ERROR_INVALID_SIGNATURE );
2273 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2274 return( PSA_ERROR_INVALID_SIGNATURE );
2275 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002276}
2277
Gilles Peskineeb35d782019-01-22 17:56:16 +01002278psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2279 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002280{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002281 if( source_operation->id == 0 ||
2282 target_operation->id != 0 )
2283 {
2284 return( PSA_ERROR_BAD_STATE );
2285 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002286
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002287 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2288 target_operation );
2289 if( status != PSA_SUCCESS )
2290 psa_hash_abort( target_operation );
2291
2292 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002293}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294
2295
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002296/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002297/* MAC */
2298/****************************************************************/
2299
John Durkop6ba40d12020-11-10 08:50:04 -08002300#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002301static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002302{
Gilles Peskine2d277862018-06-18 15:41:12 +02002303 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002304 {
2305 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002306 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002307 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002308 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002309 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002310 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002311 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002312 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002313 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002314 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002315 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002316 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002317 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002318 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002319 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002320 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002321 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002322 return( 128 );
2323 default:
2324 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002325 }
2326}
John Durkop07cc04a2020-11-16 22:08:34 -08002327#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002328
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002329/* Initialize the MAC operation structure. Once this function has been
2330 * called, psa_mac_abort can run and will do the right thing. */
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002331static psa_status_t psa_mac_init( mbedtls_psa_mac_operation_t *operation,
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002332 psa_algorithm_t alg )
2333{
2334 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2335
Steven Cooreman15472f82021-03-02 16:16:22 +01002336 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002337 operation->key_set = 0;
2338 operation->iv_set = 0;
2339 operation->iv_required = 0;
2340 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002341 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002342
Ronald Cron3d471812021-03-18 13:40:31 +01002343#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002344 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002345 {
2346 operation->iv_required = 0;
2347 mbedtls_cipher_init( &operation->ctx.cmac );
2348 status = PSA_SUCCESS;
2349 }
2350 else
Ronald Cron3d471812021-03-18 13:40:31 +01002351#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002352#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002353 if( PSA_ALG_IS_HMAC( operation->alg ) )
2354 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002355 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002356 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002357 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002358 }
2359 else
John Durkopd0321952020-10-29 21:37:36 -07002360#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002361 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002362 if( ! PSA_ALG_IS_MAC( alg ) )
2363 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002364 }
2365
2366 if( status != PSA_SUCCESS )
2367 memset( operation, 0, sizeof( *operation ) );
2368 return( status );
2369}
2370
John Durkop6ba40d12020-11-10 08:50:04 -08002371#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002372static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2373{
Gilles Peskine3f108122018-12-07 18:14:53 +01002374 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002375 return( psa_hash_abort( &hmac->hash_ctx ) );
2376}
John Durkop6ba40d12020-11-10 08:50:04 -08002377#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002378
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002379psa_status_t psa_mac_abort( psa_mac_operation_t *psa_operation )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002380{
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002381 /* Temporary recast to avoid changing a lot of lines */
2382 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2383
Gilles Peskinefbfac682018-07-08 20:51:54 +02002384 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002385 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002386 /* The object has (apparently) been initialized but it is not
2387 * in use. It's ok to call abort on such an object, and there's
2388 * nothing to do. */
2389 return( PSA_SUCCESS );
2390 }
2391 else
Ronald Cron3d471812021-03-18 13:40:31 +01002392#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002393 if( operation->alg == PSA_ALG_CMAC )
2394 {
2395 mbedtls_cipher_free( &operation->ctx.cmac );
2396 }
2397 else
Ronald Cron3d471812021-03-18 13:40:31 +01002398#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002399#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002400 if( PSA_ALG_IS_HMAC( operation->alg ) )
2401 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002402 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002403 }
2404 else
John Durkopd0321952020-10-29 21:37:36 -07002405#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002406 {
2407 /* Sanity check (shouldn't happen: operation->alg should
2408 * always have been initialized to a valid value). */
2409 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410 }
Moran Peker41deec42018-04-04 15:43:05 +03002411
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 operation->alg = 0;
2413 operation->key_set = 0;
2414 operation->iv_set = 0;
2415 operation->iv_required = 0;
2416 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002417 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002418
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002420
2421bad_state:
2422 /* If abort is called on an uninitialized object, we can't trust
2423 * anything. Wipe the object in case it contains confidential data.
2424 * This may result in a memory leak if a pointer gets overwritten,
2425 * but it's too late to do anything about this. */
2426 memset( operation, 0, sizeof( *operation ) );
2427 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002428}
2429
Ronald Cron3d471812021-03-18 13:40:31 +01002430#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002431static psa_status_t psa_cmac_setup( mbedtls_psa_mac_operation_t *operation,
Steven Cooreman15472f82021-03-02 16:16:22 +01002432 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002433{
Janos Follath24eed8d2019-11-22 13:21:35 +00002434 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002435 const mbedtls_cipher_info_t *cipher_info =
2436 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2437 slot->attr.type, slot->attr.bits,
2438 NULL );
2439 if( cipher_info == NULL )
2440 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002441
2442 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2443 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002444 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002445
2446 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002447 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002448 slot->attr.bits );
2449exit:
2450 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002451}
Ronald Cron3d471812021-03-18 13:40:31 +01002452#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002453
John Durkop6ba40d12020-11-10 08:50:04 -08002454#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002455static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2456 const uint8_t *key,
2457 size_t key_length,
2458 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002459{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002460 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002461 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002462 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002463 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002464 psa_status_t status;
2465
Steven Cooreman0e307642021-02-18 16:18:32 +01002466 hmac->alg = hash_alg;
2467
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002468 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2469 * overflow below. This should never trigger if the hash algorithm
2470 * is implemented correctly. */
2471 /* The size checks against the ipad and opad buffers cannot be written
2472 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2473 * because that triggers -Wlogical-op on GCC 7.3. */
2474 if( block_size > sizeof( ipad ) )
2475 return( PSA_ERROR_NOT_SUPPORTED );
2476 if( block_size > sizeof( hmac->opad ) )
2477 return( PSA_ERROR_NOT_SUPPORTED );
2478 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002479 return( PSA_ERROR_NOT_SUPPORTED );
2480
Gilles Peskined223b522018-06-11 18:12:58 +02002481 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002482 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002483 status = psa_hash_compute( hash_alg, key, key_length,
2484 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002485 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002486 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002487 }
Gilles Peskine96889972018-07-12 17:07:03 +02002488 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2489 * but it is permitted. It is common when HMAC is used in HKDF, for
2490 * example. Don't call `memcpy` in the 0-length because `key` could be
2491 * an invalid pointer which would make the behavior undefined. */
2492 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002493 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002494
Gilles Peskined223b522018-06-11 18:12:58 +02002495 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2496 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002497 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002498 ipad[i] ^= 0x36;
2499 memset( ipad + key_length, 0x36, block_size - key_length );
2500
2501 /* Copy the key material from ipad to opad, flipping the requisite bits,
2502 * and filling the rest of opad with the requisite constant. */
2503 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002504 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2505 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002506
Gilles Peskine01126fa2018-07-12 17:04:55 +02002507 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002508 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002509 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002510
Gilles Peskine01126fa2018-07-12 17:04:55 +02002511 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002512
2513cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002514 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002515
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002516 return( status );
2517}
John Durkop6ba40d12020-11-10 08:50:04 -08002518#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002519
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002520static psa_status_t psa_mac_setup( psa_mac_operation_t *psa_operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002521 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002522 psa_algorithm_t alg,
2523 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002524{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002525 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002526 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002527 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002528 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002529 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002531 /* Temporary recast to avoid changing a lot of lines */
2532 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2533
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002534 /* A context must be freshly initialized before it can be set up. */
2535 if( operation->alg != 0 )
2536 {
2537 return( PSA_ERROR_BAD_STATE );
2538 }
2539
Steven Cooreman15472f82021-03-02 16:16:22 +01002540 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002541 if( status != PSA_SUCCESS )
2542 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002543 if( is_sign )
2544 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002545
Ronald Cron5c522922020-11-14 16:35:34 +01002546 status = psa_get_and_lock_transparent_key_slot_with_policy(
2547 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002548 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002549 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002550
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002551 /* Validate the combination of key type and algorithm */
2552 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002553 if( status != PSA_SUCCESS )
2554 goto exit;
2555
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002556 /* Get the output length for the algorithm and key combination. None of the
2557 * currently supported algorithms have an output length dependent on actual
2558 * key size, so setting it to a bogus value is currently OK. */
2559 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002560
2561 if( operation->mac_size < 4 )
2562 {
2563 /* A very short MAC is too short for security since it can be
2564 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2565 * so we make this our minimum, even though 32 bits is still
2566 * too small for security. */
2567 status = PSA_ERROR_NOT_SUPPORTED;
2568 goto exit;
2569 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002570
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002571 if( operation->mac_size >
2572 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2573 {
2574 /* It's impossible to "truncate" to a larger length than the full length
2575 * of the algorithm. */
2576 status = PSA_ERROR_INVALID_ARGUMENT;
2577 goto exit;
2578 }
2579
Ronald Cron3d471812021-03-18 13:40:31 +01002580#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002581 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002582 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002583 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002584 }
2585 else
Ronald Cron3d471812021-03-18 13:40:31 +01002586#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002587#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002588 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002589 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002590 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002591 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002592 {
2593 status = PSA_ERROR_NOT_SUPPORTED;
2594 goto exit;
2595 }
2596
Gilles Peskine8e338702019-07-30 20:06:31 +02002597 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002598 {
2599 status = PSA_ERROR_INVALID_ARGUMENT;
2600 goto exit;
2601 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002602
Gilles Peskine01126fa2018-07-12 17:04:55 +02002603 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002604 slot->key.data,
2605 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002606 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002607 }
2608 else
John Durkopd0321952020-10-29 21:37:36 -07002609#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002610 {
2611 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002612 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002613
Gilles Peskinefbfac682018-07-08 20:51:54 +02002614exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002615 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002616 {
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002617 psa_mac_abort( psa_operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002618 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002619 else
2620 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002621 operation->key_set = 1;
2622 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002623
Ronald Cron5c522922020-11-14 16:35:34 +01002624 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002625
Ronald Cron5c522922020-11-14 16:35:34 +01002626 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002627}
2628
Gilles Peskine89167cb2018-07-08 20:12:23 +02002629psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002630 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002631 psa_algorithm_t alg )
2632{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002633 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002634}
2635
2636psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002637 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002638 psa_algorithm_t alg )
2639{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002640 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002641}
2642
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002643psa_status_t psa_mac_update( psa_mac_operation_t *psa_operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002644 const uint8_t *input,
2645 size_t input_length )
2646{
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002647 /* Temporary recast to avoid changing a lot of lines */
2648 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2649
Gilles Peskinefbfac682018-07-08 20:51:54 +02002650 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002651 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002652 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002653 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002654 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002655 operation->has_input = 1;
2656
Ronald Cron3d471812021-03-18 13:40:31 +01002657#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002658 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002659 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002660 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2661 input, input_length );
2662 status = mbedtls_to_psa_error( ret );
2663 }
2664 else
Ronald Cron3d471812021-03-18 13:40:31 +01002665#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002666#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002667 if( PSA_ALG_IS_HMAC( operation->alg ) )
2668 {
2669 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2670 input_length );
2671 }
2672 else
John Durkopd0321952020-10-29 21:37:36 -07002673#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002674 {
2675 /* This shouldn't happen if `operation` was initialized by
2676 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002677 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002678 }
2679
Gilles Peskinefbfac682018-07-08 20:51:54 +02002680 if( status != PSA_SUCCESS )
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002681 psa_mac_abort( psa_operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002682 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683}
2684
John Durkop6ba40d12020-11-10 08:50:04 -08002685#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002686static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2687 uint8_t *mac,
2688 size_t mac_size )
2689{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002690 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002691 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002692 size_t hash_size = 0;
2693 size_t block_size = psa_get_hash_block_size( hash_alg );
2694 psa_status_t status;
2695
Gilles Peskine01126fa2018-07-12 17:04:55 +02002696 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2697 if( status != PSA_SUCCESS )
2698 return( status );
2699 /* From here on, tmp needs to be wiped. */
2700
2701 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2702 if( status != PSA_SUCCESS )
2703 goto exit;
2704
2705 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2706 if( status != PSA_SUCCESS )
2707 goto exit;
2708
2709 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2710 if( status != PSA_SUCCESS )
2711 goto exit;
2712
Gilles Peskined911eb72018-08-14 15:18:45 +02002713 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2714 if( status != PSA_SUCCESS )
2715 goto exit;
2716
2717 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002718
2719exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002720 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002721 return( status );
2722}
John Durkop6ba40d12020-11-10 08:50:04 -08002723#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002724
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002725static psa_status_t psa_mac_finish_internal( mbedtls_psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002726 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002727 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002729 if( ! operation->key_set )
2730 return( PSA_ERROR_BAD_STATE );
2731 if( operation->iv_required && ! operation->iv_set )
2732 return( PSA_ERROR_BAD_STATE );
2733
Gilles Peskine8c9def32018-02-08 10:02:12 +01002734 if( mac_size < operation->mac_size )
2735 return( PSA_ERROR_BUFFER_TOO_SMALL );
2736
Ronald Cron3d471812021-03-18 13:40:31 +01002737#if defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002738 if( operation->alg == PSA_ALG_CMAC )
2739 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002740 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002741 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2742 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002743 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002744 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002745 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002746 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002747 else
Ronald Cron3d471812021-03-18 13:40:31 +01002748#endif /* MBEDTLS_PSA_BUILTIN_ALG_CMAC */
John Durkopd0321952020-10-29 21:37:36 -07002749#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002750 if( PSA_ALG_IS_HMAC( operation->alg ) )
2751 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002752 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002753 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002754 }
2755 else
John Durkopd0321952020-10-29 21:37:36 -07002756#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002757 {
2758 /* This shouldn't happen if `operation` was initialized by
2759 * a setup function. */
2760 return( PSA_ERROR_BAD_STATE );
2761 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002762}
2763
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002764psa_status_t psa_mac_sign_finish( psa_mac_operation_t *psa_operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002765 uint8_t *mac,
2766 size_t mac_size,
2767 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002768{
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002769 /* Temporary recast to avoid changing a lot of lines */
2770 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2771
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002772 psa_status_t status;
2773
Jaeden Amero252ef282019-02-15 14:05:35 +00002774 if( operation->alg == 0 )
2775 {
2776 return( PSA_ERROR_BAD_STATE );
2777 }
2778
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002779 /* Fill the output buffer with something that isn't a valid mac
2780 * (barring an attack on the mac and deliberately-crafted input),
2781 * in case the caller doesn't check the return status properly. */
2782 *mac_length = mac_size;
2783 /* If mac_size is 0 then mac may be NULL and then the
2784 * call to memset would have undefined behavior. */
2785 if( mac_size != 0 )
2786 memset( mac, '!', mac_size );
2787
Gilles Peskine89167cb2018-07-08 20:12:23 +02002788 if( ! operation->is_sign )
2789 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002790 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002791 }
mohammad16036df908f2018-04-02 08:34:15 -07002792
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002793 status = psa_mac_finish_internal( operation, mac, mac_size );
2794
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002795 if( status == PSA_SUCCESS )
2796 {
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002797 status = psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002798 if( status == PSA_SUCCESS )
2799 *mac_length = operation->mac_size;
2800 else
2801 memset( mac, '!', mac_size );
2802 }
2803 else
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002804 psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002805 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002806}
2807
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002808psa_status_t psa_mac_verify_finish( psa_mac_operation_t *psa_operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002809 const uint8_t *mac,
2810 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002811{
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002812 /* Temporary recast to avoid changing a lot of lines */
2813 mbedtls_psa_mac_operation_t* operation = &psa_operation->ctx.mbedtls_ctx;
2814
Gilles Peskine828ed142018-06-18 23:25:51 +02002815 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002816 psa_status_t status;
2817
Jaeden Amero252ef282019-02-15 14:05:35 +00002818 if( operation->alg == 0 )
2819 {
2820 return( PSA_ERROR_BAD_STATE );
2821 }
2822
Gilles Peskine89167cb2018-07-08 20:12:23 +02002823 if( operation->is_sign )
2824 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002825 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002826 }
2827 if( operation->mac_size != mac_length )
2828 {
2829 status = PSA_ERROR_INVALID_SIGNATURE;
2830 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002831 }
mohammad16036df908f2018-04-02 08:34:15 -07002832
2833 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002834 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002835 if( status != PSA_SUCCESS )
2836 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002837
2838 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2839 status = PSA_ERROR_INVALID_SIGNATURE;
2840
2841cleanup:
2842 if( status == PSA_SUCCESS )
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002843 status = psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002844 else
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002845 psa_mac_abort( psa_operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002846
Gilles Peskine3f108122018-12-07 18:14:53 +01002847 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002848
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002849 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002850}
2851
2852
Gilles Peskine20035e32018-02-03 22:44:14 +01002853
Gilles Peskine20035e32018-02-03 22:44:14 +01002854/****************************************************************/
2855/* Asymmetric cryptography */
2856/****************************************************************/
2857
Ronald Cron67b1eb32020-12-08 17:37:27 +01002858psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002859 const psa_key_attributes_t *attributes,
2860 const uint8_t *key_buffer, size_t key_buffer_size,
2861 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2862 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002863{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002864 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002865 {
Ronald Cron4501c982021-03-19 20:09:32 +01002866 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2867 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002868 {
Ronald Cron4501c982021-03-19 20:09:32 +01002869#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2870 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2871 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002872 attributes,
2873 key_buffer, key_buffer_size,
2874 alg, hash, hash_length,
2875 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002876#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2877 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002878 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002879 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002880 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002881 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002882 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002883 }
2884 else
Ronald Cron4501c982021-03-19 20:09:32 +01002885 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2886 {
2887 if( PSA_ALG_IS_ECDSA( alg ) )
2888 {
2889#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2890 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2891 return( mbedtls_psa_ecdsa_sign_hash(
2892 attributes,
2893 key_buffer, key_buffer_size,
2894 alg, hash, hash_length,
2895 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002896#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2897 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002898 }
2899 else
2900 {
2901 return( PSA_ERROR_INVALID_ARGUMENT );
2902 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002903 }
Ronald Cron4501c982021-03-19 20:09:32 +01002904
2905 (void)key_buffer;
2906 (void)key_buffer_size;
2907 (void)hash;
2908 (void)hash_length;
2909 (void)signature;
2910 (void)signature_size;
2911 (void)signature_length;
2912
2913 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002914}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002915
2916psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2917 psa_algorithm_t alg,
2918 const uint8_t *hash,
2919 size_t hash_length,
2920 uint8_t *signature,
2921 size_t signature_size,
2922 size_t *signature_length )
2923{
2924 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2925 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2926 psa_key_slot_t *slot;
2927
2928 *signature_length = signature_size;
2929 /* Immediately reject a zero-length signature buffer. This guarantees
2930 * that signature must be a valid pointer. (On the other hand, the hash
2931 * buffer can in principle be empty since it doesn't actually have
2932 * to be a hash.) */
2933 if( signature_size == 0 )
2934 return( PSA_ERROR_BUFFER_TOO_SMALL );
2935
2936 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
2937 PSA_KEY_USAGE_SIGN_HASH,
2938 alg );
2939 if( status != PSA_SUCCESS )
2940 goto exit;
2941 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2942 {
2943 status = PSA_ERROR_INVALID_ARGUMENT;
2944 goto exit;
2945 }
2946
Ronald Cron9f17aa42020-12-08 17:07:25 +01002947 psa_key_attributes_t attributes = {
2948 .core = slot->attr
2949 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002950
Ronald Cron9f17aa42020-12-08 17:07:25 +01002951 status = psa_driver_wrapper_sign_hash(
2952 &attributes, slot->key.data, slot->key.bytes,
2953 alg, hash, hash_length,
2954 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002955
2956exit:
2957 /* Fill the unused part of the output buffer (the whole buffer on error,
2958 * the trailing part on success) with something that isn't a valid mac
2959 * (barring an attack on the mac and deliberately-crafted input),
2960 * in case the caller doesn't check the return status properly. */
2961 if( status == PSA_SUCCESS )
2962 memset( signature + *signature_length, '!',
2963 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02002964 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002965 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002966 /* If signature_size is 0 then we have nothing to do. We must not call
2967 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02002968
Ronald Cron5c522922020-11-14 16:35:34 +01002969 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002970
Ronald Cron5c522922020-11-14 16:35:34 +01002971 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03002972}
2973
Ronald Cron67b1eb32020-12-08 17:37:27 +01002974psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002975 const psa_key_attributes_t *attributes,
2976 const uint8_t *key_buffer, size_t key_buffer_size,
2977 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2978 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002979{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002980 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002981 {
Ronald Cron4501c982021-03-19 20:09:32 +01002982 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2983 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002984 {
Ronald Cron4501c982021-03-19 20:09:32 +01002985#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2986 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2987 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002988 attributes,
2989 key_buffer, key_buffer_size,
2990 alg, hash, hash_length,
2991 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002992#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2993 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002994 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002995 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002996 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002997 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002998 }
itayzafrir5c753392018-05-08 11:18:38 +03002999 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003000 else
Ronald Cron4501c982021-03-19 20:09:32 +01003001 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003002 {
Ronald Cron4501c982021-03-19 20:09:32 +01003003 if( PSA_ALG_IS_ECDSA( alg ) )
3004 {
3005#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3006 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3007 return( mbedtls_psa_ecdsa_verify_hash(
3008 attributes,
3009 key_buffer, key_buffer_size,
3010 alg, hash, hash_length,
3011 signature, signature_length ) );
3012#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3013 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3014 }
3015 else
3016 {
3017 return( PSA_ERROR_INVALID_ARGUMENT );
3018 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003019 }
Ronald Cron4501c982021-03-19 20:09:32 +01003020
3021 (void)key_buffer;
3022 (void)key_buffer_size;
3023 (void)hash;
3024 (void)hash_length;
3025 (void)signature;
3026 (void)signature_length;
3027
3028 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003029}
3030
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003031psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3032 psa_algorithm_t alg,
3033 const uint8_t *hash,
3034 size_t hash_length,
3035 const uint8_t *signature,
3036 size_t signature_length )
3037{
3038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3039 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003040 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041
3042 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003043 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003044 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003045 if( status != PSA_SUCCESS )
3046 return( status );
3047
Ronald Cron9f17aa42020-12-08 17:07:25 +01003048 psa_key_attributes_t attributes = {
3049 .core = slot->attr
3050 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003051
Ronald Cron9f17aa42020-12-08 17:07:25 +01003052 status = psa_driver_wrapper_verify_hash(
3053 &attributes, slot->key.data, slot->key.bytes,
3054 alg, hash, hash_length,
3055 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003056
Ronald Cron5c522922020-11-14 16:35:34 +01003057 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003058
Ronald Cron5c522922020-11-14 16:35:34 +01003059 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003060}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003061
John Durkop0e005192020-10-31 22:06:54 -07003062#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003063static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3064 mbedtls_rsa_context *rsa )
3065{
3066 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3067 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3068 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3069 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3070}
John Durkop0e005192020-10-31 22:06:54 -07003071#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003072
Ronald Croncf56a0a2020-08-04 09:51:30 +02003073psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003074 psa_algorithm_t alg,
3075 const uint8_t *input,
3076 size_t input_length,
3077 const uint8_t *salt,
3078 size_t salt_length,
3079 uint8_t *output,
3080 size_t output_size,
3081 size_t *output_length )
3082{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003083 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003084 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003085 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003086
Darryl Green5cc689a2018-07-24 15:34:10 +01003087 (void) input;
3088 (void) input_length;
3089 (void) salt;
3090 (void) output;
3091 (void) output_size;
3092
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003093 *output_length = 0;
3094
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003095 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3096 return( PSA_ERROR_INVALID_ARGUMENT );
3097
Ronald Cron5c522922020-11-14 16:35:34 +01003098 status = psa_get_and_lock_transparent_key_slot_with_policy(
3099 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003100 if( status != PSA_SUCCESS )
3101 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003102 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3103 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003104 {
3105 status = PSA_ERROR_INVALID_ARGUMENT;
3106 goto exit;
3107 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108
John Durkop6ba40d12020-11-10 08:50:04 -08003109#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3110 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003111 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003112 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003113 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003114 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3115 slot->key.data,
3116 slot->key.bytes,
3117 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003118 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003119 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003120
3121 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003122 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003123 status = PSA_ERROR_BUFFER_TOO_SMALL;
3124 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003125 }
John Durkop0e005192020-10-31 22:06:54 -07003126#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3128 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003129 status = mbedtls_to_psa_error(
3130 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003131 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003132 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003133 MBEDTLS_RSA_PUBLIC,
3134 input_length,
3135 input,
3136 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003137 }
3138 else
John Durkop0e005192020-10-31 22:06:54 -07003139#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3140#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003141 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3142 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003143 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003144 status = mbedtls_to_psa_error(
3145 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003146 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003147 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003148 MBEDTLS_RSA_PUBLIC,
3149 salt, salt_length,
3150 input_length,
3151 input,
3152 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003153 }
3154 else
John Durkop0e005192020-10-31 22:06:54 -07003155#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003157 status = PSA_ERROR_INVALID_ARGUMENT;
3158 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003159 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003160rsa_exit:
3161 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003162 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003163
Steven Cooremana2371e52020-07-28 14:30:39 +02003164 mbedtls_rsa_free( rsa );
3165 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166 }
3167 else
John Durkop9814fa22020-11-04 12:28:15 -08003168#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003169 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003170 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003171 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003172 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003173
3174exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003175 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003176
Ronald Cron5c522922020-11-14 16:35:34 +01003177 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003178}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003179
Ronald Croncf56a0a2020-08-04 09:51:30 +02003180psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003181 psa_algorithm_t alg,
3182 const uint8_t *input,
3183 size_t input_length,
3184 const uint8_t *salt,
3185 size_t salt_length,
3186 uint8_t *output,
3187 size_t output_size,
3188 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003189{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003190 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003191 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003192 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003193
Darryl Green5cc689a2018-07-24 15:34:10 +01003194 (void) input;
3195 (void) input_length;
3196 (void) salt;
3197 (void) output;
3198 (void) output_size;
3199
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003200 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003201
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003202 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3203 return( PSA_ERROR_INVALID_ARGUMENT );
3204
Ronald Cron5c522922020-11-14 16:35:34 +01003205 status = psa_get_and_lock_transparent_key_slot_with_policy(
3206 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003207 if( status != PSA_SUCCESS )
3208 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003209 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003210 {
3211 status = PSA_ERROR_INVALID_ARGUMENT;
3212 goto exit;
3213 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214
John Durkop6ba40d12020-11-10 08:50:04 -08003215#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3216 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003217 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003218 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003219 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003220 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3221 slot->key.data,
3222 slot->key.bytes,
3223 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003224 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003225 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003226
Steven Cooremana2371e52020-07-28 14:30:39 +02003227 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003228 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003229 status = PSA_ERROR_INVALID_ARGUMENT;
3230 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003231 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003232
John Durkop0e005192020-10-31 22:06:54 -07003233#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003234 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003235 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003236 status = mbedtls_to_psa_error(
3237 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003238 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003239 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003240 MBEDTLS_RSA_PRIVATE,
3241 output_length,
3242 input,
3243 output,
3244 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003245 }
3246 else
John Durkop0e005192020-10-31 22:06:54 -07003247#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3248#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003249 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003250 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003251 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003252 status = mbedtls_to_psa_error(
3253 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003254 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003255 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003256 MBEDTLS_RSA_PRIVATE,
3257 salt, salt_length,
3258 output_length,
3259 input,
3260 output,
3261 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003262 }
3263 else
John Durkop0e005192020-10-31 22:06:54 -07003264#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003265 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003266 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003267 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003268
Steven Cooreman4fed4552020-08-03 14:46:03 +02003269rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003270 mbedtls_rsa_free( rsa );
3271 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003272 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003273 else
John Durkop6ba40d12020-11-10 08:50:04 -08003274#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3275 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003276 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003277 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003278 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003279
3280exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003281 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003282
Ronald Cron5c522922020-11-14 16:35:34 +01003283 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003284}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003285
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003286
3287
mohammad1603503973b2018-03-12 15:59:30 +02003288/****************************************************************/
3289/* Symmetric cryptography */
3290/****************************************************************/
3291
Ronald Cronab99ac22020-10-01 16:38:28 +02003292static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3293 mbedtls_svc_key_id_t key,
3294 psa_algorithm_t alg,
3295 mbedtls_operation_t cipher_operation )
3296{
3297 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3298 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3299 psa_key_slot_t *slot;
3300 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3301 PSA_KEY_USAGE_ENCRYPT :
3302 PSA_KEY_USAGE_DECRYPT );
3303
3304 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003305 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003306 return( PSA_ERROR_BAD_STATE );
3307
3308 /* The requested algorithm must be one that can be processed by cipher. */
3309 if( ! PSA_ALG_IS_CIPHER( alg ) )
3310 return( PSA_ERROR_INVALID_ARGUMENT );
3311
3312 /* Fetch key material from key storage. */
3313 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3314 if( status != PSA_SUCCESS )
3315 goto exit;
3316
Ronald Cron49fafa92021-03-10 08:34:23 +01003317 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003318 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003319 * so we only set it (in the driver wrapper) after resources have been
3320 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003321 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003322 if( alg == PSA_ALG_ECB_NO_PADDING )
3323 operation->iv_required = 0;
3324 else
3325 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003326 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003327
Ronald Crona4af55f2020-12-14 14:36:06 +01003328 psa_key_attributes_t attributes = {
3329 .core = slot->attr
3330 };
3331
Ronald Cronab99ac22020-10-01 16:38:28 +02003332 /* Try doing the operation through a driver before using software fallback. */
3333 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003334 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3335 &attributes,
3336 slot->key.data,
3337 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003338 alg );
3339 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003340 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3341 &attributes,
3342 slot->key.data,
3343 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003344 alg );
3345
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003346exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003347 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003348 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003349
Ronald Cron5c522922020-11-14 16:35:34 +01003350 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003351
Ronald Cron5c522922020-11-14 16:35:34 +01003352 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003353}
3354
Gilles Peskinefe119512018-07-08 21:39:34 +02003355psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003356 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003357 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003358{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003359 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003360}
3361
Gilles Peskinefe119512018-07-08 21:39:34 +02003362psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003363 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003364 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003365{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003366 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003367}
3368
Gilles Peskinefe119512018-07-08 21:39:34 +02003369psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003370 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003371 size_t iv_size,
3372 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003373{
Ronald Cron6d051732020-10-01 14:10:20 +02003374 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003375
Ronald Cron5618a392021-03-26 09:52:26 +01003376 *iv_length = 0;
3377
Ronald Cron49fafa92021-03-10 08:34:23 +01003378 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003379 {
3380 return( PSA_ERROR_BAD_STATE );
3381 }
3382
Steven Cooreman7df02922020-09-09 15:28:49 +02003383 if( operation->iv_set || ! operation->iv_required )
3384 {
3385 return( PSA_ERROR_BAD_STATE );
3386 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003387
Ronald Cron5618a392021-03-26 09:52:26 +01003388 if( iv_size < operation->default_iv_length )
3389 {
3390 status = PSA_ERROR_BUFFER_TOO_SMALL;
3391 goto exit;
3392 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003393
Ronald Cron5618a392021-03-26 09:52:26 +01003394 status = psa_generate_random( iv, operation->default_iv_length );
3395 if( status != PSA_SUCCESS )
3396 goto exit;
3397
3398 status = psa_driver_wrapper_cipher_set_iv( operation,
3399 iv,
3400 operation->default_iv_length );
3401
3402exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003403 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003404 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003405 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003406 *iv_length = operation->default_iv_length;
3407 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003408 else
Moran Peker395db872018-05-31 14:07:14 +03003409 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003410
itayzafrir534bd7c2018-08-02 13:56:32 +03003411 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003412}
3413
Gilles Peskinefe119512018-07-08 21:39:34 +02003414psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003415 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003416 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003417{
Ronald Cron6d051732020-10-01 14:10:20 +02003418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003419
Ronald Cron49fafa92021-03-10 08:34:23 +01003420 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003421 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003422
Steven Cooreman7df02922020-09-09 15:28:49 +02003423 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003424 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003425
3426 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3427 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003428
Ronald Crondd24c9b2020-12-15 14:10:01 +01003429 status = psa_driver_wrapper_cipher_set_iv( operation,
3430 iv,
3431 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003432
itayzafrir534bd7c2018-08-02 13:56:32 +03003433 if( status == PSA_SUCCESS )
3434 operation->iv_set = 1;
3435 else
mohammad1603503973b2018-03-12 15:59:30 +02003436 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003437 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003438}
3439
Gilles Peskinee553c652018-06-04 16:22:46 +02003440psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3441 const uint8_t *input,
3442 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003443 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003444 size_t output_size,
3445 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003446{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003448
Ronald Cron49fafa92021-03-10 08:34:23 +01003449 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003450 {
3451 return( PSA_ERROR_BAD_STATE );
3452 }
3453 if( operation->iv_required && ! operation->iv_set )
3454 {
3455 return( PSA_ERROR_BAD_STATE );
3456 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003457
Ronald Crondd24c9b2020-12-15 14:10:01 +01003458 status = psa_driver_wrapper_cipher_update( operation,
3459 input,
3460 input_length,
3461 output,
3462 output_size,
3463 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003464 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003465 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003466
itayzafrir534bd7c2018-08-02 13:56:32 +03003467 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003468}
3469
Gilles Peskinee553c652018-06-04 16:22:46 +02003470psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3471 uint8_t *output,
3472 size_t output_size,
3473 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003474{
David Saadab4ecc272019-02-14 13:48:10 +02003475 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003476
Ronald Cron49fafa92021-03-10 08:34:23 +01003477 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003478 {
3479 return( PSA_ERROR_BAD_STATE );
3480 }
3481 if( operation->iv_required && ! operation->iv_set )
3482 {
3483 return( PSA_ERROR_BAD_STATE );
3484 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003485
Ronald Crondd24c9b2020-12-15 14:10:01 +01003486 status = psa_driver_wrapper_cipher_finish( operation,
3487 output,
3488 output_size,
3489 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003490 if( status == PSA_SUCCESS )
3491 return( psa_cipher_abort( operation ) );
3492 else
3493 {
3494 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003495 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003496
Steven Cooremanef8575e2020-09-11 11:44:50 +02003497 return( status );
3498 }
mohammad1603503973b2018-03-12 15:59:30 +02003499}
3500
Gilles Peskinee553c652018-06-04 16:22:46 +02003501psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3502{
Ronald Cron49fafa92021-03-10 08:34:23 +01003503 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003504 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003505 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003506 * in use. It's ok to call abort on such an object, and there's
3507 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003508 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003509 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003510
Ronald Crondd24c9b2020-12-15 14:10:01 +01003511 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003512
Ronald Cron49fafa92021-03-10 08:34:23 +01003513 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003514 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003515 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003516
Moran Peker395db872018-05-31 14:07:14 +03003517 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003518}
3519
mohammad16035955c982018-04-26 00:53:03 +03003520/****************************************************************/
3521/* AEAD */
3522/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003523
Ronald Croncf56a0a2020-08-04 09:51:30 +02003524psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003525 psa_algorithm_t alg,
3526 const uint8_t *nonce,
3527 size_t nonce_length,
3528 const uint8_t *additional_data,
3529 size_t additional_data_length,
3530 const uint8_t *plaintext,
3531 size_t plaintext_length,
3532 uint8_t *ciphertext,
3533 size_t ciphertext_size,
3534 size_t *ciphertext_length )
3535{
Ronald Cron215633c2021-03-16 17:15:37 +01003536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3537 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003538
mohammad1603f08a5502018-06-03 15:05:47 +03003539 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003540
Steven Cooremanea7ab132021-03-17 16:28:00 +01003541 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3542 return( PSA_ERROR_NOT_SUPPORTED );
3543
Ronald Cron9a986162021-03-26 12:40:07 +01003544 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003545 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003546 if( status != PSA_SUCCESS )
3547 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003548
Ronald Cron215633c2021-03-16 17:15:37 +01003549 psa_key_attributes_t attributes = {
3550 .core = slot->attr
3551 };
mohammad16035955c982018-04-26 00:53:03 +03003552
Ronald Cronde822812021-03-17 16:08:20 +01003553 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003554 &attributes, slot->key.data, slot->key.bytes,
3555 alg,
3556 nonce, nonce_length,
3557 additional_data, additional_data_length,
3558 plaintext, plaintext_length,
3559 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003560
Gilles Peskineedf9a652018-08-17 18:11:56 +02003561 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3562 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003563
Ronald Cron9f310172021-03-16 16:36:37 +01003564 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003565
mohammad16035955c982018-04-26 00:53:03 +03003566 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003567}
3568
Ronald Croncf56a0a2020-08-04 09:51:30 +02003569psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003570 psa_algorithm_t alg,
3571 const uint8_t *nonce,
3572 size_t nonce_length,
3573 const uint8_t *additional_data,
3574 size_t additional_data_length,
3575 const uint8_t *ciphertext,
3576 size_t ciphertext_length,
3577 uint8_t *plaintext,
3578 size_t plaintext_size,
3579 size_t *plaintext_length )
3580{
Ronald Cron215633c2021-03-16 17:15:37 +01003581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3582 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003583
Gilles Peskineee652a32018-06-01 19:23:52 +02003584 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003585
Steven Cooremanea7ab132021-03-17 16:28:00 +01003586 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3587 return( PSA_ERROR_NOT_SUPPORTED );
3588
Ronald Cron9a986162021-03-26 12:40:07 +01003589 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003590 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003591 if( status != PSA_SUCCESS )
3592 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003593
Ronald Cron215633c2021-03-16 17:15:37 +01003594 psa_key_attributes_t attributes = {
3595 .core = slot->attr
3596 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003597
Ronald Cronde822812021-03-17 16:08:20 +01003598 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003599 &attributes, slot->key.data, slot->key.bytes,
3600 alg,
3601 nonce, nonce_length,
3602 additional_data, additional_data_length,
3603 ciphertext, ciphertext_length,
3604 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003605
Gilles Peskineedf9a652018-08-17 18:11:56 +02003606 if( status != PSA_SUCCESS && plaintext_size != 0 )
3607 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003608
Ronald Cron215633c2021-03-16 17:15:37 +01003609 psa_unlock_key_slot( slot );
3610
Gilles Peskineedf9a652018-08-17 18:11:56 +02003611 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003612}
3613
Gilles Peskinee59236f2018-01-27 23:32:46 +01003614/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003615/* Generators */
3616/****************************************************************/
3617
John Durkop07cc04a2020-11-16 22:08:34 -08003618#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3619 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3620 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3621#define AT_LEAST_ONE_BUILTIN_KDF
3622#endif
3623
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003624#define HKDF_STATE_INIT 0 /* no input yet */
3625#define HKDF_STATE_STARTED 1 /* got salt */
3626#define HKDF_STATE_KEYED 2 /* got key */
3627#define HKDF_STATE_OUTPUT 3 /* output started */
3628
Gilles Peskinecbe66502019-05-16 16:59:18 +02003629static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003630 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003631{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003632 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3633 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003634 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003635 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003636}
3637
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003638psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003639{
3640 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003641 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003642 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003643 {
3644 /* The object has (apparently) been initialized but it is not
3645 * in use. It's ok to call abort on such an object, and there's
3646 * nothing to do. */
3647 }
3648 else
John Durkopd0321952020-10-29 21:37:36 -07003649#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003650 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003651 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003652 mbedtls_free( operation->ctx.hkdf.info );
3653 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003654 }
John Durkop07cc04a2020-11-16 22:08:34 -08003655 else
3656#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3657#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3658 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3659 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003660 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003661 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003662 {
Janos Follath6a1d2622019-06-11 10:37:28 +01003663 if( operation->ctx.tls12_prf.seed != NULL )
3664 {
3665 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3666 operation->ctx.tls12_prf.seed_length );
3667 mbedtls_free( operation->ctx.tls12_prf.seed );
3668 }
3669
3670 if( operation->ctx.tls12_prf.label != NULL )
3671 {
3672 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3673 operation->ctx.tls12_prf.label_length );
3674 mbedtls_free( operation->ctx.tls12_prf.label );
3675 }
3676
3677 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
3678
3679 /* We leave the fields Ai and output_block to be erased safely by the
3680 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003681 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003682 else
John Durkop07cc04a2020-11-16 22:08:34 -08003683#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3684 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003685 {
3686 status = PSA_ERROR_BAD_STATE;
3687 }
Janos Follath083036a2019-06-11 10:22:26 +01003688 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003689 return( status );
3690}
3691
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003692psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003693 size_t *capacity)
3694{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003695 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003696 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003697 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003698 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003699 }
3700
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003701 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003702 return( PSA_SUCCESS );
3703}
3704
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003705psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003706 size_t capacity )
3707{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003708 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003709 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003710 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003711 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003712 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003713 return( PSA_SUCCESS );
3714}
3715
John Durkopd0321952020-10-29 21:37:36 -07003716#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003717/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003718 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003719static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003720 psa_algorithm_t hash_alg,
3721 uint8_t *output,
3722 size_t output_length )
3723{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003724 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003725 psa_status_t status;
3726
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003727 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3728 return( PSA_ERROR_BAD_STATE );
3729 hkdf->state = HKDF_STATE_OUTPUT;
3730
Gilles Peskinebef7f142018-07-12 17:22:21 +02003731 while( output_length != 0 )
3732 {
3733 /* Copy what remains of the current block */
3734 uint8_t n = hash_length - hkdf->offset_in_block;
3735 if( n > output_length )
3736 n = (uint8_t) output_length;
3737 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3738 output += n;
3739 output_length -= n;
3740 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003741 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003742 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003743 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003744 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003745 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003746 * object was corrupted or if this function is called directly
3747 * inside the library. */
3748 if( hkdf->block_number == 0xff )
3749 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003750
3751 /* We need a new block */
3752 ++hkdf->block_number;
3753 hkdf->offset_in_block = 0;
3754 status = psa_hmac_setup_internal( &hkdf->hmac,
3755 hkdf->prk, hash_length,
3756 hash_alg );
3757 if( status != PSA_SUCCESS )
3758 return( status );
3759 if( hkdf->block_number != 1 )
3760 {
3761 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3762 hkdf->output_block,
3763 hash_length );
3764 if( status != PSA_SUCCESS )
3765 return( status );
3766 }
3767 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3768 hkdf->info,
3769 hkdf->info_length );
3770 if( status != PSA_SUCCESS )
3771 return( status );
3772 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3773 &hkdf->block_number, 1 );
3774 if( status != PSA_SUCCESS )
3775 return( status );
3776 status = psa_hmac_finish_internal( &hkdf->hmac,
3777 hkdf->output_block,
3778 sizeof( hkdf->output_block ) );
3779 if( status != PSA_SUCCESS )
3780 return( status );
3781 }
3782
3783 return( PSA_SUCCESS );
3784}
John Durkop07cc04a2020-11-16 22:08:34 -08003785#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003786
John Durkop07cc04a2020-11-16 22:08:34 -08003787#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3788 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003789static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3790 psa_tls12_prf_key_derivation_t *tls12_prf,
3791 psa_algorithm_t alg )
3792{
3793 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003794 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01003795 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
3796 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003797
Janos Follath7742fee2019-06-17 12:58:10 +01003798 /* We can't be wanting more output after block 0xff, otherwise
3799 * the capacity check in psa_key_derivation_output_bytes() would have
3800 * prevented this call. It could happen only if the operation
3801 * object was corrupted or if this function is called directly
3802 * inside the library. */
3803 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003804 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003805
3806 /* We need a new block */
3807 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003808 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003809
3810 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3811 *
3812 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3813 *
3814 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3815 * HMAC_hash(secret, A(2) + seed) +
3816 * HMAC_hash(secret, A(3) + seed) + ...
3817 *
3818 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003819 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003820 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003821 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003822 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003823 * is currently extracted as `output_block` and where i is
3824 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003825 */
3826
Janos Follathea29bfb2019-06-19 12:21:20 +01003827 /* Save the hash context before using it, to preserve the hash state with
3828 * only the inner padding in it. We need this, because inner padding depends
3829 * on the key (secret in the RFC's terminology). */
3830 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
3831 if( status != PSA_SUCCESS )
3832 goto cleanup;
3833
3834 /* Calculate A(i) where i = tls12_prf->block_number. */
3835 if( tls12_prf->block_number == 1 )
3836 {
3837 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3838 * the variable seed and in this instance means it in the context of the
3839 * P_hash function, where seed = label + seed.) */
3840 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3841 tls12_prf->label, tls12_prf->label_length );
3842 if( status != PSA_SUCCESS )
3843 goto cleanup;
3844 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3845 tls12_prf->seed, tls12_prf->seed_length );
3846 if( status != PSA_SUCCESS )
3847 goto cleanup;
3848 }
3849 else
3850 {
3851 /* A(i) = HMAC_hash(secret, A(i-1)) */
3852 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3853 tls12_prf->Ai, hash_length );
3854 if( status != PSA_SUCCESS )
3855 goto cleanup;
3856 }
3857
3858 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3859 tls12_prf->Ai, hash_length );
3860 if( status != PSA_SUCCESS )
3861 goto cleanup;
3862 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3863 if( status != PSA_SUCCESS )
3864 goto cleanup;
3865
3866 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
3867 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3868 tls12_prf->Ai, hash_length );
3869 if( status != PSA_SUCCESS )
3870 goto cleanup;
3871 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3872 tls12_prf->label, tls12_prf->label_length );
3873 if( status != PSA_SUCCESS )
3874 goto cleanup;
3875 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3876 tls12_prf->seed, tls12_prf->seed_length );
3877 if( status != PSA_SUCCESS )
3878 goto cleanup;
3879 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3880 tls12_prf->output_block, hash_length );
3881 if( status != PSA_SUCCESS )
3882 goto cleanup;
3883 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3884 if( status != PSA_SUCCESS )
3885 goto cleanup;
3886
Janos Follath7742fee2019-06-17 12:58:10 +01003887
3888cleanup:
3889
Janos Follathea29bfb2019-06-19 12:21:20 +01003890 cleanup_status = psa_hash_abort( &backup );
3891 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3892 status = cleanup_status;
3893
3894 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003895}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003896
Janos Follath844eb0e2019-06-19 12:10:49 +01003897static psa_status_t psa_key_derivation_tls12_prf_read(
3898 psa_tls12_prf_key_derivation_t *tls12_prf,
3899 psa_algorithm_t alg,
3900 uint8_t *output,
3901 size_t output_length )
3902{
3903 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003904 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003905 psa_status_t status;
3906 uint8_t offset, length;
3907
3908 while( output_length != 0 )
3909 {
3910 /* Check if we have fully processed the current block. */
3911 if( tls12_prf->left_in_block == 0 )
3912 {
3913 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3914 alg );
3915 if( status != PSA_SUCCESS )
3916 return( status );
3917
3918 continue;
3919 }
3920
3921 if( tls12_prf->left_in_block > output_length )
3922 length = (uint8_t) output_length;
3923 else
3924 length = tls12_prf->left_in_block;
3925
3926 offset = hash_length - tls12_prf->left_in_block;
3927 memcpy( output, tls12_prf->output_block + offset, length );
3928 output += length;
3929 output_length -= length;
3930 tls12_prf->left_in_block -= length;
3931 }
3932
3933 return( PSA_SUCCESS );
3934}
John Durkop07cc04a2020-11-16 22:08:34 -08003935#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3936 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003937
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003938psa_status_t psa_key_derivation_output_bytes(
3939 psa_key_derivation_operation_t *operation,
3940 uint8_t *output,
3941 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003942{
3943 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003944 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003945
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003946 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003947 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003948 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003949 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003950 }
3951
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003952 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003953 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003954 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003955 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003956 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003957 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003958 goto exit;
3959 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003960 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003961 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003962 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003963 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003964 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3965 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003966 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003967 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003968 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003969 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003970 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003971
John Durkopd0321952020-10-29 21:37:36 -07003972#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003973 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003974 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003975 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003976 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003977 output, output_length );
3978 }
Janos Follathadbec812019-06-14 11:05:39 +01003979 else
John Durkop07cc04a2020-11-16 22:08:34 -08003980#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3981#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3982 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003983 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003984 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003985 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003986 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003987 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003988 output_length );
3989 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003990 else
John Durkop07cc04a2020-11-16 22:08:34 -08003991#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3992 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003993 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003994 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003995 return( PSA_ERROR_BAD_STATE );
3996 }
3997
3998exit:
3999 if( status != PSA_SUCCESS )
4000 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004001 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004002 * This allows us to differentiate between exhausted operations and
4003 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4004 * operations. */
4005 psa_algorithm_t alg = operation->alg;
4006 psa_key_derivation_abort( operation );
4007 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004008 memset( output, '!', output_length );
4009 }
4010 return( status );
4011}
4012
David Brown7807bf72021-02-09 16:28:23 -07004013#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004014static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4015{
4016 if( data_size >= 8 )
4017 mbedtls_des_key_set_parity( data );
4018 if( data_size >= 16 )
4019 mbedtls_des_key_set_parity( data + 8 );
4020 if( data_size >= 24 )
4021 mbedtls_des_key_set_parity( data + 16 );
4022}
David Brown7807bf72021-02-09 16:28:23 -07004023#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004024
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004025static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004026 psa_key_slot_t *slot,
4027 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004028 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004029{
4030 uint8_t *data = NULL;
4031 size_t bytes = PSA_BITS_TO_BYTES( bits );
4032 psa_status_t status;
4033
Gilles Peskine8e338702019-07-30 20:06:31 +02004034 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004035 return( PSA_ERROR_INVALID_ARGUMENT );
4036 if( bits % 8 != 0 )
4037 return( PSA_ERROR_INVALID_ARGUMENT );
4038 data = mbedtls_calloc( 1, bytes );
4039 if( data == NULL )
4040 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4041
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004042 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004043 if( status != PSA_SUCCESS )
4044 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004045#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004046 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004047 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004048#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004049
4050 status = psa_allocate_buffer_to_slot( slot, bytes );
4051 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004052 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004053
Ronald Cronbf33c932020-11-28 18:06:53 +01004054 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004055 psa_key_attributes_t attributes = {
4056 .core = slot->attr
4057 };
4058
Ronald Cronbf33c932020-11-28 18:06:53 +01004059 status = psa_driver_wrapper_import_key( &attributes,
4060 data, bytes,
4061 slot->key.data,
4062 slot->key.bytes,
4063 &slot->key.bytes, &bits );
4064 if( bits != slot->attr.bits )
4065 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004066
4067exit:
4068 mbedtls_free( data );
4069 return( status );
4070}
4071
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004072psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004073 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004074 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004075{
4076 psa_status_t status;
4077 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004078 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004079
Ronald Cron81709fc2020-11-14 12:10:32 +01004080 *key = MBEDTLS_SVC_KEY_ID_INIT;
4081
Gilles Peskine0f84d622019-09-12 19:03:13 +02004082 /* Reject any attempt to create a zero-length key so that we don't
4083 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4084 if( psa_get_key_bits( attributes ) == 0 )
4085 return( PSA_ERROR_INVALID_ARGUMENT );
4086
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004087 if( ! operation->can_output_key )
4088 return( PSA_ERROR_NOT_PERMITTED );
4089
Ronald Cron81709fc2020-11-14 12:10:32 +01004090 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4091 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004092#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4093 if( driver != NULL )
4094 {
4095 /* Deriving a key in a secure element is not implemented yet. */
4096 status = PSA_ERROR_NOT_SUPPORTED;
4097 }
4098#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004099 if( status == PSA_SUCCESS )
4100 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004101 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004102 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004103 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004104 }
4105 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004106 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004107 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004108 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004109
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004110 return( status );
4111}
4112
Gilles Peskineeab56e42018-07-12 17:12:33 +02004113
4114
4115/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004116/* Key derivation */
4117/****************************************************************/
4118
Steven Cooreman932ffb72021-02-15 12:14:32 +01004119#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004120static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004121 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004122 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004123{
John Durkop07cc04a2020-11-16 22:08:34 -08004124 int is_kdf_alg_supported;
4125
Janos Follath5fe19732019-06-20 15:09:30 +01004126 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4127 * initialisers for this union leave some bytes unspecified.) */
4128 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4129
Gilles Peskine969c5d62019-01-16 15:53:06 +01004130 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004131#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004132 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4133 is_kdf_alg_supported = 1;
4134 else
4135#endif
4136#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4137 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4138 is_kdf_alg_supported = 1;
4139 else
4140#endif
4141#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4142 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4143 is_kdf_alg_supported = 1;
4144 else
4145#endif
4146 is_kdf_alg_supported = 0;
4147
4148 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004149 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004150 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004151 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004152 if( hash_size == 0 )
4153 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004154 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4155 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004156 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004157 {
4158 return( PSA_ERROR_NOT_SUPPORTED );
4159 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004160 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004161 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004162 }
John Durkop07cc04a2020-11-16 22:08:34 -08004163
4164 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004165}
John Durkop07cc04a2020-11-16 22:08:34 -08004166#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004167
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004168psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004169 psa_algorithm_t alg )
4170{
4171 psa_status_t status;
4172
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004173 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004174 return( PSA_ERROR_BAD_STATE );
4175
Gilles Peskine6843c292019-01-18 16:44:49 +01004176 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4177 return( PSA_ERROR_INVALID_ARGUMENT );
4178 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004179 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004180#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004181 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004182 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004183#else
4184 return( PSA_ERROR_NOT_SUPPORTED );
4185#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004186 }
4187 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4188 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004189#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004190 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004191#else
4192 return( PSA_ERROR_NOT_SUPPORTED );
4193#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004194 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004195 else
4196 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004197
4198 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004199 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004200 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004201}
4202
John Durkopd0321952020-10-29 21:37:36 -07004203#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004204static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004205 psa_algorithm_t hash_alg,
4206 psa_key_derivation_step_t step,
4207 const uint8_t *data,
4208 size_t data_length )
4209{
4210 psa_status_t status;
4211 switch( step )
4212 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004213 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004214 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004215 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004216 status = psa_hmac_setup_internal( &hkdf->hmac,
4217 data, data_length,
4218 hash_alg );
4219 if( status != PSA_SUCCESS )
4220 return( status );
4221 hkdf->state = HKDF_STATE_STARTED;
4222 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004223 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004224 /* If no salt was provided, use an empty salt. */
4225 if( hkdf->state == HKDF_STATE_INIT )
4226 {
4227 status = psa_hmac_setup_internal( &hkdf->hmac,
4228 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004229 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004230 if( status != PSA_SUCCESS )
4231 return( status );
4232 hkdf->state = HKDF_STATE_STARTED;
4233 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004234 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004235 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004236 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4237 data, data_length );
4238 if( status != PSA_SUCCESS )
4239 return( status );
4240 status = psa_hmac_finish_internal( &hkdf->hmac,
4241 hkdf->prk,
4242 sizeof( hkdf->prk ) );
4243 if( status != PSA_SUCCESS )
4244 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004245 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004246 hkdf->block_number = 0;
4247 hkdf->state = HKDF_STATE_KEYED;
4248 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004249 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004250 if( hkdf->state == HKDF_STATE_OUTPUT )
4251 return( PSA_ERROR_BAD_STATE );
4252 if( hkdf->info_set )
4253 return( PSA_ERROR_BAD_STATE );
4254 hkdf->info_length = data_length;
4255 if( data_length != 0 )
4256 {
4257 hkdf->info = mbedtls_calloc( 1, data_length );
4258 if( hkdf->info == NULL )
4259 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4260 memcpy( hkdf->info, data, data_length );
4261 }
4262 hkdf->info_set = 1;
4263 return( PSA_SUCCESS );
4264 default:
4265 return( PSA_ERROR_INVALID_ARGUMENT );
4266 }
4267}
John Durkop07cc04a2020-11-16 22:08:34 -08004268#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004269
John Durkop07cc04a2020-11-16 22:08:34 -08004270#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4271 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004272static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4273 const uint8_t *data,
4274 size_t data_length )
4275{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004276 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004277 return( PSA_ERROR_BAD_STATE );
4278
Janos Follathd6dce9f2019-07-04 09:11:38 +01004279 if( data_length != 0 )
4280 {
4281 prf->seed = mbedtls_calloc( 1, data_length );
4282 if( prf->seed == NULL )
4283 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004284
Janos Follathd6dce9f2019-07-04 09:11:38 +01004285 memcpy( prf->seed, data, data_length );
4286 prf->seed_length = data_length;
4287 }
Janos Follathf08e2652019-06-13 09:05:41 +01004288
Gilles Peskine43f958b2020-12-13 14:55:14 +01004289 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004290
4291 return( PSA_SUCCESS );
4292}
4293
Janos Follath81550542019-06-13 14:26:34 +01004294static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4295 psa_algorithm_t hash_alg,
4296 const uint8_t *data,
4297 size_t data_length )
4298{
4299 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004300 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004301 return( PSA_ERROR_BAD_STATE );
4302
4303 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4304 if( status != PSA_SUCCESS )
4305 return( status );
4306
Gilles Peskine43f958b2020-12-13 14:55:14 +01004307 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004308
4309 return( PSA_SUCCESS );
4310}
4311
Janos Follath63028dd2019-06-13 09:15:47 +01004312static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4313 const uint8_t *data,
4314 size_t data_length )
4315{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004316 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004317 return( PSA_ERROR_BAD_STATE );
4318
Janos Follathd6dce9f2019-07-04 09:11:38 +01004319 if( data_length != 0 )
4320 {
4321 prf->label = mbedtls_calloc( 1, data_length );
4322 if( prf->label == NULL )
4323 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004324
Janos Follathd6dce9f2019-07-04 09:11:38 +01004325 memcpy( prf->label, data, data_length );
4326 prf->label_length = data_length;
4327 }
Janos Follath63028dd2019-06-13 09:15:47 +01004328
Gilles Peskine43f958b2020-12-13 14:55:14 +01004329 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004330
4331 return( PSA_SUCCESS );
4332}
4333
Janos Follathb03233e2019-06-11 15:30:30 +01004334static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4335 psa_algorithm_t hash_alg,
4336 psa_key_derivation_step_t step,
4337 const uint8_t *data,
4338 size_t data_length )
4339{
Janos Follathb03233e2019-06-11 15:30:30 +01004340 switch( step )
4341 {
Janos Follathf08e2652019-06-13 09:05:41 +01004342 case PSA_KEY_DERIVATION_INPUT_SEED:
4343 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004344 case PSA_KEY_DERIVATION_INPUT_SECRET:
4345 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004346 case PSA_KEY_DERIVATION_INPUT_LABEL:
4347 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004348 default:
4349 return( PSA_ERROR_INVALID_ARGUMENT );
4350 }
4351}
John Durkop07cc04a2020-11-16 22:08:34 -08004352#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4353 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4354
4355#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4356static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4357 psa_tls12_prf_key_derivation_t *prf,
4358 psa_algorithm_t hash_alg,
4359 const uint8_t *data,
4360 size_t data_length )
4361{
4362 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004363 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004364 uint8_t *cur = pms;
4365
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004366 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004367 return( PSA_ERROR_INVALID_ARGUMENT );
4368
4369 /* Quoting RFC 4279, Section 2:
4370 *
4371 * The premaster secret is formed as follows: if the PSK is N octets
4372 * long, concatenate a uint16 with the value N, N zero octets, a second
4373 * uint16 with the value N, and the PSK itself.
4374 */
4375
4376 *cur++ = ( data_length >> 8 ) & 0xff;
4377 *cur++ = ( data_length >> 0 ) & 0xff;
4378 memset( cur, 0, data_length );
4379 cur += data_length;
4380 *cur++ = pms[0];
4381 *cur++ = pms[1];
4382 memcpy( cur, data, data_length );
4383 cur += data_length;
4384
4385 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
4386
4387 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4388 return( status );
4389}
Janos Follath6660f0e2019-06-17 08:44:03 +01004390
4391static psa_status_t psa_tls12_prf_psk_to_ms_input(
4392 psa_tls12_prf_key_derivation_t *prf,
4393 psa_algorithm_t hash_alg,
4394 psa_key_derivation_step_t step,
4395 const uint8_t *data,
4396 size_t data_length )
4397{
4398 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004399 {
Janos Follath6660f0e2019-06-17 08:44:03 +01004400 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
4401 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004402 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004403
4404 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
4405}
John Durkop07cc04a2020-11-16 22:08:34 -08004406#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004407
Gilles Peskineb8965192019-09-24 16:21:10 +02004408/** Check whether the given key type is acceptable for the given
4409 * input step of a key derivation.
4410 *
4411 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4412 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4413 * Both secret and non-secret inputs can alternatively have the type
4414 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4415 * that the input was passed as a buffer rather than via a key object.
4416 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004417static int psa_key_derivation_check_input_type(
4418 psa_key_derivation_step_t step,
4419 psa_key_type_t key_type )
4420{
4421 switch( step )
4422 {
4423 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004424 if( key_type == PSA_KEY_TYPE_DERIVE )
4425 return( PSA_SUCCESS );
4426 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004427 return( PSA_SUCCESS );
4428 break;
4429 case PSA_KEY_DERIVATION_INPUT_LABEL:
4430 case PSA_KEY_DERIVATION_INPUT_SALT:
4431 case PSA_KEY_DERIVATION_INPUT_INFO:
4432 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004433 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4434 return( PSA_SUCCESS );
4435 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004436 return( PSA_SUCCESS );
4437 break;
4438 }
4439 return( PSA_ERROR_INVALID_ARGUMENT );
4440}
4441
Janos Follathb80a94e2019-06-12 15:54:46 +01004442static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004443 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004444 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004445 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004446 const uint8_t *data,
4447 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004448{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004449 psa_status_t status;
4450 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4451
4452 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004453 if( status != PSA_SUCCESS )
4454 goto exit;
4455
John Durkopd0321952020-10-29 21:37:36 -07004456#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004457 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004458 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004459 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004460 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004461 step, data, data_length );
4462 }
John Durkop07cc04a2020-11-16 22:08:34 -08004463 else
4464#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4465#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4466 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004467 {
Janos Follathb03233e2019-06-11 15:30:30 +01004468 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
4469 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4470 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004471 }
John Durkop07cc04a2020-11-16 22:08:34 -08004472 else
4473#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4474#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4475 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004476 {
4477 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
4478 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4479 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004480 }
4481 else
John Durkop07cc04a2020-11-16 22:08:34 -08004482#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004483 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004484 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004485 (void) data;
4486 (void) data_length;
4487 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004488 return( PSA_ERROR_BAD_STATE );
4489 }
4490
Gilles Peskine224b0d62019-09-23 18:13:17 +02004491exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004492 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004493 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004494 return( status );
4495}
4496
Janos Follath51f4a0f2019-06-14 11:35:55 +01004497psa_status_t psa_key_derivation_input_bytes(
4498 psa_key_derivation_operation_t *operation,
4499 psa_key_derivation_step_t step,
4500 const uint8_t *data,
4501 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004502{
Gilles Peskineb8965192019-09-24 16:21:10 +02004503 return( psa_key_derivation_input_internal( operation, step,
4504 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004505 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004506}
4507
Janos Follath51f4a0f2019-06-14 11:35:55 +01004508psa_status_t psa_key_derivation_input_key(
4509 psa_key_derivation_operation_t *operation,
4510 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004511 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004512{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004513 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004514 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004515 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004516
Ronald Cron5c522922020-11-14 16:35:34 +01004517 status = psa_get_and_lock_transparent_key_slot_with_policy(
4518 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004519 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004520 {
4521 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004522 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004523 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004524
4525 /* Passing a key object as a SECRET input unlocks the permission
4526 * to output to a key object. */
4527 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4528 operation->can_output_key = 1;
4529
Ronald Cronf95a2b12020-10-22 15:24:49 +02004530 status = psa_key_derivation_input_internal( operation,
4531 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004532 slot->key.data,
4533 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004534
Ronald Cron5c522922020-11-14 16:35:34 +01004535 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004536
Ronald Cron5c522922020-11-14 16:35:34 +01004537 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004538}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004539
4540
4541
4542/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004543/* Key agreement */
4544/****************************************************************/
4545
John Durkop6ba40d12020-11-10 08:50:04 -08004546#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004547static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4548 size_t peer_key_length,
4549 const mbedtls_ecp_keypair *our_key,
4550 uint8_t *shared_secret,
4551 size_t shared_secret_size,
4552 size_t *shared_secret_length )
4553{
Steven Cooremand4867872020-08-05 16:31:39 +02004554 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004555 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004556 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004557 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004558 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004559 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004560
Ronald Cron90857082020-11-25 14:58:33 +01004561 status = mbedtls_psa_ecp_load_representation(
4562 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004563 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004564 peer_key,
4565 peer_key_length,
4566 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004567 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004568 goto exit;
4569
Jaeden Amero97271b32019-01-10 19:38:51 +00004570 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004571 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004572 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004573 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004574 status = mbedtls_to_psa_error(
4575 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4576 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004577 goto exit;
4578
Jaeden Amero97271b32019-01-10 19:38:51 +00004579 status = mbedtls_to_psa_error(
4580 mbedtls_ecdh_calc_secret( &ecdh,
4581 shared_secret_length,
4582 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004583 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004584 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004585 if( status != PSA_SUCCESS )
4586 goto exit;
4587 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4588 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004589
4590exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004591 if( status != PSA_SUCCESS )
4592 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004593 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004594 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004595 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004596
Jaeden Amero97271b32019-01-10 19:38:51 +00004597 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004598}
John Durkop6ba40d12020-11-10 08:50:04 -08004599#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004600
Gilles Peskine01d718c2018-09-18 12:01:02 +02004601#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4602
Gilles Peskine0216fe12019-04-11 21:23:21 +02004603static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4604 psa_key_slot_t *private_key,
4605 const uint8_t *peer_key,
4606 size_t peer_key_length,
4607 uint8_t *shared_secret,
4608 size_t shared_secret_size,
4609 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004610{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004611 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004612 {
John Durkop6ba40d12020-11-10 08:50:04 -08004613#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004614 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004615 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004616 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004617 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004618 psa_status_t status = mbedtls_psa_ecp_load_representation(
4619 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004620 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004621 private_key->key.data,
4622 private_key->key.bytes,
4623 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004624 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004625 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004626 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004627 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004628 shared_secret, shared_secret_size,
4629 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004630 mbedtls_ecp_keypair_free( ecp );
4631 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004632 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004633#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004634 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004635 (void) private_key;
4636 (void) peer_key;
4637 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004638 (void) shared_secret;
4639 (void) shared_secret_size;
4640 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004641 return( PSA_ERROR_NOT_SUPPORTED );
4642 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004643}
4644
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004645/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004646 * to potentially free embedded data structures and wipe confidential data.
4647 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004648static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004649 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004650 psa_key_slot_t *private_key,
4651 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004652 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004653{
4654 psa_status_t status;
4655 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4656 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004657 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004658
4659 /* Step 1: run the secret agreement algorithm to generate the shared
4660 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004661 status = psa_key_agreement_raw_internal( ka_alg,
4662 private_key,
4663 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004664 shared_secret,
4665 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004666 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004667 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004668 goto exit;
4669
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004670 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004671 * the shared secret. A shared secret is permitted wherever a key
4672 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004673 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004674 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004675 shared_secret,
4676 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004677exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004678 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004679 return( status );
4680}
4681
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004682psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004683 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004684 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004685 const uint8_t *peer_key,
4686 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004687{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004688 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004689 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004690 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004691
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004692 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004693 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004694 status = psa_get_and_lock_transparent_key_slot_with_policy(
4695 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004696 if( status != PSA_SUCCESS )
4697 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004698 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004699 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004700 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004701 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004702 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004703 else
4704 {
4705 /* If a private key has been added as SECRET, we allow the derived
4706 * key material to be used as a key in PSA Crypto. */
4707 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4708 operation->can_output_key = 1;
4709 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004710
Ronald Cron5c522922020-11-14 16:35:34 +01004711 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004712
Ronald Cron5c522922020-11-14 16:35:34 +01004713 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004714}
4715
Gilles Peskinebe697d82019-05-16 18:00:41 +02004716psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004717 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004718 const uint8_t *peer_key,
4719 size_t peer_key_length,
4720 uint8_t *output,
4721 size_t output_size,
4722 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004723{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004725 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004726 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004727
4728 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4729 {
4730 status = PSA_ERROR_INVALID_ARGUMENT;
4731 goto exit;
4732 }
Ronald Cron5c522922020-11-14 16:35:34 +01004733 status = psa_get_and_lock_transparent_key_slot_with_policy(
4734 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004735 if( status != PSA_SUCCESS )
4736 goto exit;
4737
4738 status = psa_key_agreement_raw_internal( alg, slot,
4739 peer_key, peer_key_length,
4740 output, output_size,
4741 output_length );
4742
4743exit:
4744 if( status != PSA_SUCCESS )
4745 {
4746 /* If an error happens and is not handled properly, the output
4747 * may be used as a key to protect sensitive data. Arrange for such
4748 * a key to be random, which is likely to result in decryption or
4749 * verification errors. This is better than filling the buffer with
4750 * some constant data such as zeros, which would result in the data
4751 * being protected with a reproducible, easily knowable key.
4752 */
4753 psa_generate_random( output, output_size );
4754 *output_length = output_size;
4755 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004756
Ronald Cron5c522922020-11-14 16:35:34 +01004757 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004758
Ronald Cron5c522922020-11-14 16:35:34 +01004759 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004760}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004761
4762
Gilles Peskine30524eb2020-11-13 17:02:26 +01004763
Gilles Peskine86a440b2018-11-12 18:39:40 +01004764/****************************************************************/
4765/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004766/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004767
Gilles Peskine30524eb2020-11-13 17:02:26 +01004768/** Initialize the PSA random generator.
4769 */
4770static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4771{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004772#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4773 memset( rng, 0, sizeof( *rng ) );
4774#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4775
Gilles Peskine30524eb2020-11-13 17:02:26 +01004776 /* Set default configuration if
4777 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4778 if( rng->entropy_init == NULL )
4779 rng->entropy_init = mbedtls_entropy_init;
4780 if( rng->entropy_free == NULL )
4781 rng->entropy_free = mbedtls_entropy_free;
4782
4783 rng->entropy_init( &rng->entropy );
4784#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4785 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4786 /* The PSA entropy injection feature depends on using NV seed as an entropy
4787 * source. Add NV seed as an entropy source for PSA entropy injection. */
4788 mbedtls_entropy_add_source( &rng->entropy,
4789 mbedtls_nv_seed_poll, NULL,
4790 MBEDTLS_ENTROPY_BLOCK_SIZE,
4791 MBEDTLS_ENTROPY_SOURCE_STRONG );
4792#endif
4793
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004794 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004795#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004796}
4797
4798/** Deinitialize the PSA random generator.
4799 */
4800static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4801{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004802#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4803 memset( rng, 0, sizeof( *rng ) );
4804#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004805 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004806 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004807#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004808}
4809
4810/** Seed the PSA random generator.
4811 */
4812static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4813{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004814#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4815 /* Do nothing: the external RNG seeds itself. */
4816 (void) rng;
4817 return( PSA_SUCCESS );
4818#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004819 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004820 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4821 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004822 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004823#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004824}
4825
Gilles Peskinee59236f2018-01-27 23:32:46 +01004826psa_status_t psa_generate_random( uint8_t *output,
4827 size_t output_size )
4828{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004829 GUARD_MODULE_INITIALIZED;
4830
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004831#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4832
4833 size_t output_length = 0;
4834 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4835 output, output_size,
4836 &output_length );
4837 if( status != PSA_SUCCESS )
4838 return( status );
4839 /* Breaking up a request into smaller chunks is currently not supported
4840 * for the extrernal RNG interface. */
4841 if( output_length != output_size )
4842 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4843 return( PSA_SUCCESS );
4844
4845#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4846
Gilles Peskine71ddab92021-01-04 21:01:07 +01004847 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004848 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004849 size_t request_size =
4850 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4851 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4852 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004853 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4854 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004855 if( ret != 0 )
4856 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004857 output_size -= request_size;
4858 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004859 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004860 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004861#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004862}
4863
Gilles Peskine8814fc42020-12-14 15:33:44 +01004864/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004865 *
4866 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4867 * `psa_generate_random(...)`. The state parameter is ignored since the
4868 * PSA API doesn't support passing an explicit state.
4869 *
4870 * In the non-external case, psa_generate_random() calls an
4871 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4872 * and semantics as mbedtls_psa_get_random(). As an optimization,
4873 * instead of doing this back-and-forth between the PSA API and the
4874 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4875 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004876 */
4877#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4878int mbedtls_psa_get_random( void *p_rng,
4879 unsigned char *output,
4880 size_t output_size )
4881{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004882 /* This function takes a pointer to the RNG state because that's what
4883 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4884 * its own state internally and doesn't let the caller access that state.
4885 * So we just ignore the state parameter, and in practice we'll pass
4886 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004887 (void) p_rng;
4888 psa_status_t status = psa_generate_random( output, output_size );
4889 if( status == PSA_SUCCESS )
4890 return( 0 );
4891 else
4892 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4893}
4894#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4895
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004896#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
4897#include "mbedtls/entropy_poll.h"
4898
Gilles Peskine7228da22019-07-15 11:06:15 +02004899psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004900 size_t seed_size )
4901{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004902 if( global_data.initialized )
4903 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004904
4905 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4906 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4907 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4908 return( PSA_ERROR_INVALID_ARGUMENT );
4909
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004910 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004911}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004912#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004913
Ronald Cron3772afe2021-02-08 16:10:05 +01004914/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004915 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004916 * \param type The key type
4917 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004918 *
4919 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004920 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004921 * \retval #PSA_ERROR_INVALID_ARGUMENT
4922 * The size in bits of the key is not valid.
4923 * \retval #PSA_ERROR_NOT_SUPPORTED
4924 * The type and/or the size in bits of the key or the combination of
4925 * the two is not supported.
4926 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004927static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4928 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004929{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004930 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004931
Gilles Peskinee59236f2018-01-27 23:32:46 +01004932 if( key_type_is_raw_bytes( type ) )
4933 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004934 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004935 if( status != PSA_SUCCESS )
4936 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004937 }
4938 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004939#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004940 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4941 {
4942 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4943 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004944
Ronald Cron01b2aba2020-10-05 09:42:02 +02004945 /* Accept only byte-aligned keys, for the same reasons as
4946 * in psa_import_rsa_key(). */
4947 if( bits % 8 != 0 )
4948 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004949 }
4950 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004951#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004952
Ronald Cron5c4d3862020-12-07 11:07:24 +01004953#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004954 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4955 {
Ronald Crond81ab562021-02-16 09:01:16 +01004956 /* To avoid empty block, return successfully here. */
4957 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004958 }
4959 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004960#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004961 {
4962 return( PSA_ERROR_NOT_SUPPORTED );
4963 }
4964
4965 return( PSA_SUCCESS );
4966}
4967
Ronald Cron55ed0592020-10-05 10:30:40 +02004968psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004969 const psa_key_attributes_t *attributes,
4970 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004971{
4972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004973 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004974
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004975 if( ( attributes->domain_parameters == NULL ) &&
4976 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004977 return( PSA_ERROR_INVALID_ARGUMENT );
4978
Ronald Cron01b2aba2020-10-05 09:42:02 +02004979 if( key_type_is_raw_bytes( type ) )
4980 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004981 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004982 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004983 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004984
David Brown12ca5032021-02-11 11:02:00 -07004985#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004986 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004987 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004988#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004989 }
4990 else
4991
John Durkop07cc04a2020-11-16 22:08:34 -08004992#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004993 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004994 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004995 return( mbedtls_psa_rsa_generate_key( attributes,
4996 key_buffer,
4997 key_buffer_size,
4998 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004999 }
5000 else
John Durkop07cc04a2020-11-16 22:08:34 -08005001#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005002
John Durkop9814fa22020-11-04 12:28:15 -08005003#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005004 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005005 {
Ronald Cron7023db52020-11-20 18:17:42 +01005006 return( mbedtls_psa_ecp_generate_key( attributes,
5007 key_buffer,
5008 key_buffer_size,
5009 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005010 }
5011 else
John Durkop9814fa22020-11-04 12:28:15 -08005012#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005013 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005014 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005015 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005016 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005017
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005018 return( PSA_SUCCESS );
5019}
Darryl Green0c6575a2018-11-07 16:05:30 +00005020
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005021psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005022 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005023{
5024 psa_status_t status;
5025 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005026 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005027 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005028
Ronald Cron81709fc2020-11-14 12:10:32 +01005029 *key = MBEDTLS_SVC_KEY_ID_INIT;
5030
Gilles Peskine0f84d622019-09-12 19:03:13 +02005031 /* Reject any attempt to create a zero-length key so that we don't
5032 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5033 if( psa_get_key_bits( attributes ) == 0 )
5034 return( PSA_ERROR_INVALID_ARGUMENT );
5035
Ronald Cron81709fc2020-11-14 12:10:32 +01005036 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5037 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005038 if( status != PSA_SUCCESS )
5039 goto exit;
5040
Ronald Cron977c2472020-10-13 08:32:21 +02005041 /* In the case of a transparent key or an opaque key stored in local
5042 * storage (thus not in the case of generating a key in a secure element
5043 * or cryptoprocessor with storage), we have to allocate a buffer to
5044 * hold the generated key material. */
5045 if( slot->key.data == NULL )
5046 {
5047 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5048 PSA_KEY_LOCATION_LOCAL_STORAGE )
5049 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005050 status = psa_validate_key_type_and_size_for_key_generation(
5051 attributes->core.type, attributes->core.bits );
5052 if( status != PSA_SUCCESS )
5053 goto exit;
5054
5055 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5056 attributes->core.type,
5057 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005058 }
5059 else
5060 {
5061 status = psa_driver_wrapper_get_key_buffer_size(
5062 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005063 if( status != PSA_SUCCESS )
5064 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005065 }
Ronald Cron977c2472020-10-13 08:32:21 +02005066
5067 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5068 if( status != PSA_SUCCESS )
5069 goto exit;
5070 }
5071
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005072 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005073 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005074
Ronald Cron2b56bc82020-10-05 10:02:26 +02005075 if( status != PSA_SUCCESS )
5076 psa_remove_key_data_from_memory( slot );
5077
Gilles Peskine11792082019-08-06 18:36:36 +02005078exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005079 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005080 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005081 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005082 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005083
Darryl Green0c6575a2018-11-07 16:05:30 +00005084 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005085}
5086
Gilles Peskinee59236f2018-01-27 23:32:46 +01005087/****************************************************************/
5088/* Module setup */
5089/****************************************************************/
5090
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005091#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005092psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5093 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5094 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5095{
5096 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5097 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005098 global_data.rng.entropy_init = entropy_init;
5099 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005100 return( PSA_SUCCESS );
5101}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005102#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005103
Gilles Peskinee59236f2018-01-27 23:32:46 +01005104void mbedtls_psa_crypto_free( void )
5105{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005106 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005107 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5108 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005109 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005110 }
5111 /* Wipe all remaining data, including configuration.
5112 * In particular, this sets all state indicator to the value
5113 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005114 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005115#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005116 /* Unregister all secure element drivers, so that we restart from
5117 * a pristine state. */
5118 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005119#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005120}
5121
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005122#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5123/** Recover a transaction that was interrupted by a power failure.
5124 *
5125 * This function is called during initialization, before psa_crypto_init()
5126 * returns. If this function returns a failure status, the initialization
5127 * fails.
5128 */
5129static psa_status_t psa_crypto_recover_transaction(
5130 const psa_crypto_transaction_t *transaction )
5131{
5132 switch( transaction->unknown.type )
5133 {
5134 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5135 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005136 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005137 * is implemented.
5138 * https://github.com/ARMmbed/mbed-crypto/issues/218
5139 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005140 default:
5141 /* We found an unsupported transaction in the storage.
5142 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005143 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005144 }
5145}
5146#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5147
Gilles Peskinee59236f2018-01-27 23:32:46 +01005148psa_status_t psa_crypto_init( void )
5149{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005150 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005151
Gilles Peskinec6b69072018-11-20 21:42:52 +01005152 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005153 if( global_data.initialized != 0 )
5154 return( PSA_SUCCESS );
5155
Gilles Peskine30524eb2020-11-13 17:02:26 +01005156 /* Initialize and seed the random generator. */
5157 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005158 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005159 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005160 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005161 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005162 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005163
Gilles Peskine66fb1262018-12-10 16:29:04 +01005164 status = psa_initialize_key_slots( );
5165 if( status != PSA_SUCCESS )
5166 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005167
Gilles Peskined9348f22019-10-01 15:22:29 +02005168#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5169 status = psa_init_all_se_drivers( );
5170 if( status != PSA_SUCCESS )
5171 goto exit;
5172#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5173
Gilles Peskine4b734222019-07-24 15:56:31 +02005174#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005175 status = psa_crypto_load_transaction( );
5176 if( status == PSA_SUCCESS )
5177 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005178 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5179 if( status != PSA_SUCCESS )
5180 goto exit;
5181 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005182 }
5183 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5184 {
5185 /* There's no transaction to complete. It's all good. */
5186 status = PSA_SUCCESS;
5187 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005188#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005189
Gilles Peskinec6b69072018-11-20 21:42:52 +01005190 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005191 global_data.initialized = 1;
5192
5193exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005194 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005195 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005196 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005197}
5198
5199#endif /* MBEDTLS_PSA_CRYPTO_C */