blob: 4824b45a3fe60451ce4e273d2ee95baa6197fe44 [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
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
36#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010037#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020038#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020039#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010041#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010042/* Include internal declarations that are useful for implementing persistently
43 * stored keys. */
44#include "psa_crypto_storage.h"
45
Gilles Peskineb2b64d32020-12-14 16:43:58 +010046#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010047
Gilles Peskineb46bef22019-07-30 21:32:04 +020048#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010049#include <stdlib.h>
50#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020052#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#define mbedtls_calloc calloc
54#define mbedtls_free free
55#endif
56
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010057#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010058#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020059#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000060#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020061#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010062#include "mbedtls/blowfish.h"
63#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
75#include "mbedtls/md2.h"
76#include "mbedtls/md4.h"
77#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010078#include "mbedtls/md.h"
79#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010080#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010081#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010082#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000083#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010085#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010086#include "mbedtls/sha1.h"
87#include "mbedtls/sha256.h"
88#include "mbedtls/sha512.h"
89#include "mbedtls/xtea.h"
90
Gilles Peskine996deb12018-08-01 15:45:45 +020091#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
92
Gilles Peskine9ef733f2018-02-07 21:05:37 +010093/* constant-time buffer comparison */
94static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
95{
96 size_t i;
97 unsigned char diff = 0;
98
99 for( i = 0; i < n; i++ )
100 diff |= a[i] ^ b[i];
101
102 return( diff );
103}
104
105
106
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100107/****************************************************************/
108/* Global data, support functions and library management */
109/****************************************************************/
110
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200111static int key_type_is_raw_bytes( psa_key_type_t type )
112{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200113 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200114}
115
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100116/* Values for psa_global_data_t::rng_state */
117#define RNG_NOT_INITIALIZED 0
118#define RNG_INITIALIZED 1
119#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100120
Gilles Peskine2d277862018-06-18 15:41:12 +0200121typedef struct
122{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100123 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100124 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100125 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100126} psa_global_data_t;
127
128static psa_global_data_t global_data;
129
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100130#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
131mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
132 &global_data.rng.drbg;
133#endif
134
itayzafrir0adf0fc2018-09-06 16:24:41 +0300135#define GUARD_MODULE_INITIALIZED \
136 if( global_data.initialized == 0 ) \
137 return( PSA_ERROR_BAD_STATE );
138
Steven Cooreman01164162020-07-20 15:31:37 +0200139psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100140{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100141 /* Mbed TLS error codes can combine a high-level error code and a
142 * low-level error code. The low-level error usually reflects the
143 * root cause better, so dispatch on that preferably. */
144 int low_level_ret = - ( -ret & 0x007f );
145 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100146 {
147 case 0:
148 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100149
150 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
151 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
152 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
153 return( PSA_ERROR_NOT_SUPPORTED );
154 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
155 return( PSA_ERROR_HARDWARE_FAILURE );
156
157 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
158 return( PSA_ERROR_HARDWARE_FAILURE );
159
Gilles Peskine9a944802018-06-21 09:35:35 +0200160 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
161 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
162 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
163 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
164 case MBEDTLS_ERR_ASN1_INVALID_DATA:
165 return( PSA_ERROR_INVALID_ARGUMENT );
166 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
167 return( PSA_ERROR_INSUFFICIENT_MEMORY );
168 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
169 return( PSA_ERROR_BUFFER_TOO_SMALL );
170
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000172 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
174 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
175#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
178 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
179 return( PSA_ERROR_HARDWARE_FAILURE );
180
Jaeden Amero93e21112019-02-20 13:57:28 +0000181#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000182 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000183#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
184 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
185#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100186 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
187 return( PSA_ERROR_NOT_SUPPORTED );
188 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
189 return( PSA_ERROR_HARDWARE_FAILURE );
190
191 case MBEDTLS_ERR_CCM_BAD_INPUT:
192 return( PSA_ERROR_INVALID_ARGUMENT );
193 case MBEDTLS_ERR_CCM_AUTH_FAILED:
194 return( PSA_ERROR_INVALID_SIGNATURE );
195 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
196 return( PSA_ERROR_HARDWARE_FAILURE );
197
Gilles Peskine26869f22019-05-06 15:25:00 +0200198 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
199 return( PSA_ERROR_INVALID_ARGUMENT );
200
201 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
202 return( PSA_ERROR_BAD_STATE );
203 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205
Gilles Peskinea5905292018-02-07 20:59:33 +0100206 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
207 return( PSA_ERROR_NOT_SUPPORTED );
208 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
209 return( PSA_ERROR_INVALID_ARGUMENT );
210 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
211 return( PSA_ERROR_INSUFFICIENT_MEMORY );
212 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
213 return( PSA_ERROR_INVALID_PADDING );
214 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200215 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100216 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
217 return( PSA_ERROR_INVALID_SIGNATURE );
218 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200219 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
221 return( PSA_ERROR_HARDWARE_FAILURE );
222
223 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskine82e57d12020-11-13 21:31:17 +0100226#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
227 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100228 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
229 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100230 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
231 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
232 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
233 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
234 return( PSA_ERROR_NOT_SUPPORTED );
235 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
236 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100237#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100238
239 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
240 return( PSA_ERROR_NOT_SUPPORTED );
241 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
242 return( PSA_ERROR_HARDWARE_FAILURE );
243
Gilles Peskinee59236f2018-01-27 23:32:46 +0100244 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
245 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
246 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100248
249 case MBEDTLS_ERR_GCM_AUTH_FAILED:
250 return( PSA_ERROR_INVALID_SIGNATURE );
251 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200252 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100253 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
254 return( PSA_ERROR_HARDWARE_FAILURE );
255
Gilles Peskine82e57d12020-11-13 21:31:17 +0100256#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
257 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100258 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
259 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100260 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
261 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
262 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
263 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
264 return( PSA_ERROR_NOT_SUPPORTED );
265 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
266 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
267#endif
268
Gilles Peskinea5905292018-02-07 20:59:33 +0100269 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
270 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
271 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
272 return( PSA_ERROR_HARDWARE_FAILURE );
273
274 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
275 return( PSA_ERROR_NOT_SUPPORTED );
276 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
277 return( PSA_ERROR_INVALID_ARGUMENT );
278 case MBEDTLS_ERR_MD_ALLOC_FAILED:
279 return( PSA_ERROR_INSUFFICIENT_MEMORY );
280 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
281 return( PSA_ERROR_STORAGE_FAILURE );
282 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
283 return( PSA_ERROR_HARDWARE_FAILURE );
284
Gilles Peskinef76aa772018-10-29 19:24:33 +0100285 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
286 return( PSA_ERROR_STORAGE_FAILURE );
287 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
290 return( PSA_ERROR_INVALID_ARGUMENT );
291 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
292 return( PSA_ERROR_BUFFER_TOO_SMALL );
293 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
294 return( PSA_ERROR_INVALID_ARGUMENT );
295 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
296 return( PSA_ERROR_INVALID_ARGUMENT );
297 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
298 return( PSA_ERROR_INVALID_ARGUMENT );
299 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
300 return( PSA_ERROR_INSUFFICIENT_MEMORY );
301
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100302 case MBEDTLS_ERR_PK_ALLOC_FAILED:
303 return( PSA_ERROR_INSUFFICIENT_MEMORY );
304 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
305 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100308 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100309 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
310 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
311 return( PSA_ERROR_INVALID_ARGUMENT );
312 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
313 return( PSA_ERROR_NOT_SUPPORTED );
314 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
315 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
316 return( PSA_ERROR_NOT_PERMITTED );
317 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
318 return( PSA_ERROR_INVALID_ARGUMENT );
319 case MBEDTLS_ERR_PK_INVALID_ALG:
320 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
321 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
322 return( PSA_ERROR_NOT_SUPPORTED );
323 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
324 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100325 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
326 return( PSA_ERROR_HARDWARE_FAILURE );
327
Gilles Peskineff2d2002019-05-06 15:26:23 +0200328 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
331 return( PSA_ERROR_NOT_SUPPORTED );
332
Gilles Peskinea5905292018-02-07 20:59:33 +0100333 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
334 return( PSA_ERROR_HARDWARE_FAILURE );
335
336 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
337 return( PSA_ERROR_INVALID_ARGUMENT );
338 case MBEDTLS_ERR_RSA_INVALID_PADDING:
339 return( PSA_ERROR_INVALID_PADDING );
340 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
341 return( PSA_ERROR_HARDWARE_FAILURE );
342 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
343 return( PSA_ERROR_INVALID_ARGUMENT );
344 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
345 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200346 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100347 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
348 return( PSA_ERROR_INVALID_SIGNATURE );
349 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
350 return( PSA_ERROR_BUFFER_TOO_SMALL );
351 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100352 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100353 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
354 return( PSA_ERROR_NOT_SUPPORTED );
355 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
356 return( PSA_ERROR_HARDWARE_FAILURE );
357
358 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
359 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
360 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
361 return( PSA_ERROR_HARDWARE_FAILURE );
362
363 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
364 return( PSA_ERROR_INVALID_ARGUMENT );
365 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
366 return( PSA_ERROR_HARDWARE_FAILURE );
367
itayzafrir5c753392018-05-08 11:18:38 +0300368 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300369 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300370 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
372 return( PSA_ERROR_BUFFER_TOO_SMALL );
373 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
374 return( PSA_ERROR_NOT_SUPPORTED );
375 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
376 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
377 return( PSA_ERROR_INVALID_SIGNATURE );
378 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
379 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100380 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
381 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300382 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
383 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100384
Janos Follatha13b9052019-11-22 12:48:59 +0000385 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
386 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300387
Gilles Peskinee59236f2018-01-27 23:32:46 +0100388 default:
David Saadab4ecc272019-02-14 13:48:10 +0200389 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100390 }
391}
392
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200393
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200394
395
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100396/****************************************************************/
397/* Key management */
398/****************************************************************/
399
Gilles Peskine73167e12019-07-12 23:44:37 +0200400#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
401static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
402{
Gilles Peskine8e338702019-07-30 20:06:31 +0200403 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200404}
405#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
406
John Durkop07cc04a2020-11-16 22:08:34 -0800407/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
408 * current test driver in key_management.c is using this function
409 * when accelerators are used for ECC key pair and public key.
410 * Once that dependency is resolved these guards can be removed.
411 */
John Durkop9814fa22020-11-04 12:28:15 -0800412#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800413 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
414 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
415 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100416mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100417 size_t bits,
418 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200419{
420 switch( curve )
421 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100422 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100429 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100430 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100432 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100433 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100434 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100435 case 528:
436 if( bits_is_sloppy )
437 return( MBEDTLS_ECP_DP_SECP521R1 );
438 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 }
440 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100441
Paul Elliott8ff510a2020-06-02 17:19:28 +0100442 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100443 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100444 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100445 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100446 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100447 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100448 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100449 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100450 return( MBEDTLS_ECP_DP_BP512R1 );
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_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100455 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100456 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100457 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100458 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100459 case 256:
460 if( bits_is_sloppy )
461 return( MBEDTLS_ECP_DP_CURVE25519 );
462 break;
463 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100464 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100465 }
466 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100467
Paul Elliott8ff510a2020-06-02 17:19:28 +0100468 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100469 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100470 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100471 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100472 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100473 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100474 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100475 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100476 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100477 }
478 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200479 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100480
481 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200482}
John Durkop9814fa22020-11-04 12:28:15 -0800483#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800484 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
485 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
486 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200487
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200488static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
489 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490{
491 /* Check that the bit size is acceptable for the key type */
492 switch( type )
493 {
494 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200495 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200496 case PSA_KEY_TYPE_DERIVE:
497 break;
David Browne04acc22021-01-26 11:39:16 -0700498#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200499 case PSA_KEY_TYPE_AES:
500 if( bits != 128 && bits != 192 && bits != 256 )
501 return( PSA_ERROR_INVALID_ARGUMENT );
502 break;
503#endif
David Browne04acc22021-01-26 11:39:16 -0700504#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200505 case PSA_KEY_TYPE_CAMELLIA:
506 if( bits != 128 && bits != 192 && bits != 256 )
507 return( PSA_ERROR_INVALID_ARGUMENT );
508 break;
509#endif
David Browne04acc22021-01-26 11:39:16 -0700510#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200511 case PSA_KEY_TYPE_DES:
512 if( bits != 64 && bits != 128 && bits != 192 )
513 return( PSA_ERROR_INVALID_ARGUMENT );
514 break;
515#endif
David Browne04acc22021-01-26 11:39:16 -0700516#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200517 case PSA_KEY_TYPE_ARC4:
518 if( bits < 8 || bits > 2048 )
519 return( PSA_ERROR_INVALID_ARGUMENT );
520 break;
521#endif
David Brown1bfe4d72021-02-16 12:54:35 -0700522#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200523 case PSA_KEY_TYPE_CHACHA20:
524 if( bits != 256 )
525 return( PSA_ERROR_INVALID_ARGUMENT );
526 break;
527#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200528 default:
529 return( PSA_ERROR_NOT_SUPPORTED );
530 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200531 if( bits % 8 != 0 )
532 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200533
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200534 return( PSA_SUCCESS );
535}
536
Gilles Peskineb46bef22019-07-30 21:32:04 +0200537/** Return the size of the key in the given slot, in bits.
538 *
539 * \param[in] slot A key slot.
540 *
541 * \return The key size in bits, read from the metadata in the slot.
542 */
543static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
544{
545 return( slot->attr.bits );
546}
547
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100548/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100549 *
Steven Cooremancd640932021-03-08 12:00:27 +0100550 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
551 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100552 *
553 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100554 * \param[in] key_type The key type of the key to be used with the
555 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100556 *
557 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100558 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100559 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100560 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100561 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100562MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100563 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100564 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100565{
Steven Cooremancd640932021-03-08 12:00:27 +0100566 if( PSA_ALG_IS_HMAC( algorithm ) )
567 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100568 if( key_type == PSA_KEY_TYPE_HMAC )
569 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100570 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100571
572 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100573 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100574 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
575 * key. */
576 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
577 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
578 {
579 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
580 * the block length (larger than 1) for block ciphers. */
581 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
582 return( PSA_SUCCESS );
583 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100584 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100585
586 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100587}
588
Steven Cooreman75b74362020-07-28 14:30:13 +0200589/** Try to allocate a buffer to an empty key slot.
590 *
591 * \param[in,out] slot Key slot to attach buffer to.
592 * \param[in] buffer_length Requested size of the buffer.
593 *
594 * \retval #PSA_SUCCESS
595 * The buffer has been successfully allocated.
596 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
597 * Not enough memory was available for allocation.
598 * \retval #PSA_ERROR_ALREADY_EXISTS
599 * Trying to allocate a buffer to a non-empty key slot.
600 */
601static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
602 size_t buffer_length )
603{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100604 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200605 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200606
Ronald Cronea0f8a62020-11-25 17:52:23 +0100607 slot->key.data = mbedtls_calloc( 1, buffer_length );
608 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200609 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200610
Ronald Cronea0f8a62020-11-25 17:52:23 +0100611 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200612 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200613}
614
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200615psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
616 const uint8_t* data,
617 size_t data_length )
618{
619 psa_status_t status = psa_allocate_buffer_to_slot( slot,
620 data_length );
621 if( status != PSA_SUCCESS )
622 return( status );
623
Ronald Cronea0f8a62020-11-25 17:52:23 +0100624 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200625 return( PSA_SUCCESS );
626}
627
Ronald Crona0fe59f2020-11-29 11:14:53 +0100628psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100629 const psa_key_attributes_t *attributes,
630 const uint8_t *data, size_t data_length,
631 uint8_t *key_buffer, size_t key_buffer_size,
632 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100633{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100634 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
635 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100636
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200637 /* zero-length keys are never supported. */
638 if( data_length == 0 )
639 return( PSA_ERROR_NOT_SUPPORTED );
640
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100641 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100642 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100643 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200644
Steven Cooreman75b74362020-07-28 14:30:13 +0200645 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
646 if( data_length > SIZE_MAX / 8 )
647 return( PSA_ERROR_NOT_SUPPORTED );
648
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200649 /* Enforce a size limit, and in particular ensure that the bit
650 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100651 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200652 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200653
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100654 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200655 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200656 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200657
Ronald Crondd04d422020-11-28 15:14:42 +0100658 /* Copy the key material. */
659 memcpy( key_buffer, data, data_length );
660 *key_buffer_length = data_length;
661 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200662
Steven Cooreman40120f62020-10-29 11:42:22 +0100663 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100664 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100665 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200666 {
John Durkop9814fa22020-11-04 12:28:15 -0800667#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
668 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100669 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200670 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100671 return( mbedtls_psa_ecp_import_key( attributes,
672 data, data_length,
673 key_buffer, key_buffer_size,
674 key_buffer_length,
675 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100676 }
John Durkop9814fa22020-11-04 12:28:15 -0800677#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
678 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700679#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
680 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100681 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200682 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 return( mbedtls_psa_rsa_import_key( attributes,
684 data, data_length,
685 key_buffer, key_buffer_size,
686 key_buffer_length,
687 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200688 }
John Durkop9814fa22020-11-04 12:28:15 -0800689#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
690 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100691 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100692
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100693 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100694}
695
Gilles Peskinef603c712019-01-19 13:40:11 +0100696/** Calculate the intersection of two algorithm usage policies.
697 *
698 * Return 0 (which allows no operation) on incompatibility.
699 */
700static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100702 psa_algorithm_t alg1,
703 psa_algorithm_t alg2 )
704{
Gilles Peskine549ea862019-05-22 11:45:59 +0200705 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100706 if( alg1 == alg2 )
707 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100708 /* If the policies are from the same hash-and-sign family, check
709 * if one is a wildcard. If so the other has the specific algorithm. */
710 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
711 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
712 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100713 {
Steven Cooreman03488022021-02-18 12:07:20 +0100714 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
715 return( alg2 );
716 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
717 return( alg1 );
718 }
719 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100720 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100721 * restrictive tag length. */
722 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
723 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
724 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
725 {
726 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
727 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100728 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100729
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100730 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100731 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
732 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100733 {
Steven Cooremancd640932021-03-08 12:00:27 +0100734 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
735 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100736 }
737 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100738 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100739 ( alg1_len <= alg2_len ) )
740 {
741 return( alg2 );
742 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100743 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100744 ( alg2_len <= alg1_len ) )
745 {
746 return( alg1 );
747 }
748 }
749 /* If the policies are from the same MAC family, check whether one
750 * of them is a minimum-MAC-length policy. Calculate the most
751 * restrictive tag length. */
752 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
753 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
754 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
755 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100756 /* Validate the combination of key type and algorithm. Since the base
757 * algorithm of alg1 and alg2 are the same, we only need this once. */
758 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100759 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100760
Steven Cooreman31a876d2021-03-03 20:47:40 +0100761 /* Get the (exact or at-least) output lengths for both sides of the
762 * requested intersection. None of the currently supported algorithms
763 * have an output length dependent on the actual key size, so setting it
764 * to a bogus value of 0 is currently OK.
765 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100766 * Note that for at-least-this-length wildcard algorithms, the output
767 * length is set to the shortest allowed length, which allows us to
768 * calculate the most restrictive tag length for the intersection. */
769 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
770 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100771 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100772
Steven Cooremana1d83222021-02-25 10:20:29 +0100773 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100774 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
775 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100776 {
Steven Cooremancd640932021-03-08 12:00:27 +0100777 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100778 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779
780 /* If only one is an at-least-this-length policy, the intersection would
781 * be the other (fixed-length) policy as long as said fixed length is
782 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100783 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100784 {
Steven Cooremancd640932021-03-08 12:00:27 +0100785 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100786 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100787 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100788 {
Steven Cooremancd640932021-03-08 12:00:27 +0100789 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100790 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100791
Steven Cooremancd640932021-03-08 12:00:27 +0100792 /* If none of them are wildcards, check whether they define the same tag
793 * length. This is still possible here when one is default-length and
794 * the other specific-length. Ensure to always return the
795 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100796 if( alg1_len == alg2_len )
797 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100798 }
799 /* If the policies are incompatible, allow nothing. */
800 return( 0 );
801}
802
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100803static int psa_key_algorithm_permits( psa_key_type_t key_type,
804 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200805 psa_algorithm_t requested_alg )
806{
Gilles Peskine549ea862019-05-22 11:45:59 +0200807 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200808 if( requested_alg == policy_alg )
809 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100810 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
811 * and requested_alg is the same hash-and-sign family with any hash,
812 * then requested_alg is compliant with policy_alg. */
813 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
814 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200815 {
Steven Cooreman03488022021-02-18 12:07:20 +0100816 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
817 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
818 }
819 /* If policy_alg is a wildcard AEAD algorithm of the same base as
820 * the requested algorithm, check the requested tag length to be
821 * equal-length or longer than the wildcard-specified length. */
822 if( PSA_ALG_IS_AEAD( policy_alg ) &&
823 PSA_ALG_IS_AEAD( requested_alg ) &&
824 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
825 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100826 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100827 {
828 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
829 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
830 }
Steven Cooremancd640932021-03-08 12:00:27 +0100831 /* If policy_alg is a MAC algorithm of the same base as the requested
832 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100833 if( PSA_ALG_IS_MAC( policy_alg ) &&
834 PSA_ALG_IS_MAC( requested_alg ) &&
835 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100836 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100837 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100838 /* Validate the combination of key type and algorithm. Since the policy
839 * and requested algorithms are the same, we only need this once. */
840 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100841 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100842
Steven Cooreman31a876d2021-03-03 20:47:40 +0100843 /* Get both the requested output length for the algorithm which is to be
844 * verified, and the default output length for the base algorithm.
845 * Note that none of the currently supported algorithms have an output
846 * length dependent on actual key size, so setting it to a bogus value
847 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100848 size_t requested_output_length = PSA_MAC_LENGTH(
849 key_type, 0, requested_alg );
850 size_t default_output_length = PSA_MAC_LENGTH(
851 key_type, 0,
852 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100853
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100854 /* If the policy is default-length, only allow an algorithm with
855 * a declared exact-length matching the default. */
856 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100857 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100858
859 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100860 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100861 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
862 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
863 {
864 return( 1 );
865 }
866
Steven Cooremancd640932021-03-08 12:00:27 +0100867 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
868 * check for the requested MAC length to be equal to or longer than the
869 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100870 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
871 {
872 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100873 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100874 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200875 }
Steven Cooremance48e852020-10-05 16:02:45 +0200876 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200877 * a key derivation with that key agreement should also be allowed. This
878 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200879 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
880 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
881 {
882 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
883 policy_alg );
884 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100885 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200886 return( 0 );
887}
888
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100889/** Test whether a policy permits an algorithm.
890 *
891 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100892 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100893 * \note This function requires providing the key type for which the policy is
894 * being validated, since some algorithm policy definitions (e.g. MAC)
895 * have different properties depending on what kind of cipher it is
896 * combined with.
897 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100898 * \retval PSA_SUCCESS When \p alg is a specific algorithm
899 * allowed by the \p policy.
900 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
901 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
902 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100903 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100904static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100905 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100906 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100907{
Steven Cooremand788fab2021-02-25 11:29:17 +0100908 /* '0' is not a valid algorithm */
909 if( alg == 0 )
910 return( PSA_ERROR_INVALID_ARGUMENT );
911
Steven Cooreman7e39f052021-02-23 14:18:32 +0100912 /* A requested algorithm cannot be a wildcard. */
913 if( PSA_ALG_IS_WILDCARD( alg ) )
914 return( PSA_ERROR_INVALID_ARGUMENT );
915
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100916 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
917 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100918 return( PSA_SUCCESS );
919 else
920 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100921}
922
Gilles Peskinef603c712019-01-19 13:40:11 +0100923/** Restrict a key policy based on a constraint.
924 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100925 * \note This function requires providing the key type for which the policy is
926 * being restricted, since some algorithm policy definitions (e.g. MAC)
927 * have different properties depending on what kind of cipher it is
928 * combined with.
929 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100930 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100931 * \param[in,out] policy The policy to restrict.
932 * \param[in] constraint The policy constraint to apply.
933 *
934 * \retval #PSA_SUCCESS
935 * \c *policy contains the intersection of the original value of
936 * \c *policy and \c *constraint.
937 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100938 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100939 * \c *policy is unchanged.
940 */
941static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100942 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100943 psa_key_policy_t *policy,
944 const psa_key_policy_t *constraint )
945{
946 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100947 psa_key_policy_algorithm_intersection( key_type, policy->alg,
948 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200949 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100950 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
951 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100952 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
953 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200954 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
955 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100956 policy->usage &= constraint->usage;
957 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200958 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100959 return( PSA_SUCCESS );
960}
961
Ronald Cron5c522922020-11-14 16:35:34 +0100962/** Get the description of a key given its identifier and policy constraints
963 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200964 *
Ronald Cron5c522922020-11-14 16:35:34 +0100965 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100966 * nonzero, the key must allow operations with this algorithm. If \p alg is
967 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100968 *
Ronald Cron5c522922020-11-14 16:35:34 +0100969 * In case of a persistent key, the function loads the description of the key
970 * into a key slot if not already done.
971 *
972 * On success, the returned key slot is locked. It is the responsibility of
973 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200974 */
Ronald Cron5c522922020-11-14 16:35:34 +0100975static psa_status_t psa_get_and_lock_key_slot_with_policy(
976 mbedtls_svc_key_id_t key,
977 psa_key_slot_t **p_slot,
978 psa_key_usage_t usage,
979 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100980{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200981 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
982 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100983
Ronald Cron5c522922020-11-14 16:35:34 +0100984 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100985 if( status != PSA_SUCCESS )
986 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100988
989 /* Enforce that usage policy for the key slot contains all the flags
990 * required by the usage parameter. There is one exception: public
991 * keys can always be exported, so we treat public key objects as
992 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200993 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100994 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200995
Gilles Peskine8e338702019-07-30 20:06:31 +0200996 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100997 {
998 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200999 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001000 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001001
1002 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001003 if( alg != 0 )
1004 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001005 status = psa_key_policy_permits( &slot->attr.policy,
1006 slot->attr.type,
1007 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001008 if( status != PSA_SUCCESS )
1009 goto error;
1010 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001011
Darryl Green06fd18d2018-07-16 11:21:11 +01001012 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001013
1014error:
1015 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001016 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001017
1018 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001019}
Darryl Green940d72c2018-07-13 13:18:51 +01001020
Ronald Cron5c522922020-11-14 16:35:34 +01001021/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001022 *
1023 * A transparent key is a key for which the key material is directly
1024 * available, as opposed to a key in a secure element.
1025 *
Ronald Cron5c522922020-11-14 16:35:34 +01001026 * This is a temporary function to use instead of
1027 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1028 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001029 *
Ronald Cron5c522922020-11-14 16:35:34 +01001030 * On success, the returned key slot is locked. It is the responsibility of the
1031 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001032 */
1033#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001034static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1035 mbedtls_svc_key_id_t key,
1036 psa_key_slot_t **p_slot,
1037 psa_key_usage_t usage,
1038 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001039{
Ronald Cron5c522922020-11-14 16:35:34 +01001040 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1041 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001042 if( status != PSA_SUCCESS )
1043 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001044
Gilles Peskineadad8132019-07-25 11:31:23 +02001045 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001046 {
Ronald Cron5c522922020-11-14 16:35:34 +01001047 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001048 *p_slot = NULL;
1049 return( PSA_ERROR_NOT_SUPPORTED );
1050 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001051
Gilles Peskine28f8f302019-07-24 13:30:31 +02001052 return( PSA_SUCCESS );
1053}
1054#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1055/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001056#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1057 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001058#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1059
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001060/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001061static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001062{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001063 /* Data pointer will always be either a valid pointer or NULL in an
1064 * initialized slot, so we can just free it. */
1065 if( slot->key.data != NULL )
1066 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1067
1068 mbedtls_free( slot->key.data );
1069 slot->key.data = NULL;
1070 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001071
1072 return( PSA_SUCCESS );
1073}
1074
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001075/** Completely wipe a slot in memory, including its policy.
1076 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001077psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001078{
1079 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001080
1081 /*
1082 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001083 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001084 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1085 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001086 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001087 */
Ronald Cron5c522922020-11-14 16:35:34 +01001088 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001089 {
1090#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001091 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001092#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001093 status = PSA_ERROR_CORRUPTION_DETECTED;
1094 }
1095
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001096 /* Multipart operations may still be using the key. This is safe
1097 * because all multipart operation objects are independent from
1098 * the key slot: if they need to access the key after the setup
1099 * phase, they have a copy of the key. Note that this means that
1100 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001101 /* At this point, key material and other type-specific content has
1102 * been wiped. Clear remaining metadata. We can call memset and not
1103 * zeroize because the metadata is not particularly sensitive. */
1104 memset( slot, 0, sizeof( *slot ) );
1105 return( status );
1106}
1107
Ronald Croncf56a0a2020-08-04 09:51:30 +02001108psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001109{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001110 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001111 psa_status_t status; /* status of the last operation */
1112 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001113#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1114 psa_se_drv_table_entry_t *driver;
1115#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001116
Ronald Croncf56a0a2020-08-04 09:51:30 +02001117 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001118 return( PSA_SUCCESS );
1119
Ronald Cronf2911112020-10-29 17:51:10 +01001120 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001121 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001122 * key, this will load the key description from persistent memory if not
1123 * done yet. We cannot avoid this loading as without it we don't know if
1124 * the key is operated by an SE or not and this information is needed by
1125 * the current implementation.
1126 */
Ronald Cron5c522922020-11-14 16:35:34 +01001127 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001128 if( status != PSA_SUCCESS )
1129 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001130
Ronald Cronf2911112020-10-29 17:51:10 +01001131 /*
1132 * If the key slot containing the key description is under access by the
1133 * library (apart from the present access), the key cannot be destroyed
1134 * yet. For the time being, just return in error. Eventually (to be
1135 * implemented), the key should be destroyed when all accesses have
1136 * stopped.
1137 */
Ronald Cron5c522922020-11-14 16:35:34 +01001138 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001139 {
Ronald Cron5c522922020-11-14 16:35:34 +01001140 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001141 return( PSA_ERROR_GENERIC_ERROR );
1142 }
1143
Gilles Peskine354f7672019-07-12 23:46:38 +02001144#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001145 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001146 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001147 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001148 /* For a key in a secure element, we need to do three things:
1149 * remove the key file in internal storage, destroy the
1150 * key inside the secure element, and update the driver's
1151 * persistent data. Start a transaction that will encompass these
1152 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001153 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001154 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001155 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001156 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001157 status = psa_crypto_save_transaction( );
1158 if( status != PSA_SUCCESS )
1159 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001160 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001161 /* We should still try to destroy the key in the secure
1162 * element and the key metadata in storage. This is especially
1163 * important if the error is that the storage is full.
1164 * But how to do it exactly without risking an inconsistent
1165 * state after a reset?
1166 * https://github.com/ARMmbed/mbed-crypto/issues/215
1167 */
1168 overall_status = status;
1169 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001170 }
1171
Ronald Cronea0f8a62020-11-25 17:52:23 +01001172 status = psa_destroy_se_key( driver,
1173 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001174 if( overall_status == PSA_SUCCESS )
1175 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001176 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001177#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1178
Darryl Greend49a4992018-06-18 17:27:26 +01001179#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001180 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001181 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001182 status = psa_destroy_persistent_key( slot->attr.id );
1183 if( overall_status == PSA_SUCCESS )
1184 overall_status = status;
1185
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001186 /* TODO: other slots may have a copy of the same key. We should
1187 * invalidate them.
1188 * https://github.com/ARMmbed/mbed-crypto/issues/214
1189 */
Darryl Greend49a4992018-06-18 17:27:26 +01001190 }
1191#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001192
Gilles Peskinefc762652019-07-22 19:30:34 +02001193#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1194 if( driver != NULL )
1195 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001196 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001197 if( overall_status == PSA_SUCCESS )
1198 overall_status = status;
1199 status = psa_crypto_stop_transaction( );
1200 if( overall_status == PSA_SUCCESS )
1201 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001202 }
1203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1204
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001205#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1206exit:
1207#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001208 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001209 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1210 if( overall_status == PSA_SUCCESS )
1211 overall_status = status;
1212 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001213}
1214
John Durkop07cc04a2020-11-16 22:08:34 -08001215#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001216 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001217static psa_status_t psa_get_rsa_public_exponent(
1218 const mbedtls_rsa_context *rsa,
1219 psa_key_attributes_t *attributes )
1220{
1221 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 uint8_t *buffer = NULL;
1224 size_t buflen;
1225 mbedtls_mpi_init( &mpi );
1226
1227 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1228 if( ret != 0 )
1229 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001230 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1231 {
1232 /* It's the default value, which is reported as an empty string,
1233 * so there's nothing to do. */
1234 goto exit;
1235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236
1237 buflen = mbedtls_mpi_size( &mpi );
1238 buffer = mbedtls_calloc( 1, buflen );
1239 if( buffer == NULL )
1240 {
1241 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1242 goto exit;
1243 }
1244 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1245 if( ret != 0 )
1246 goto exit;
1247 attributes->domain_parameters = buffer;
1248 attributes->domain_parameters_size = buflen;
1249
1250exit:
1251 mbedtls_mpi_free( &mpi );
1252 if( ret != 0 )
1253 mbedtls_free( buffer );
1254 return( mbedtls_to_psa_error( ret ) );
1255}
John Durkop07cc04a2020-11-16 22:08:34 -08001256#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001257 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001258
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001259/** Retrieve all the publicly-accessible attributes of a key.
1260 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001261psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001262 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001263{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001265 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001266 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001267
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001268 psa_reset_key_attributes( attributes );
1269
Ronald Cron5c522922020-11-14 16:35:34 +01001270 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001271 if( status != PSA_SUCCESS )
1272 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001273
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001274 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001275 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1276 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1277
1278#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1279 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001280 psa_set_key_slot_number( attributes,
1281 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001282#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001283
Gilles Peskine8e338702019-07-30 20:06:31 +02001284 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001285 {
John Durkop07cc04a2020-11-16 22:08:34 -08001286#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001287 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001288 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001289 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001290#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001291 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001292 * is not yet implemented.
1293 * https://github.com/ARMmbed/mbed-crypto/issues/216
1294 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001295 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001296 break;
1297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001298 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001299 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001300
Ronald Cron90857082020-11-25 14:58:33 +01001301 status = mbedtls_psa_rsa_load_representation(
1302 slot->attr.type,
1303 slot->key.data,
1304 slot->key.bytes,
1305 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001306 if( status != PSA_SUCCESS )
1307 break;
1308
Steven Cooremana2371e52020-07-28 14:30:39 +02001309 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001310 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001311 mbedtls_rsa_free( rsa );
1312 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001313 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001314 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001315#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001316 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001317 default:
1318 /* Nothing else to do. */
1319 break;
1320 }
1321
1322 if( status != PSA_SUCCESS )
1323 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001324
Ronald Cron5c522922020-11-14 16:35:34 +01001325 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001326
Ronald Cron5c522922020-11-14 16:35:34 +01001327 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001328}
1329
Gilles Peskinec8000c02019-08-02 20:15:51 +02001330#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1331psa_status_t psa_get_key_slot_number(
1332 const psa_key_attributes_t *attributes,
1333 psa_key_slot_number_t *slot_number )
1334{
1335 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1336 {
1337 *slot_number = attributes->slot_number;
1338 return( PSA_SUCCESS );
1339 }
1340 else
1341 return( PSA_ERROR_INVALID_ARGUMENT );
1342}
1343#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1346 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001347 uint8_t *data,
1348 size_t data_size,
1349 size_t *data_length )
1350{
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001352 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 memcpy( data, key_buffer, key_buffer_size );
1354 memset( data + key_buffer_size, 0,
1355 data_size - key_buffer_size );
1356 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001357 return( PSA_SUCCESS );
1358}
1359
Ronald Cron7285cda2020-11-26 14:46:37 +01001360psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 const psa_key_attributes_t *attributes,
1362 const uint8_t *key_buffer, size_t key_buffer_size,
1363 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001364{
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 psa_key_type_t type = attributes->core.type;
1366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( key_type_is_raw_bytes( type ) ||
1368 PSA_KEY_TYPE_IS_RSA( type ) ||
1369 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001370 {
1371 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001372 key_buffer, key_buffer_size,
1373 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001374 }
1375 else
1376 {
1377 /* This shouldn't happen in the reference implementation, but
1378 it is valid for a special-purpose implementation to omit
1379 support for exporting certain key types. */
1380 return( PSA_ERROR_NOT_SUPPORTED );
1381 }
1382}
1383
1384psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1385 uint8_t *data,
1386 size_t data_size,
1387 size_t *data_length )
1388{
1389 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1390 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1391 psa_key_slot_t *slot;
1392
Ronald Crone907e552021-01-18 13:22:38 +01001393 /* Reject a zero-length output buffer now, since this can never be a
1394 * valid key representation. This way we know that data must be a valid
1395 * pointer and we can do things like memset(data, ..., data_size). */
1396 if( data_size == 0 )
1397 return( PSA_ERROR_BUFFER_TOO_SMALL );
1398
Ronald Cron9486f9d2020-11-26 13:36:23 +01001399 /* Set the key to empty now, so that even when there are errors, we always
1400 * set data_length to a value between 0 and data_size. On error, setting
1401 * the key to empty is a good choice because an empty key representation is
1402 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001403 *data_length = 0;
1404
Ronald Cron9486f9d2020-11-26 13:36:23 +01001405 /* Export requires the EXPORT flag. There is an exception for public keys,
1406 * which don't require any flag, but
1407 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1408 */
1409 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1410 PSA_KEY_USAGE_EXPORT, 0 );
1411 if( status != PSA_SUCCESS )
1412 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001413
Ronald Crond18b5f82020-11-25 16:46:05 +01001414 psa_key_attributes_t attributes = {
1415 .core = slot->attr
1416 };
Ronald Cron67227982020-11-26 15:16:05 +01001417 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001418 slot->key.data, slot->key.bytes,
1419 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001420
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421 unlock_status = psa_unlock_key_slot( slot );
1422
1423 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1424}
1425
Ronald Cron7285cda2020-11-26 14:46:37 +01001426psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 const psa_key_attributes_t *attributes,
1428 const uint8_t *key_buffer,
1429 size_t key_buffer_size,
1430 uint8_t *data,
1431 size_t data_size,
1432 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433{
Ronald Crond18b5f82020-11-25 16:46:05 +01001434 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001435
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001437 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001438 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001439 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001440 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001441 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001442 key_buffer, key_buffer_size,
1443 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001444 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001445
Ronald Crond18b5f82020-11-25 16:46:05 +01001446 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001447 {
John Durkop0e005192020-10-31 22:06:54 -07001448#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1449 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001450 return( mbedtls_psa_rsa_export_public_key( attributes,
1451 key_buffer,
1452 key_buffer_size,
1453 data,
1454 data_size,
1455 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001456#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001457 /* We don't know how to convert a private RSA key to public. */
1458 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001459#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1460 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001461 }
1462 else
Moran Pekera998bc62018-04-16 18:16:20 +03001463 {
John Durkop6ba40d12020-11-10 08:50:04 -08001464#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1465 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001466 return( mbedtls_psa_ecp_export_public_key( attributes,
1467 key_buffer,
1468 key_buffer_size,
1469 data,
1470 data_size,
1471 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001472#else
1473 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001474 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001475#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1476 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001477 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001479 else
1480 {
1481 /* This shouldn't happen in the reference implementation, but
1482 it is valid for a special-purpose implementation to omit
1483 support for exporting certain key types. */
1484 return( PSA_ERROR_NOT_SUPPORTED );
1485 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001486}
Ronald Crond18b5f82020-11-25 16:46:05 +01001487
Ronald Croncf56a0a2020-08-04 09:51:30 +02001488psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001489 uint8_t *data,
1490 size_t data_size,
1491 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001492{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001494 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001495 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001496
Ronald Crone907e552021-01-18 13:22:38 +01001497 /* Reject a zero-length output buffer now, since this can never be a
1498 * valid key representation. This way we know that data must be a valid
1499 * pointer and we can do things like memset(data, ..., data_size). */
1500 if( data_size == 0 )
1501 return( PSA_ERROR_BUFFER_TOO_SMALL );
1502
Darryl Greendd8fb772018-11-07 16:00:44 +00001503 /* Set the key to empty now, so that even when there are errors, we always
1504 * set data_length to a value between 0 and data_size. On error, setting
1505 * the key to empty is a good choice because an empty key representation is
1506 * unlikely to be accepted anywhere. */
1507 *data_length = 0;
1508
1509 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001510 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001511 if( status != PSA_SUCCESS )
1512 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001513
Ronald Cron9486f9d2020-11-26 13:36:23 +01001514 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1515 {
1516 status = PSA_ERROR_INVALID_ARGUMENT;
1517 goto exit;
1518 }
1519
Ronald Crond18b5f82020-11-25 16:46:05 +01001520 psa_key_attributes_t attributes = {
1521 .core = slot->attr
1522 };
Ronald Cron67227982020-11-26 15:16:05 +01001523 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001524 &attributes, slot->key.data, slot->key.bytes,
1525 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001526
1527exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001528 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001529
Ronald Cron5c522922020-11-14 16:35:34 +01001530 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001531}
1532
Gilles Peskine91e8c332019-08-02 19:19:39 +02001533#if defined(static_assert)
1534static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1535 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001536static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001537 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001538static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001539 "One or more key attribute flag is listed as both internal-only and external-only" );
1540#endif
1541
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001542/** Validate that a key policy is internally well-formed.
1543 *
1544 * This function only rejects invalid policies. It does not validate the
1545 * consistency of the policy with respect to other attributes of the key
1546 * such as the key type.
1547 */
1548static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001549{
1550 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001551 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001552 PSA_KEY_USAGE_ENCRYPT |
1553 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001554 PSA_KEY_USAGE_SIGN_HASH |
1555 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001556 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1557 return( PSA_ERROR_INVALID_ARGUMENT );
1558
Gilles Peskine4747d192019-04-17 15:05:45 +02001559 return( PSA_SUCCESS );
1560}
1561
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001562/** Validate the internal consistency of key attributes.
1563 *
1564 * This function only rejects invalid attribute values. If does not
1565 * validate the consistency of the attributes with any key data that may
1566 * be involved in the creation of the key.
1567 *
1568 * Call this function early in the key creation process.
1569 *
1570 * \param[in] attributes Key attributes for the new key.
1571 * \param[out] p_drv On any return, the driver for the key, if any.
1572 * NULL for a transparent key.
1573 *
1574 */
1575static psa_status_t psa_validate_key_attributes(
1576 const psa_key_attributes_t *attributes,
1577 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001578{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001579 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001580 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001581 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001582
Ronald Cron54b90082020-10-29 15:26:43 +01001583 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001584 if( status != PSA_SUCCESS )
1585 return( status );
1586
Ronald Crond2ed4812020-07-17 16:11:30 +02001587 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001588 if( status != PSA_SUCCESS )
1589 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001590
Ronald Cron65f38a32020-10-23 17:11:13 +02001591 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1592 {
1593 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1594 return( PSA_ERROR_INVALID_ARGUMENT );
1595 }
1596 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001597 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001598 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001599 if( status != PSA_SUCCESS )
1600 return( status );
1601 }
1602
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001603 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001604 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001605 return( status );
1606
1607 /* Refuse to create overly large keys.
1608 * Note that this doesn't trigger on import if the attributes don't
1609 * explicitly specify a size (so psa_get_key_bits returns 0), so
1610 * psa_import_key() needs its own checks. */
1611 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1612 return( PSA_ERROR_NOT_SUPPORTED );
1613
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614 /* Reject invalid flags. These should not be reachable through the API. */
1615 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1616 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1617 return( PSA_ERROR_INVALID_ARGUMENT );
1618
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001619 return( PSA_SUCCESS );
1620}
1621
Gilles Peskine4747d192019-04-17 15:05:45 +02001622/** Prepare a key slot to receive key material.
1623 *
1624 * This function allocates a key slot and sets its metadata.
1625 *
1626 * If this function fails, call psa_fail_key_creation().
1627 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001628 * This function is intended to be used as follows:
1629 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001630 * it with the specified attributes, and in case of a volatile key assign it
1631 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001632 * -# Populate the slot with the key material.
1633 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1634 * In case of failure at any step, stop the sequence and call
1635 * psa_fail_key_creation().
1636 *
Ronald Cron5c522922020-11-14 16:35:34 +01001637 * On success, the key slot is locked. It is the responsibility of the caller
1638 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001639 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001640 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001641 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001642 * \param[out] p_slot On success, a pointer to the prepared slot.
1643 * \param[out] p_drv On any return, the driver for the key, if any.
1644 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001645 *
1646 * \retval #PSA_SUCCESS
1647 * The key slot is ready to receive key material.
1648 * \return If this function fails, the key slot is an invalid state.
1649 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001650 */
1651static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001652 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001653 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001655 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001656{
1657 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001658 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001659 psa_key_slot_t *slot;
1660
Gilles Peskinedf179142019-07-15 22:02:14 +02001661 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001662 *p_drv = NULL;
1663
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001664 status = psa_validate_key_attributes( attributes, p_drv );
1665 if( status != PSA_SUCCESS )
1666 return( status );
1667
Ronald Cronc4d1b512020-07-31 11:26:37 +02001668 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001669 if( status != PSA_SUCCESS )
1670 return( status );
1671 slot = *p_slot;
1672
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001673 /* We're storing the declared bit-size of the key. It's up to each
1674 * creation mechanism to verify that this information is correct.
1675 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001676 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001677 * is optional (import, copy). In case of a volatile key, assign it the
1678 * volatile key identifier associated to the slot returned to contain its
1679 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001680
1681 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001682 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1683 {
1684#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1685 slot->attr.id = volatile_key_id;
1686#else
1687 slot->attr.id.key_id = volatile_key_id;
1688#endif
1689 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001690
Gilles Peskine91e8c332019-08-02 19:19:39 +02001691 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001692 * external-only flags, query `attributes`. Thanks to the check
1693 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001694 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001695 * may have set. */
1696 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001697
Gilles Peskinecbaff462019-07-12 23:46:04 +02001698#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001699 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001700 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001701 * create the key file in internal storage, create the
1702 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001703 * persistent data. This is done by starting a transaction that will
1704 * encompass these three actions.
1705 * For registering a volatile key, we just need to find an appropriate
1706 * slot number inside the SE. Since the key is designated volatile, creating
1707 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001708 /* The first thing to do is to find a slot number for the new key.
1709 * We save the slot number in persistent storage as part of the
1710 * transaction data. It will be needed to recover if the power
1711 * fails during the key creation process, to clean up on the secure
1712 * element side after restarting. Obtaining a slot number from the
1713 * secure element driver updates its persistent state, but we do not yet
1714 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001715 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001716 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001717 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001718 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001719 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001721 if( status != PSA_SUCCESS )
1722 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001723
1724 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001725 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001726 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1727 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001728 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001729 psa_crypto_transaction.key.id = slot->attr.id;
1730 status = psa_crypto_save_transaction( );
1731 if( status != PSA_SUCCESS )
1732 {
1733 (void) psa_crypto_stop_transaction( );
1734 return( status );
1735 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001736 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001737
1738 status = psa_copy_key_material_into_slot(
1739 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001740 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001741
1742 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1743 {
1744 /* Key registration only makes sense with a secure element. */
1745 return( PSA_ERROR_INVALID_ARGUMENT );
1746 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001747#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1748
Ronald Cronc4d1b512020-07-31 11:26:37 +02001749 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001750}
Gilles Peskine4747d192019-04-17 15:05:45 +02001751
1752/** Finalize the creation of a key once its key material has been set.
1753 *
1754 * This entails writing the key to persistent storage.
1755 *
1756 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001757 * See the documentation of psa_start_key_creation() for the intended use
1758 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001759 *
Ronald Cron5c522922020-11-14 16:35:34 +01001760 * If the finalization succeeds, the function unlocks the key slot (it was
1761 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1762 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001763 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001764 * \param[in,out] slot Pointer to the slot with key material.
1765 * \param[in] driver The secure element driver for the key,
1766 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 * \param[out] key On success, identifier of the key. Note that the
1768 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001769 *
1770 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001771 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001772 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1773 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1774 * \retval #PSA_ERROR_ALREADY_EXISTS
1775 * \retval #PSA_ERROR_DATA_INVALID
1776 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001777 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001778 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001779 * \return If this function fails, the key slot is an invalid state.
1780 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001782static psa_status_t psa_finish_key_creation(
1783 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001784 psa_se_drv_table_entry_t *driver,
1785 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001786{
1787 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001788 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001789 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001790
1791#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001792 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001794#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1795 if( driver != NULL )
1796 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001797 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001798 psa_key_slot_number_t slot_number =
1799 psa_key_slot_get_slot_number( slot ) ;
1800
Gilles Peskineb46bef22019-07-30 21:32:04 +02001801#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001802 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001803 sizeof( data.slot_number ),
1804 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001805#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001806 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001807 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001808 (uint8_t*) &data,
1809 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001810 }
1811 else
1812#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1813 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001814 /* Key material is saved in export representation in the slot, so
1815 * just pass the slot buffer for storage. */
1816 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001817 slot->key.data,
1818 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001819 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001820 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001821#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1822
Gilles Peskinecbaff462019-07-12 23:46:04 +02001823#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001824 /* Finish the transaction for a key creation. This does not
1825 * happen when registering an existing key. Detect this case
1826 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001827 * creation of a persistent key in a secure element requires a transaction,
1828 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001829 if( driver != NULL &&
1830 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001831 {
1832 status = psa_save_se_persistent_data( driver );
1833 if( status != PSA_SUCCESS )
1834 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001835 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001836 return( status );
1837 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001838 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001839 }
1840#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1841
Ronald Cron50972942020-11-14 11:28:25 +01001842 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001843 {
1844 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001845 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001846 if( status != PSA_SUCCESS )
1847 *key = MBEDTLS_SVC_KEY_ID_INIT;
1848 }
Ronald Cron50972942020-11-14 11:28:25 +01001849
Gilles Peskine4747d192019-04-17 15:05:45 +02001850 return( status );
1851}
1852
1853/** Abort the creation of a key.
1854 *
1855 * You may call this function after calling psa_start_key_creation(),
1856 * or after psa_finish_key_creation() fails. In other circumstances, this
1857 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001858 * See the documentation of psa_start_key_creation() for the intended use
1859 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001860 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001861 * \param[in,out] slot Pointer to the slot with key material.
1862 * \param[in] driver The secure element driver for the key,
1863 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001864 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001865static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001866 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001867{
Gilles Peskine011e4282019-06-26 18:34:38 +02001868 (void) driver;
1869
Gilles Peskine4747d192019-04-17 15:05:45 +02001870 if( slot == NULL )
1871 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001872
1873#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001874 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001875 * element, and the failure happened later (when saving metadata
1876 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001877 * element.
1878 * https://github.com/ARMmbed/mbed-crypto/issues/217
1879 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001880
Gilles Peskined7729582019-08-05 15:55:54 +02001881 /* Abort the ongoing transaction if any (there may not be one if
1882 * the creation process failed before starting one, or if the
1883 * key creation is a registration of a key in a secure element).
1884 * Earlier functions must already have done what it takes to undo any
1885 * partial creation. All that's left is to update the transaction data
1886 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001887 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001888#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1889
Gilles Peskine4747d192019-04-17 15:05:45 +02001890 psa_wipe_key_slot( slot );
1891}
1892
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001893/** Validate optional attributes during key creation.
1894 *
1895 * Some key attributes are optional during key creation. If they are
1896 * specified in the attributes structure, check that they are consistent
1897 * with the data in the slot.
1898 *
1899 * This function should be called near the end of key creation, after
1900 * the slot in memory is fully populated but before saving persistent data.
1901 */
1902static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 const psa_key_slot_t *slot,
1904 const psa_key_attributes_t *attributes )
1905{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001906 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001908 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909 return( PSA_ERROR_INVALID_ARGUMENT );
1910 }
1911
1912 if( attributes->domain_parameters_size != 0 )
1913 {
John Durkop0e005192020-10-31 22:06:54 -07001914#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1915 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001916 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001917 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001918 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001919 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001921
Ronald Cron90857082020-11-25 14:58:33 +01001922 psa_status_t status = mbedtls_psa_rsa_load_representation(
1923 slot->attr.type,
1924 slot->key.data,
1925 slot->key.bytes,
1926 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001927 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001928 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001929
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001930 mbedtls_mpi_init( &actual );
1931 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001932 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001933 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001934 mbedtls_rsa_free( rsa );
1935 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001936 if( ret != 0 )
1937 goto rsa_exit;
1938 ret = mbedtls_mpi_read_binary( &required,
1939 attributes->domain_parameters,
1940 attributes->domain_parameters_size );
1941 if( ret != 0 )
1942 goto rsa_exit;
1943 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1944 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1945 rsa_exit:
1946 mbedtls_mpi_free( &actual );
1947 mbedtls_mpi_free( &required );
1948 if( ret != 0)
1949 return( mbedtls_to_psa_error( ret ) );
1950 }
1951 else
John Durkop9814fa22020-11-04 12:28:15 -08001952#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1953 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954 {
1955 return( PSA_ERROR_INVALID_ARGUMENT );
1956 }
1957 }
1958
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001959 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001960 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001961 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001962 return( PSA_ERROR_INVALID_ARGUMENT );
1963 }
1964
1965 return( PSA_SUCCESS );
1966}
1967
Gilles Peskine4747d192019-04-17 15:05:45 +02001968psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001969 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001970 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001971 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001972{
1973 psa_status_t status;
1974 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001975 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001976 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001977
Ronald Cron81709fc2020-11-14 12:10:32 +01001978 *key = MBEDTLS_SVC_KEY_ID_INIT;
1979
Gilles Peskine0f84d622019-09-12 19:03:13 +02001980 /* Reject zero-length symmetric keys (including raw data key objects).
1981 * This also rejects any key which might be encoded as an empty string,
1982 * which is never valid. */
1983 if( data_length == 0 )
1984 return( PSA_ERROR_INVALID_ARGUMENT );
1985
Gilles Peskinedf179142019-07-15 22:02:14 +02001986 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001987 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001988 if( status != PSA_SUCCESS )
1989 goto exit;
1990
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001991 /* In the case of a transparent key or an opaque key stored in local
1992 * storage (thus not in the case of generating a key in a secure element
1993 * or cryptoprocessor with storage), we have to allocate a buffer to
1994 * hold the generated key material. */
1995 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001996 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001997 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001998 if( status != PSA_SUCCESS )
1999 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002000 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002001
2002 bits = slot->attr.bits;
2003 status = psa_driver_wrapper_import_key( attributes,
2004 data, data_length,
2005 slot->key.data,
2006 slot->key.bytes,
2007 &slot->key.bytes, &bits );
2008 if( status != PSA_SUCCESS )
2009 goto exit;
2010
2011 if( slot->attr.bits == 0 )
2012 slot->attr.bits = (psa_key_bits_t) bits;
2013 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002014 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002015 status = PSA_ERROR_INVALID_ARGUMENT;
2016 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002017 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002018
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002019 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002020 if( status != PSA_SUCCESS )
2021 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022
Ronald Cron81709fc2020-11-14 12:10:32 +01002023 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002024exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002025 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002026 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002027
Gilles Peskine4747d192019-04-17 15:05:45 +02002028 return( status );
2029}
2030
Gilles Peskined7729582019-08-05 15:55:54 +02002031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2032psa_status_t mbedtls_psa_register_se_key(
2033 const psa_key_attributes_t *attributes )
2034{
2035 psa_status_t status;
2036 psa_key_slot_t *slot = NULL;
2037 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002038 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002039
2040 /* Leaving attributes unspecified is not currently supported.
2041 * It could make sense to query the key type and size from the
2042 * secure element, but not all secure elements support this
2043 * and the driver HAL doesn't currently support it. */
2044 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2045 return( PSA_ERROR_NOT_SUPPORTED );
2046 if( psa_get_key_bits( attributes ) == 0 )
2047 return( PSA_ERROR_NOT_SUPPORTED );
2048
2049 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002050 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002051 if( status != PSA_SUCCESS )
2052 goto exit;
2053
Ronald Cron81709fc2020-11-14 12:10:32 +01002054 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002055
2056exit:
2057 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002058 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002059
Gilles Peskined7729582019-08-05 15:55:54 +02002060 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002061 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002062 return( status );
2063}
2064#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2065
Gilles Peskinef603c712019-01-19 13:40:11 +01002066static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002068{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002069 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002070 source->key.data,
2071 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002072 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002073 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002074
Steven Cooreman398aee52020-10-13 14:35:45 +02002075 target->attr.type = source->attr.type;
2076 target->attr.bits = source->attr.bits;
2077
2078 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002079}
2080
Ronald Croncf56a0a2020-08-04 09:51:30 +02002081psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002082 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002083 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002084{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002085 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002086 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002087 psa_key_slot_t *source_slot = NULL;
2088 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002089 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002090 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002091
Ronald Cron81709fc2020-11-14 12:10:32 +01002092 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2093
Ronald Cron5c522922020-11-14 16:35:34 +01002094 status = psa_get_and_lock_transparent_key_slot_with_policy(
2095 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002096 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002097 goto exit;
2098
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002099 status = psa_validate_optional_attributes( source_slot,
2100 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002101 if( status != PSA_SUCCESS )
2102 goto exit;
2103
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002104 status = psa_restrict_key_policy( source_slot->attr.type,
2105 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002106 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002107 if( status != PSA_SUCCESS )
2108 goto exit;
2109
Ronald Cron81709fc2020-11-14 12:10:32 +01002110 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2111 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002112 if( status != PSA_SUCCESS )
2113 goto exit;
2114
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002115#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2116 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002117 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002118 /* Copying to a secure element is not implemented yet. */
2119 status = PSA_ERROR_NOT_SUPPORTED;
2120 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002121 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002122#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002123
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002124 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002125 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002126 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002127
Ronald Cron81709fc2020-11-14 12:10:32 +01002128 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002129exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002130 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002131 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002132
Ronald Cron5c522922020-11-14 16:35:34 +01002133 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002134
Ronald Cron5c522922020-11-14 16:35:34 +01002135 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002136}
2137
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002138
2139
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002140/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002141/* Message digests */
2142/****************************************************************/
2143
John Durkop07cc04a2020-11-16 22:08:34 -08002144#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002145 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2146 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002147 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Ronald Cron36f641b2021-02-16 17:20:43 +01002148const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002149{
2150 switch( alg )
2151 {
John Durkopee4e6602020-11-27 08:48:46 -08002152#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002153 case PSA_ALG_MD2:
2154 return( &mbedtls_md2_info );
2155#endif
John Durkopee4e6602020-11-27 08:48:46 -08002156#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002157 case PSA_ALG_MD4:
2158 return( &mbedtls_md4_info );
2159#endif
John Durkopee4e6602020-11-27 08:48:46 -08002160#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002161 case PSA_ALG_MD5:
2162 return( &mbedtls_md5_info );
2163#endif
John Durkopee4e6602020-11-27 08:48:46 -08002164#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002165 case PSA_ALG_RIPEMD160:
2166 return( &mbedtls_ripemd160_info );
2167#endif
John Durkopee4e6602020-11-27 08:48:46 -08002168#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002169 case PSA_ALG_SHA_1:
2170 return( &mbedtls_sha1_info );
2171#endif
John Durkopee4e6602020-11-27 08:48:46 -08002172#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002173 case PSA_ALG_SHA_224:
2174 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002175#endif
2176#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002177 case PSA_ALG_SHA_256:
2178 return( &mbedtls_sha256_info );
2179#endif
John Durkopee4e6602020-11-27 08:48:46 -08002180#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002181 case PSA_ALG_SHA_384:
2182 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002183#endif
John Durkopee4e6602020-11-27 08:48:46 -08002184#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002185 case PSA_ALG_SHA_512:
2186 return( &mbedtls_sha512_info );
2187#endif
2188 default:
2189 return( NULL );
2190 }
2191}
John Durkop07cc04a2020-11-16 22:08:34 -08002192#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002193 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2194 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2195 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002196
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2198{
Steven Cooreman0e307642021-02-18 16:18:32 +01002199 if( operation != NULL )
Steven Cooreman1e582352021-02-18 17:24:37 +01002200 return( psa_driver_wrapper_hash_abort( &operation->ctx ) );
Steven Cooreman0e307642021-02-18 16:18:32 +01002201 else
2202 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203}
2204
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002205psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002206 psa_algorithm_t alg )
2207{
Steven Cooreman0e307642021-02-18 16:18:32 +01002208 if( operation == NULL || !PSA_ALG_IS_HASH( alg ) )
2209 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002210
Steven Cooreman1e582352021-02-18 17:24:37 +01002211 return( psa_driver_wrapper_hash_setup( &operation->ctx, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212}
2213
2214psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2215 const uint8_t *input,
2216 size_t input_length )
2217{
Steven Cooreman0e307642021-02-18 16:18:32 +01002218 if( operation == NULL )
2219 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine94e44542018-07-12 16:58:43 +02002220
Steven Cooreman1e582352021-02-18 17:24:37 +01002221 return( psa_driver_wrapper_hash_update( &operation->ctx,
2222 input, input_length ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223}
2224
2225psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2226 uint8_t *hash,
2227 size_t hash_size,
2228 size_t *hash_length )
2229{
Steven Cooreman0e307642021-02-18 16:18:32 +01002230 if( operation == NULL )
2231 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002232
Steven Cooreman1e582352021-02-18 17:24:37 +01002233 psa_status_t status = psa_driver_wrapper_hash_finish(
2234 &operation->ctx,
2235 hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002236 psa_hash_abort( operation );
2237 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002238}
2239
Gilles Peskine2d277862018-06-18 15:41:12 +02002240psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2241 const uint8_t *hash,
2242 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002243{
Steven Cooreman1e582352021-02-18 17:24:37 +01002244 if( operation == NULL )
2245 return( PSA_ERROR_INVALID_ARGUMENT );
2246
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002247 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2248 size_t actual_hash_length;
Steven Cooreman1e582352021-02-18 17:24:37 +01002249 psa_status_t status = psa_driver_wrapper_hash_finish(
2250 &operation->ctx,
2251 actual_hash, sizeof( actual_hash ),
2252 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002253 if( status != PSA_SUCCESS )
2254 return( status );
2255 if( actual_hash_length != hash_length )
2256 return( PSA_ERROR_INVALID_SIGNATURE );
2257 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2258 return( PSA_ERROR_INVALID_SIGNATURE );
2259 return( PSA_SUCCESS );
2260}
2261
Gilles Peskine0a749c82019-11-28 19:33:58 +01002262psa_status_t psa_hash_compute( psa_algorithm_t alg,
2263 const uint8_t *input, size_t input_length,
2264 uint8_t *hash, size_t hash_size,
2265 size_t *hash_length )
2266{
Steven Cooreman1e582352021-02-18 17:24:37 +01002267 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2268 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002269}
2270
2271psa_status_t psa_hash_compare( psa_algorithm_t alg,
2272 const uint8_t *input, size_t input_length,
2273 const uint8_t *hash, size_t hash_length )
2274{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002275 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2276 size_t actual_hash_length;
Steven Cooreman1e582352021-02-18 17:24:37 +01002277 psa_status_t status = psa_driver_wrapper_hash_compute(
2278 alg, input, input_length,
2279 actual_hash, sizeof(actual_hash),
2280 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002281 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002282 return( status );
2283 if( actual_hash_length != hash_length )
2284 return( PSA_ERROR_INVALID_SIGNATURE );
2285 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2286 return( PSA_ERROR_INVALID_SIGNATURE );
2287 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002288}
2289
Gilles Peskineeb35d782019-01-22 17:56:16 +01002290psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2291 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002292{
Steven Cooreman0e307642021-02-18 16:18:32 +01002293 if( source_operation == NULL || target_operation == NULL )
2294 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002295
Steven Cooreman1e582352021-02-18 17:24:37 +01002296 return( psa_driver_wrapper_hash_clone( &source_operation->ctx,
2297 &target_operation->ctx ) );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002298}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002299
2300
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002301/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002302/* MAC */
2303/****************************************************************/
2304
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002305static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002306 psa_algorithm_t alg,
2307 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002308 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002309 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002310{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002311 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002312 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002313
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002314 if( PSA_ALG_IS_AEAD( alg ) )
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002315 alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002316
Gilles Peskine8c9def32018-02-08 10:02:12 +01002317 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2318 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002319 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002321 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002322 mode = MBEDTLS_MODE_STREAM;
2323 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002324 case PSA_ALG_CTR:
2325 mode = MBEDTLS_MODE_CTR;
2326 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002327 case PSA_ALG_CFB:
2328 mode = MBEDTLS_MODE_CFB;
2329 break;
2330 case PSA_ALG_OFB:
2331 mode = MBEDTLS_MODE_OFB;
2332 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002333 case PSA_ALG_ECB_NO_PADDING:
2334 mode = MBEDTLS_MODE_ECB;
2335 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002336 case PSA_ALG_CBC_NO_PADDING:
2337 mode = MBEDTLS_MODE_CBC;
2338 break;
2339 case PSA_ALG_CBC_PKCS7:
2340 mode = MBEDTLS_MODE_CBC;
2341 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002342 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002343 mode = MBEDTLS_MODE_CCM;
2344 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002345 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346 mode = MBEDTLS_MODE_GCM;
2347 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002348 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02002349 mode = MBEDTLS_MODE_CHACHAPOLY;
2350 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351 default:
2352 return( NULL );
2353 }
2354 }
2355 else if( alg == PSA_ALG_CMAC )
2356 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002357 else
2358 return( NULL );
2359
2360 switch( key_type )
2361 {
2362 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002363 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002364 break;
2365 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002366 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2367 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002368 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002369 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002370 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002371 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002372 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2373 * but two-key Triple-DES is functionally three-key Triple-DES
2374 * with K1=K3, so that's how we present it to mbedtls. */
2375 if( key_bits == 128 )
2376 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002377 break;
2378 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002379 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002380 break;
2381 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002382 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002383 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002384 case PSA_KEY_TYPE_CHACHA20:
2385 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2386 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002387 default:
2388 return( NULL );
2389 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002390 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002391 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002392
Jaeden Amero23bbb752018-06-26 14:16:54 +01002393 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2394 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002395}
2396
John Durkop6ba40d12020-11-10 08:50:04 -08002397#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002398static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002399{
Gilles Peskine2d277862018-06-18 15:41:12 +02002400 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002401 {
2402 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002403 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002404 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002405 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002406 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002407 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002408 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002409 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002410 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002411 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002412 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002413 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002414 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002415 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002416 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002417 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002418 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002419 return( 128 );
2420 default:
2421 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002422 }
2423}
John Durkop07cc04a2020-11-16 22:08:34 -08002424#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002425
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002426/* Initialize the MAC operation structure. Once this function has been
2427 * called, psa_mac_abort can run and will do the right thing. */
2428static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2429 psa_algorithm_t alg )
2430{
2431 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2432
Steven Cooreman15472f82021-03-02 16:16:22 +01002433 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002434 operation->key_set = 0;
2435 operation->iv_set = 0;
2436 operation->iv_required = 0;
2437 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002438 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002439
2440#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002441 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002442 {
2443 operation->iv_required = 0;
2444 mbedtls_cipher_init( &operation->ctx.cmac );
2445 status = PSA_SUCCESS;
2446 }
2447 else
2448#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002449#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002450 if( PSA_ALG_IS_HMAC( operation->alg ) )
2451 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002452 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002453 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002454 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002455 }
2456 else
John Durkopd0321952020-10-29 21:37:36 -07002457#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002458 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002459 if( ! PSA_ALG_IS_MAC( alg ) )
2460 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002461 }
2462
2463 if( status != PSA_SUCCESS )
2464 memset( operation, 0, sizeof( *operation ) );
2465 return( status );
2466}
2467
John Durkop6ba40d12020-11-10 08:50:04 -08002468#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002469static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2470{
Gilles Peskine3f108122018-12-07 18:14:53 +01002471 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002472 return( psa_hash_abort( &hmac->hash_ctx ) );
2473}
John Durkop6ba40d12020-11-10 08:50:04 -08002474#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002475
Gilles Peskine8c9def32018-02-08 10:02:12 +01002476psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2477{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002478 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002479 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002480 /* The object has (apparently) been initialized but it is not
2481 * in use. It's ok to call abort on such an object, and there's
2482 * nothing to do. */
2483 return( PSA_SUCCESS );
2484 }
2485 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002486#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002487 if( operation->alg == PSA_ALG_CMAC )
2488 {
2489 mbedtls_cipher_free( &operation->ctx.cmac );
2490 }
2491 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002492#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002493#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002494 if( PSA_ALG_IS_HMAC( operation->alg ) )
2495 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002496 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002497 }
2498 else
John Durkopd0321952020-10-29 21:37:36 -07002499#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002500 {
2501 /* Sanity check (shouldn't happen: operation->alg should
2502 * always have been initialized to a valid value). */
2503 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002504 }
Moran Peker41deec42018-04-04 15:43:05 +03002505
Gilles Peskine8c9def32018-02-08 10:02:12 +01002506 operation->alg = 0;
2507 operation->key_set = 0;
2508 operation->iv_set = 0;
2509 operation->iv_required = 0;
2510 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002511 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002512
Gilles Peskine8c9def32018-02-08 10:02:12 +01002513 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002514
2515bad_state:
2516 /* If abort is called on an uninitialized object, we can't trust
2517 * anything. Wipe the object in case it contains confidential data.
2518 * This may result in a memory leak if a pointer gets overwritten,
2519 * but it's too late to do anything about this. */
2520 memset( operation, 0, sizeof( *operation ) );
2521 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522}
2523
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002524#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002525static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2526 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002527{
Janos Follath24eed8d2019-11-22 13:21:35 +00002528 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002529 const mbedtls_cipher_info_t *cipher_info =
2530 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2531 slot->attr.type, slot->attr.bits,
2532 NULL );
2533 if( cipher_info == NULL )
2534 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002535
2536 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2537 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002538 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002539
2540 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002541 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002542 slot->attr.bits );
2543exit:
2544 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002545}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002546#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002547
John Durkop6ba40d12020-11-10 08:50:04 -08002548#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002549static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2550 const uint8_t *key,
2551 size_t key_length,
2552 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002553{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002554 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002555 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002556 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002557 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002558 psa_status_t status;
2559
Steven Cooreman0e307642021-02-18 16:18:32 +01002560 hmac->alg = hash_alg;
2561
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002562 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2563 * overflow below. This should never trigger if the hash algorithm
2564 * is implemented correctly. */
2565 /* The size checks against the ipad and opad buffers cannot be written
2566 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2567 * because that triggers -Wlogical-op on GCC 7.3. */
2568 if( block_size > sizeof( ipad ) )
2569 return( PSA_ERROR_NOT_SUPPORTED );
2570 if( block_size > sizeof( hmac->opad ) )
2571 return( PSA_ERROR_NOT_SUPPORTED );
2572 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002573 return( PSA_ERROR_NOT_SUPPORTED );
2574
Gilles Peskined223b522018-06-11 18:12:58 +02002575 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002576 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002577 status = psa_hash_compute( hash_alg, key, key_length,
2578 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002579 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002580 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002581 }
Gilles Peskine96889972018-07-12 17:07:03 +02002582 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2583 * but it is permitted. It is common when HMAC is used in HKDF, for
2584 * example. Don't call `memcpy` in the 0-length because `key` could be
2585 * an invalid pointer which would make the behavior undefined. */
2586 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002587 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002588
Gilles Peskined223b522018-06-11 18:12:58 +02002589 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2590 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002591 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002592 ipad[i] ^= 0x36;
2593 memset( ipad + key_length, 0x36, block_size - key_length );
2594
2595 /* Copy the key material from ipad to opad, flipping the requisite bits,
2596 * and filling the rest of opad with the requisite constant. */
2597 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002598 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2599 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002600
Gilles Peskine01126fa2018-07-12 17:04:55 +02002601 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002602 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002603 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002604
Gilles Peskine01126fa2018-07-12 17:04:55 +02002605 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002606
2607cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002608 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002609
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002610 return( status );
2611}
John Durkop6ba40d12020-11-10 08:50:04 -08002612#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002613
Gilles Peskine89167cb2018-07-08 20:12:23 +02002614static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002615 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002616 psa_algorithm_t alg,
2617 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002618{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002619 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002620 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002621 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002622 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002623 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002624
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002625 /* A context must be freshly initialized before it can be set up. */
2626 if( operation->alg != 0 )
2627 {
2628 return( PSA_ERROR_BAD_STATE );
2629 }
2630
Steven Cooreman15472f82021-03-02 16:16:22 +01002631 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002632 if( status != PSA_SUCCESS )
2633 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002634 if( is_sign )
2635 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002636
Ronald Cron5c522922020-11-14 16:35:34 +01002637 status = psa_get_and_lock_transparent_key_slot_with_policy(
2638 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002639 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002640 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002641
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002642 /* Validate the combination of key type and algorithm */
2643 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002644 if( status != PSA_SUCCESS )
2645 goto exit;
2646
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002647 /* Get the output length for the algorithm and key combination. None of the
2648 * currently supported algorithms have an output length dependent on actual
2649 * key size, so setting it to a bogus value is currently OK. */
2650 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002651
2652 if( operation->mac_size < 4 )
2653 {
2654 /* A very short MAC is too short for security since it can be
2655 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2656 * so we make this our minimum, even though 32 bits is still
2657 * too small for security. */
2658 status = PSA_ERROR_NOT_SUPPORTED;
2659 goto exit;
2660 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002661
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002662 if( operation->mac_size >
2663 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2664 {
2665 /* It's impossible to "truncate" to a larger length than the full length
2666 * of the algorithm. */
2667 status = PSA_ERROR_INVALID_ARGUMENT;
2668 goto exit;
2669 }
2670
Gilles Peskine8c9def32018-02-08 10:02:12 +01002671#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002672 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002673 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002674 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002675 }
2676 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002677#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002678#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002679 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002680 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002681 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002682 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002683 {
2684 status = PSA_ERROR_NOT_SUPPORTED;
2685 goto exit;
2686 }
2687
Gilles Peskine8e338702019-07-30 20:06:31 +02002688 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002689 {
2690 status = PSA_ERROR_INVALID_ARGUMENT;
2691 goto exit;
2692 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002693
Gilles Peskine01126fa2018-07-12 17:04:55 +02002694 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002695 slot->key.data,
2696 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002697 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002698 }
2699 else
John Durkopd0321952020-10-29 21:37:36 -07002700#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002701 {
2702 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002703 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002704
Gilles Peskinefbfac682018-07-08 20:51:54 +02002705exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002706 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002707 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002708 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002709 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002710 else
2711 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002712 operation->key_set = 1;
2713 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002714
Ronald Cron5c522922020-11-14 16:35:34 +01002715 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002716
Ronald Cron5c522922020-11-14 16:35:34 +01002717 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002718}
2719
Gilles Peskine89167cb2018-07-08 20:12:23 +02002720psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002721 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002722 psa_algorithm_t alg )
2723{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002724 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002725}
2726
2727psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002728 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002729 psa_algorithm_t alg )
2730{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002731 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002732}
2733
Gilles Peskine8c9def32018-02-08 10:02:12 +01002734psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2735 const uint8_t *input,
2736 size_t input_length )
2737{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002738 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002739 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002740 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002741 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002742 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743 operation->has_input = 1;
2744
Gilles Peskine8c9def32018-02-08 10:02:12 +01002745#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002746 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002747 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002748 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2749 input, input_length );
2750 status = mbedtls_to_psa_error( ret );
2751 }
2752 else
2753#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002754#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002755 if( PSA_ALG_IS_HMAC( operation->alg ) )
2756 {
2757 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2758 input_length );
2759 }
2760 else
John Durkopd0321952020-10-29 21:37:36 -07002761#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002762 {
2763 /* This shouldn't happen if `operation` was initialized by
2764 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002765 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002766 }
2767
Gilles Peskinefbfac682018-07-08 20:51:54 +02002768 if( status != PSA_SUCCESS )
2769 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002770 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002771}
2772
John Durkop6ba40d12020-11-10 08:50:04 -08002773#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002774static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2775 uint8_t *mac,
2776 size_t mac_size )
2777{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002778 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002779 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002780 size_t hash_size = 0;
2781 size_t block_size = psa_get_hash_block_size( hash_alg );
2782 psa_status_t status;
2783
Gilles Peskine01126fa2018-07-12 17:04:55 +02002784 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2785 if( status != PSA_SUCCESS )
2786 return( status );
2787 /* From here on, tmp needs to be wiped. */
2788
2789 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2790 if( status != PSA_SUCCESS )
2791 goto exit;
2792
2793 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2794 if( status != PSA_SUCCESS )
2795 goto exit;
2796
2797 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2798 if( status != PSA_SUCCESS )
2799 goto exit;
2800
Gilles Peskined911eb72018-08-14 15:18:45 +02002801 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2802 if( status != PSA_SUCCESS )
2803 goto exit;
2804
2805 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002806
2807exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002808 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002809 return( status );
2810}
John Durkop6ba40d12020-11-10 08:50:04 -08002811#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002812
mohammad16036df908f2018-04-02 08:34:15 -07002813static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002814 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002815 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002816{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002817 if( ! operation->key_set )
2818 return( PSA_ERROR_BAD_STATE );
2819 if( operation->iv_required && ! operation->iv_set )
2820 return( PSA_ERROR_BAD_STATE );
2821
Gilles Peskine8c9def32018-02-08 10:02:12 +01002822 if( mac_size < operation->mac_size )
2823 return( PSA_ERROR_BUFFER_TOO_SMALL );
2824
Gilles Peskine8c9def32018-02-08 10:02:12 +01002825#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002826 if( operation->alg == PSA_ALG_CMAC )
2827 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002828 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002829 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2830 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002831 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002832 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002833 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002834 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002835 else
2836#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002837#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002838 if( PSA_ALG_IS_HMAC( operation->alg ) )
2839 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002840 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002841 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002842 }
2843 else
John Durkopd0321952020-10-29 21:37:36 -07002844#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002845 {
2846 /* This shouldn't happen if `operation` was initialized by
2847 * a setup function. */
2848 return( PSA_ERROR_BAD_STATE );
2849 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002850}
2851
Gilles Peskineacd4be32018-07-08 19:56:25 +02002852psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2853 uint8_t *mac,
2854 size_t mac_size,
2855 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002856{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002857 psa_status_t status;
2858
Jaeden Amero252ef282019-02-15 14:05:35 +00002859 if( operation->alg == 0 )
2860 {
2861 return( PSA_ERROR_BAD_STATE );
2862 }
2863
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002864 /* Fill the output buffer with something that isn't a valid mac
2865 * (barring an attack on the mac and deliberately-crafted input),
2866 * in case the caller doesn't check the return status properly. */
2867 *mac_length = mac_size;
2868 /* If mac_size is 0 then mac may be NULL and then the
2869 * call to memset would have undefined behavior. */
2870 if( mac_size != 0 )
2871 memset( mac, '!', mac_size );
2872
Gilles Peskine89167cb2018-07-08 20:12:23 +02002873 if( ! operation->is_sign )
2874 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002875 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002876 }
mohammad16036df908f2018-04-02 08:34:15 -07002877
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002878 status = psa_mac_finish_internal( operation, mac, mac_size );
2879
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002880 if( status == PSA_SUCCESS )
2881 {
2882 status = psa_mac_abort( operation );
2883 if( status == PSA_SUCCESS )
2884 *mac_length = operation->mac_size;
2885 else
2886 memset( mac, '!', mac_size );
2887 }
2888 else
2889 psa_mac_abort( operation );
2890 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002891}
2892
Gilles Peskineacd4be32018-07-08 19:56:25 +02002893psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2894 const uint8_t *mac,
2895 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002896{
Gilles Peskine828ed142018-06-18 23:25:51 +02002897 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002898 psa_status_t status;
2899
Jaeden Amero252ef282019-02-15 14:05:35 +00002900 if( operation->alg == 0 )
2901 {
2902 return( PSA_ERROR_BAD_STATE );
2903 }
2904
Gilles Peskine89167cb2018-07-08 20:12:23 +02002905 if( operation->is_sign )
2906 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002907 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002908 }
2909 if( operation->mac_size != mac_length )
2910 {
2911 status = PSA_ERROR_INVALID_SIGNATURE;
2912 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002913 }
mohammad16036df908f2018-04-02 08:34:15 -07002914
2915 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002916 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002917 if( status != PSA_SUCCESS )
2918 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002919
2920 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2921 status = PSA_ERROR_INVALID_SIGNATURE;
2922
2923cleanup:
2924 if( status == PSA_SUCCESS )
2925 status = psa_mac_abort( operation );
2926 else
2927 psa_mac_abort( operation );
2928
Gilles Peskine3f108122018-12-07 18:14:53 +01002929 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002930
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002931 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932}
2933
2934
Gilles Peskine20035e32018-02-03 22:44:14 +01002935
Gilles Peskine20035e32018-02-03 22:44:14 +01002936/****************************************************************/
2937/* Asymmetric cryptography */
2938/****************************************************************/
2939
Ronald Cron67b1eb32020-12-08 17:37:27 +01002940psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002941 const psa_key_attributes_t *attributes,
2942 const uint8_t *key_buffer, size_t key_buffer_size,
2943 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2944 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002945{
Gilles Peskine20035e32018-02-03 22:44:14 +01002946#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2947 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01002948 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002949 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01002950 return( mbedtls_psa_rsa_sign_hash(
2951 attributes,
2952 key_buffer, key_buffer_size,
2953 alg, hash, hash_length,
2954 signature, signature_size, signature_length ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01002955 }
2956 else
Gilles Peskine20035e32018-02-03 22:44:14 +01002957#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2958 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002959#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2960 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Ronald Cronbb9cbc72021-03-04 17:09:00 +01002961 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01002962 {
Ronald Cron9103d492021-03-04 11:26:03 +01002963 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002964 {
Ronald Cron072722c2020-12-09 16:36:19 +01002965 return( mbedtls_psa_ecdsa_sign_hash(
2966 attributes,
2967 key_buffer, key_buffer_size,
2968 alg, hash, hash_length,
2969 signature, signature_size, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02002970 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002971 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002972 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002973 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002974 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002975 }
2976 else
Gilles Peskinee59236f2018-01-27 23:32:46 +01002977#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2978 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
itayzafrir5c753392018-05-08 11:18:38 +03002979 {
Ronald Cronbb9cbc72021-03-04 17:09:00 +01002980 (void)attributes;
Ronald Cron8a494f32021-02-17 09:49:51 +01002981 (void)key_buffer;
2982 (void)key_buffer_size;
2983 (void)alg;
2984 (void)hash;
2985 (void)hash_length;
2986 (void)signature;
2987 (void)signature_size;
2988 (void)signature_length;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002989
Ronald Cron8a494f32021-02-17 09:49:51 +01002990 return( PSA_ERROR_NOT_SUPPORTED );
2991 }
Ronald Cron18659932020-12-08 16:32:23 +01002992}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002993
2994psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2995 psa_algorithm_t alg,
2996 const uint8_t *hash,
2997 size_t hash_length,
2998 uint8_t *signature,
2999 size_t signature_size,
3000 size_t *signature_length )
3001{
3002 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3003 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3004 psa_key_slot_t *slot;
3005
3006 *signature_length = signature_size;
3007 /* Immediately reject a zero-length signature buffer. This guarantees
3008 * that signature must be a valid pointer. (On the other hand, the hash
3009 * buffer can in principle be empty since it doesn't actually have
3010 * to be a hash.) */
3011 if( signature_size == 0 )
3012 return( PSA_ERROR_BUFFER_TOO_SMALL );
3013
3014 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3015 PSA_KEY_USAGE_SIGN_HASH,
3016 alg );
3017 if( status != PSA_SUCCESS )
3018 goto exit;
3019 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
3020 {
3021 status = PSA_ERROR_INVALID_ARGUMENT;
3022 goto exit;
3023 }
3024
Ronald Cron9f17aa42020-12-08 17:07:25 +01003025 psa_key_attributes_t attributes = {
3026 .core = slot->attr
3027 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003028
Ronald Cron9f17aa42020-12-08 17:07:25 +01003029 status = psa_driver_wrapper_sign_hash(
3030 &attributes, slot->key.data, slot->key.bytes,
3031 alg, hash, hash_length,
3032 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003033
3034exit:
3035 /* Fill the unused part of the output buffer (the whole buffer on error,
3036 * the trailing part on success) with something that isn't a valid mac
3037 * (barring an attack on the mac and deliberately-crafted input),
3038 * in case the caller doesn't check the return status properly. */
3039 if( status == PSA_SUCCESS )
3040 memset( signature + *signature_length, '!',
3041 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003042 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003043 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003044 /* If signature_size is 0 then we have nothing to do. We must not call
3045 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003046
Ronald Cron5c522922020-11-14 16:35:34 +01003047 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003048
Ronald Cron5c522922020-11-14 16:35:34 +01003049 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003050}
3051
Ronald Cron67b1eb32020-12-08 17:37:27 +01003052psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01003053 const psa_key_attributes_t *attributes,
3054 const uint8_t *key_buffer, size_t key_buffer_size,
3055 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3056 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003057{
John Durkop6ba40d12020-11-10 08:50:04 -08003058#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3059 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01003060 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003061 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01003062 return( mbedtls_psa_rsa_verify_hash(
3063 attributes,
3064 key_buffer, key_buffer_size,
3065 alg, hash, hash_length,
3066 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003067 }
3068 else
John Durkop6ba40d12020-11-10 08:50:04 -08003069#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3070 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Ronald Cron99b8ed72021-02-17 10:33:32 +01003071 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003072 {
John Durkop9814fa22020-11-04 12:28:15 -08003073#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3074 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003075 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003076 {
Ronald Cron072722c2020-12-09 16:36:19 +01003077 return( mbedtls_psa_ecdsa_verify_hash(
3078 attributes,
3079 key_buffer, key_buffer_size,
3080 alg, hash, hash_length,
3081 signature, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003082 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003083 else
John Durkop9814fa22020-11-04 12:28:15 -08003084#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3085 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003086 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003087 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003088 }
itayzafrir5c753392018-05-08 11:18:38 +03003089 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003090 else
Gilles Peskinee59236f2018-01-27 23:32:46 +01003091 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003092 (void)key_buffer;
3093 (void)key_buffer_size;
3094 (void)alg;
3095 (void)hash;
3096 (void)hash_length;
3097 (void)signature;
3098 (void)signature_length;
Ronald Cronf95a2b12020-10-22 15:24:49 +02003099
Ronald Cron8a494f32021-02-17 09:49:51 +01003100 return( PSA_ERROR_NOT_SUPPORTED );
3101 }
Ronald Cron18659932020-12-08 16:32:23 +01003102}
3103
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3105 psa_algorithm_t alg,
3106 const uint8_t *hash,
3107 size_t hash_length,
3108 const uint8_t *signature,
3109 size_t signature_length )
3110{
3111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3112 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003113 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114
3115 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003116 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003117 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003118 if( status != PSA_SUCCESS )
3119 return( status );
3120
Ronald Cron9f17aa42020-12-08 17:07:25 +01003121 psa_key_attributes_t attributes = {
3122 .core = slot->attr
3123 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003124
Ronald Cron9f17aa42020-12-08 17:07:25 +01003125 status = psa_driver_wrapper_verify_hash(
3126 &attributes, slot->key.data, slot->key.bytes,
3127 alg, hash, hash_length,
3128 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003129
Ronald Cron5c522922020-11-14 16:35:34 +01003130 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003131
Ronald Cron5c522922020-11-14 16:35:34 +01003132 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003133}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003134
John Durkop0e005192020-10-31 22:06:54 -07003135#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003136static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3137 mbedtls_rsa_context *rsa )
3138{
3139 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3140 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3141 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3142 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3143}
John Durkop0e005192020-10-31 22:06:54 -07003144#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003145
Ronald Croncf56a0a2020-08-04 09:51:30 +02003146psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003147 psa_algorithm_t alg,
3148 const uint8_t *input,
3149 size_t input_length,
3150 const uint8_t *salt,
3151 size_t salt_length,
3152 uint8_t *output,
3153 size_t output_size,
3154 size_t *output_length )
3155{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003157 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003158 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003159
Darryl Green5cc689a2018-07-24 15:34:10 +01003160 (void) input;
3161 (void) input_length;
3162 (void) salt;
3163 (void) output;
3164 (void) output_size;
3165
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166 *output_length = 0;
3167
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003168 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3169 return( PSA_ERROR_INVALID_ARGUMENT );
3170
Ronald Cron5c522922020-11-14 16:35:34 +01003171 status = psa_get_and_lock_transparent_key_slot_with_policy(
3172 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003173 if( status != PSA_SUCCESS )
3174 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003175 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3176 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003177 {
3178 status = PSA_ERROR_INVALID_ARGUMENT;
3179 goto exit;
3180 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181
John Durkop6ba40d12020-11-10 08:50:04 -08003182#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3183 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003184 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003185 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003186 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003187 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3188 slot->key.data,
3189 slot->key.bytes,
3190 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003191 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003192 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003193
3194 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003195 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003196 status = PSA_ERROR_BUFFER_TOO_SMALL;
3197 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003198 }
John Durkop0e005192020-10-31 22:06:54 -07003199#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003200 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3201 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003202 status = mbedtls_to_psa_error(
3203 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003204 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003205 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003206 MBEDTLS_RSA_PUBLIC,
3207 input_length,
3208 input,
3209 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210 }
3211 else
John Durkop0e005192020-10-31 22:06:54 -07003212#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3213#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3215 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003216 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003217 status = mbedtls_to_psa_error(
3218 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003219 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003220 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003221 MBEDTLS_RSA_PUBLIC,
3222 salt, salt_length,
3223 input_length,
3224 input,
3225 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003226 }
3227 else
John Durkop0e005192020-10-31 22:06:54 -07003228#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003229 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003230 status = PSA_ERROR_INVALID_ARGUMENT;
3231 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003232 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003233rsa_exit:
3234 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003235 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003236
Steven Cooremana2371e52020-07-28 14:30:39 +02003237 mbedtls_rsa_free( rsa );
3238 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003239 }
3240 else
John Durkop9814fa22020-11-04 12:28:15 -08003241#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003242 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003243 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003244 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003245 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003246
3247exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003248 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003249
Ronald Cron5c522922020-11-14 16:35:34 +01003250 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003251}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003252
Ronald Croncf56a0a2020-08-04 09:51:30 +02003253psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003254 psa_algorithm_t alg,
3255 const uint8_t *input,
3256 size_t input_length,
3257 const uint8_t *salt,
3258 size_t salt_length,
3259 uint8_t *output,
3260 size_t output_size,
3261 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003262{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003264 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003265 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003266
Darryl Green5cc689a2018-07-24 15:34:10 +01003267 (void) input;
3268 (void) input_length;
3269 (void) salt;
3270 (void) output;
3271 (void) output_size;
3272
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003273 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003274
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003275 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3276 return( PSA_ERROR_INVALID_ARGUMENT );
3277
Ronald Cron5c522922020-11-14 16:35:34 +01003278 status = psa_get_and_lock_transparent_key_slot_with_policy(
3279 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003280 if( status != PSA_SUCCESS )
3281 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003282 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003283 {
3284 status = PSA_ERROR_INVALID_ARGUMENT;
3285 goto exit;
3286 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003287
John Durkop6ba40d12020-11-10 08:50:04 -08003288#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3289 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003290 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003291 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003292 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003293 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3294 slot->key.data,
3295 slot->key.bytes,
3296 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003297 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003298 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003299
Steven Cooremana2371e52020-07-28 14:30:39 +02003300 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003301 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003302 status = PSA_ERROR_INVALID_ARGUMENT;
3303 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003304 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003305
John Durkop0e005192020-10-31 22:06:54 -07003306#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003307 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003308 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003309 status = mbedtls_to_psa_error(
3310 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003311 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003312 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003313 MBEDTLS_RSA_PRIVATE,
3314 output_length,
3315 input,
3316 output,
3317 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003318 }
3319 else
John Durkop0e005192020-10-31 22:06:54 -07003320#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3321#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003322 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003323 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003324 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003325 status = mbedtls_to_psa_error(
3326 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003327 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003328 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003329 MBEDTLS_RSA_PRIVATE,
3330 salt, salt_length,
3331 output_length,
3332 input,
3333 output,
3334 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003335 }
3336 else
John Durkop0e005192020-10-31 22:06:54 -07003337#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003338 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003339 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003340 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003341
Steven Cooreman4fed4552020-08-03 14:46:03 +02003342rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003343 mbedtls_rsa_free( rsa );
3344 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003345 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003346 else
John Durkop6ba40d12020-11-10 08:50:04 -08003347#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3348 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003349 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003350 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003351 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003352
3353exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003354 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003355
Ronald Cron5c522922020-11-14 16:35:34 +01003356 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003357}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003358
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003359
3360
mohammad1603503973b2018-03-12 15:59:30 +02003361/****************************************************************/
3362/* Symmetric cryptography */
3363/****************************************************************/
3364
Gilles Peskinee553c652018-06-04 16:22:46 +02003365static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003366 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003367 psa_algorithm_t alg,
3368 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003369{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003370 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003371 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003372 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003373 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003374 size_t key_bits;
3375 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003376 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3377 PSA_KEY_USAGE_ENCRYPT :
3378 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003379
Steven Cooremand3feccd2020-09-01 15:56:14 +02003380 /* A context must be freshly initialized before it can be set up. */
3381 if( operation->alg != 0 )
3382 return( PSA_ERROR_BAD_STATE );
3383
Steven Cooremana07b9972020-09-10 14:54:14 +02003384 /* The requested algorithm must be one that can be processed by cipher. */
3385 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003386 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003387
Steven Cooremanef8575e2020-09-11 11:44:50 +02003388 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003389 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003390 if( status != PSA_SUCCESS )
3391 goto exit;
3392
3393 /* Initialize the operation struct members, except for alg. The alg member
3394 * is used to indicate to psa_cipher_abort that there are resources to free,
3395 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003396 operation->key_set = 0;
3397 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003398 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003399 operation->iv_size = 0;
3400 operation->block_size = 0;
3401 if( alg == PSA_ALG_ECB_NO_PADDING )
3402 operation->iv_required = 0;
3403 else
3404 operation->iv_required = 1;
3405
Steven Cooremana07b9972020-09-10 14:54:14 +02003406 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003407 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003408 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003409 slot,
3410 alg );
3411 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003412 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003413 slot,
3414 alg );
3415
Steven Cooremanef8575e2020-09-11 11:44:50 +02003416 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003417 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003418 /* Once the driver context is initialised, it needs to be freed using
3419 * psa_cipher_abort. Indicate this through setting alg. */
3420 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003421 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003422
Steven Cooremand3feccd2020-09-01 15:56:14 +02003423 if( status != PSA_ERROR_NOT_SUPPORTED ||
3424 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3425 goto exit;
3426
Steven Cooremana07b9972020-09-10 14:54:14 +02003427 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003428 * available for the given algorithm & key. */
3429 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003430
Steven Cooremana07b9972020-09-10 14:54:14 +02003431 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003432 * psa_cipher_abort. Indicate there is something to be freed through setting
3433 * alg, and indicate the operation is being done using mbedtls crypto through
3434 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003435 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003436 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02003437
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003438 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02003439 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003440 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003441 {
3442 status = PSA_ERROR_NOT_SUPPORTED;
3443 goto exit;
3444 }
mohammad1603503973b2018-03-12 15:59:30 +02003445
mohammad1603503973b2018-03-12 15:59:30 +02003446 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003447 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003448 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003449
David Brown12ca5032021-02-11 11:02:00 -07003450#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003451 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003452 {
3453 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003454 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01003455 memcpy( keys, slot->key.data, 16 );
3456 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003457 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3458 keys,
3459 192, cipher_operation );
3460 }
3461 else
3462#endif
3463 {
3464 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003465 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003466 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003467 }
Moran Peker41deec42018-04-04 15:43:05 +03003468 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003469 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003470
David Brown63ca2602021-01-26 11:51:12 -07003471#if defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
3472 defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003473 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003474 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003475 case PSA_ALG_CBC_NO_PADDING:
3476 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3477 MBEDTLS_PADDING_NONE );
3478 break;
3479 case PSA_ALG_CBC_PKCS7:
3480 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3481 MBEDTLS_PADDING_PKCS7 );
3482 break;
3483 default:
3484 /* The algorithm doesn't involve padding. */
3485 ret = 0;
3486 break;
3487 }
3488 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003489 goto exit;
David Brown288a96e2021-02-09 16:27:55 -07003490#endif /* MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING || MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7 */
mohammad16038481e742018-03-18 13:57:31 +02003491
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003492 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003493 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02003494 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
3495 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02003496 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003497 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003498 }
David Brown1bfe4d72021-02-16 12:54:35 -07003499#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +02003500 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01003501 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02003502 operation->iv_size = 12;
3503#endif
mohammad1603503973b2018-03-12 15:59:30 +02003504
Steven Cooreman7df02922020-09-09 15:28:49 +02003505 status = PSA_SUCCESS;
3506
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003507exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003508 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003509 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02003510 if( status == PSA_SUCCESS )
3511 {
3512 /* Update operation flags for both driver and software implementations */
3513 operation->key_set = 1;
3514 }
3515 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003516 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003517
Ronald Cron5c522922020-11-14 16:35:34 +01003518 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003519
Ronald Cron5c522922020-11-14 16:35:34 +01003520 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003521}
3522
Gilles Peskinefe119512018-07-08 21:39:34 +02003523psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003524 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003525 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003526{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003527 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003528}
3529
Gilles Peskinefe119512018-07-08 21:39:34 +02003530psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003531 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003532 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003533{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003534 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003535}
3536
Gilles Peskinefe119512018-07-08 21:39:34 +02003537psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003538 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003539 size_t iv_size,
3540 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003541{
itayzafrir534bd7c2018-08-02 13:56:32 +03003542 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003544 if( operation->iv_set || ! operation->iv_required )
3545 {
3546 return( PSA_ERROR_BAD_STATE );
3547 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003548
Steven Cooremanef8575e2020-09-11 11:44:50 +02003549 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003550 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003551 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003552 iv,
3553 iv_size,
3554 iv_length );
3555 goto exit;
3556 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003557
Moran Peker41deec42018-04-04 15:43:05 +03003558 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003559 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003560 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003561 goto exit;
3562 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003563 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003564 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003565 if( ret != 0 )
3566 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003567 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003568 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003569 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003570
mohammad16038481e742018-03-18 13:57:31 +02003571 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003572 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003573
Moran Peker395db872018-05-31 14:07:14 +03003574exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003575 if( status == PSA_SUCCESS )
3576 operation->iv_set = 1;
3577 else
Moran Peker395db872018-05-31 14:07:14 +03003578 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003579 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003580}
3581
Gilles Peskinefe119512018-07-08 21:39:34 +02003582psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003583 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003584 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003585{
itayzafrir534bd7c2018-08-02 13:56:32 +03003586 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003587 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003588 if( operation->iv_set || ! operation->iv_required )
3589 {
3590 return( PSA_ERROR_BAD_STATE );
3591 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003592
Steven Cooremanef8575e2020-09-11 11:44:50 +02003593 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003594 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003595 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003596 iv,
3597 iv_length );
3598 goto exit;
3599 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003600
Moran Pekera28258c2018-05-29 16:25:04 +03003601 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003602 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003603 status = PSA_ERROR_INVALID_ARGUMENT;
3604 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003605 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003606 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3607 status = mbedtls_to_psa_error( ret );
3608exit:
3609 if( status == PSA_SUCCESS )
3610 operation->iv_set = 1;
3611 else
mohammad1603503973b2018-03-12 15:59:30 +02003612 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003613 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003614}
3615
Steven Cooreman177deba2020-09-07 17:14:14 +02003616/* Process input for which the algorithm is set to ECB mode. This requires
3617 * manual processing, since the PSA API is defined as being able to process
3618 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
3619 * underlying mbedtls_cipher_update only takes full blocks. */
3620static psa_status_t psa_cipher_update_ecb_internal(
3621 mbedtls_cipher_context_t *ctx,
3622 const uint8_t *input,
3623 size_t input_length,
3624 uint8_t *output,
3625 size_t output_size,
3626 size_t *output_length )
3627{
3628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3629 size_t block_size = ctx->cipher_info->block_size;
3630 size_t internal_output_length = 0;
3631 *output_length = 0;
3632
3633 if( input_length == 0 )
3634 {
3635 status = PSA_SUCCESS;
3636 goto exit;
3637 }
3638
3639 if( ctx->unprocessed_len > 0 )
3640 {
3641 /* Fill up to block size, and run the block if there's a full one. */
3642 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
3643
3644 if( input_length < bytes_to_copy )
3645 bytes_to_copy = input_length;
3646
3647 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3648 input, bytes_to_copy );
3649 input_length -= bytes_to_copy;
3650 input += bytes_to_copy;
3651 ctx->unprocessed_len += bytes_to_copy;
3652
3653 if( ctx->unprocessed_len == block_size )
3654 {
3655 status = mbedtls_to_psa_error(
3656 mbedtls_cipher_update( ctx,
3657 ctx->unprocessed_data,
3658 block_size,
3659 output, &internal_output_length ) );
3660
3661 if( status != PSA_SUCCESS )
3662 goto exit;
3663
3664 output += internal_output_length;
3665 output_size -= internal_output_length;
3666 *output_length += internal_output_length;
3667 ctx->unprocessed_len = 0;
3668 }
3669 }
3670
3671 while( input_length >= block_size )
3672 {
3673 /* Run all full blocks we have, one by one */
3674 status = mbedtls_to_psa_error(
3675 mbedtls_cipher_update( ctx, input,
3676 block_size,
3677 output, &internal_output_length ) );
3678
3679 if( status != PSA_SUCCESS )
3680 goto exit;
3681
3682 input_length -= block_size;
3683 input += block_size;
3684
3685 output += internal_output_length;
3686 output_size -= internal_output_length;
3687 *output_length += internal_output_length;
3688 }
3689
3690 if( input_length > 0 )
3691 {
3692 /* Save unprocessed bytes for later processing */
3693 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3694 input, input_length );
3695 ctx->unprocessed_len += input_length;
3696 }
3697
3698 status = PSA_SUCCESS;
3699
3700exit:
3701 return( status );
3702}
3703
Gilles Peskinee553c652018-06-04 16:22:46 +02003704psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3705 const uint8_t *input,
3706 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003707 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003708 size_t output_size,
3709 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003710{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003711 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003712 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02003713 if( operation->alg == 0 )
3714 {
3715 return( PSA_ERROR_BAD_STATE );
3716 }
3717 if( operation->iv_required && ! operation->iv_set )
3718 {
3719 return( PSA_ERROR_BAD_STATE );
3720 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003721
Steven Cooremanef8575e2020-09-11 11:44:50 +02003722 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003723 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003724 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003725 input,
3726 input_length,
3727 output,
3728 output_size,
3729 output_length );
3730 goto exit;
3731 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003732
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003733 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003734 {
3735 /* Take the unprocessed partial block left over from previous
3736 * update calls, if any, plus the input to this call. Remove
3737 * the last partial block, if any. You get the data that will be
3738 * output in this call. */
3739 expected_output_size =
3740 ( operation->ctx.cipher.unprocessed_len + input_length )
3741 / operation->block_size * operation->block_size;
3742 }
3743 else
3744 {
3745 expected_output_size = input_length;
3746 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003747
Gilles Peskine89d789c2018-06-04 17:17:16 +02003748 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003749 {
3750 status = PSA_ERROR_BUFFER_TOO_SMALL;
3751 goto exit;
3752 }
mohammad160382759612018-03-12 18:16:40 +02003753
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003754 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
3755 {
3756 /* mbedtls_cipher_update has an API inconsistency: it will only
3757 * process a single block at a time in ECB mode. Abstract away that
3758 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02003759 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
3760 input,
3761 input_length,
3762 output,
3763 output_size,
3764 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003765 }
3766 else
3767 {
3768 status = mbedtls_to_psa_error(
3769 mbedtls_cipher_update( &operation->ctx.cipher, input,
3770 input_length, output, output_length ) );
3771 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003772exit:
3773 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003774 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003775 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003776}
3777
Gilles Peskinee553c652018-06-04 16:22:46 +02003778psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3779 uint8_t *output,
3780 size_t output_size,
3781 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003782{
David Saadab4ecc272019-02-14 13:48:10 +02003783 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02003784 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02003785 if( operation->alg == 0 )
3786 {
3787 return( PSA_ERROR_BAD_STATE );
3788 }
3789 if( operation->iv_required && ! operation->iv_set )
3790 {
3791 return( PSA_ERROR_BAD_STATE );
3792 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003793
Steven Cooremanef8575e2020-09-11 11:44:50 +02003794 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003795 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003796 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003797 output,
3798 output_size,
3799 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003800 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02003801 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003802
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003803 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003804 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003805 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02003806 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02003807 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003808 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003809 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003810 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003811 }
3812
Steven Cooremanef8575e2020-09-11 11:44:50 +02003813 status = mbedtls_to_psa_error(
3814 mbedtls_cipher_finish( &operation->ctx.cipher,
3815 temp_output_buffer,
3816 output_length ) );
3817 if( status != PSA_SUCCESS )
3818 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01003819
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003820 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003821 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003822 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003823 memcpy( output, temp_output_buffer, *output_length );
3824 else
Janos Follath315b51c2018-07-09 16:04:51 +01003825 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02003826
Steven Cooremanef8575e2020-09-11 11:44:50 +02003827exit:
3828 if( operation->mbedtls_in_use == 1 )
3829 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003830
Steven Cooremanef8575e2020-09-11 11:44:50 +02003831 if( status == PSA_SUCCESS )
3832 return( psa_cipher_abort( operation ) );
3833 else
3834 {
3835 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003836 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003837
Steven Cooremanef8575e2020-09-11 11:44:50 +02003838 return( status );
3839 }
mohammad1603503973b2018-03-12 15:59:30 +02003840}
3841
Gilles Peskinee553c652018-06-04 16:22:46 +02003842psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3843{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003844 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003845 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003846 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003847 * in use. It's ok to call abort on such an object, and there's
3848 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003849 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003850 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003851
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003852 /* Sanity check (shouldn't happen: operation->alg should
3853 * always have been initialized to a valid value). */
3854 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3855 return( PSA_ERROR_BAD_STATE );
3856
Steven Cooremanef8575e2020-09-11 11:44:50 +02003857 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003858 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003859 else
3860 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003861
Moran Peker41deec42018-04-04 15:43:05 +03003862 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003863 operation->key_set = 0;
3864 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003865 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003866 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003867 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003868 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003869
Moran Peker395db872018-05-31 14:07:14 +03003870 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003871}
3872
Gilles Peskinea0655c32018-04-30 17:06:50 +02003873
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003874
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003875
mohammad16035955c982018-04-26 00:53:03 +03003876/****************************************************************/
3877/* AEAD */
3878/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003879
Gilles Peskineedf9a652018-08-17 18:11:56 +02003880typedef struct
3881{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003882 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003883 const mbedtls_cipher_info_t *cipher_info;
3884 union
3885 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003886 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003887#if defined(MBEDTLS_CCM_C)
3888 mbedtls_ccm_context ccm;
3889#endif /* MBEDTLS_CCM_C */
3890#if defined(MBEDTLS_GCM_C)
3891 mbedtls_gcm_context gcm;
3892#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003893#if defined(MBEDTLS_CHACHAPOLY_C)
3894 mbedtls_chachapoly_context chachapoly;
3895#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003896 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003897 psa_algorithm_t core_alg;
3898 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003899 uint8_t tag_length;
3900} aead_operation_t;
3901
Ronald Cronf95a2b12020-10-22 15:24:49 +02003902#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
3903
Gilles Peskine30a9e412019-01-14 18:36:12 +01003904static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003905{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003906 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003907 {
3908#if defined(MBEDTLS_CCM_C)
3909 case PSA_ALG_CCM:
3910 mbedtls_ccm_free( &operation->ctx.ccm );
3911 break;
3912#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003913#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003914 case PSA_ALG_GCM:
3915 mbedtls_gcm_free( &operation->ctx.gcm );
3916 break;
3917#endif /* MBEDTLS_GCM_C */
3918 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003919
Ronald Cron5c522922020-11-14 16:35:34 +01003920 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003921}
3922
3923static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003924 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003925 psa_key_usage_t usage,
3926 psa_algorithm_t alg )
3927{
3928 psa_status_t status;
3929 size_t key_bits;
3930 mbedtls_cipher_id_t cipher_id;
3931
Ronald Cron5c522922020-11-14 16:35:34 +01003932 status = psa_get_and_lock_transparent_key_slot_with_policy(
3933 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003934 if( status != PSA_SUCCESS )
3935 return( status );
3936
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003937 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003938
3939 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003940 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003941 &cipher_id );
3942 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003943 {
3944 status = PSA_ERROR_NOT_SUPPORTED;
3945 goto cleanup;
3946 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003947
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003948 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003949 {
3950#if defined(MBEDTLS_CCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003951 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003952 operation->core_alg = PSA_ALG_CCM;
3953 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003954 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3955 * The call to mbedtls_ccm_encrypt_and_tag or
3956 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003957 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003958 {
3959 status = PSA_ERROR_INVALID_ARGUMENT;
3960 goto cleanup;
3961 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003962 mbedtls_ccm_init( &operation->ctx.ccm );
3963 status = mbedtls_to_psa_error(
3964 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003965 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003966 (unsigned int) key_bits ) );
3967 if( status != 0 )
3968 goto cleanup;
3969 break;
3970#endif /* MBEDTLS_CCM_C */
3971
3972#if defined(MBEDTLS_GCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003973 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003974 operation->core_alg = PSA_ALG_GCM;
3975 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003976 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3977 * The call to mbedtls_gcm_crypt_and_tag or
3978 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003979 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003980 {
3981 status = PSA_ERROR_INVALID_ARGUMENT;
3982 goto cleanup;
3983 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003984 mbedtls_gcm_init( &operation->ctx.gcm );
3985 status = mbedtls_to_psa_error(
3986 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003987 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003988 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003989 if( status != 0 )
3990 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003991 break;
3992#endif /* MBEDTLS_GCM_C */
3993
Gilles Peskine26869f22019-05-06 15:25:00 +02003994#if defined(MBEDTLS_CHACHAPOLY_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003995 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02003996 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3997 operation->full_tag_length = 16;
3998 /* We only support the default tag length. */
3999 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004000 {
4001 status = PSA_ERROR_NOT_SUPPORTED;
4002 goto cleanup;
4003 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004004 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4005 status = mbedtls_to_psa_error(
4006 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004007 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004008 if( status != 0 )
4009 goto cleanup;
4010 break;
4011#endif /* MBEDTLS_CHACHAPOLY_C */
4012
Gilles Peskineedf9a652018-08-17 18:11:56 +02004013 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004014 status = PSA_ERROR_NOT_SUPPORTED;
4015 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004016 }
4017
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004018 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4019 {
4020 status = PSA_ERROR_INVALID_ARGUMENT;
4021 goto cleanup;
4022 }
4023 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004024
Gilles Peskineedf9a652018-08-17 18:11:56 +02004025 return( PSA_SUCCESS );
4026
4027cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004028 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004029 return( status );
4030}
4031
Ronald Croncf56a0a2020-08-04 09:51:30 +02004032psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004033 psa_algorithm_t alg,
4034 const uint8_t *nonce,
4035 size_t nonce_length,
4036 const uint8_t *additional_data,
4037 size_t additional_data_length,
4038 const uint8_t *plaintext,
4039 size_t plaintext_length,
4040 uint8_t *ciphertext,
4041 size_t ciphertext_size,
4042 size_t *ciphertext_length )
4043{
mohammad16035955c982018-04-26 00:53:03 +03004044 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004045 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004046 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004047
mohammad1603f08a5502018-06-03 15:05:47 +03004048 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004049
Ronald Croncf56a0a2020-08-04 09:51:30 +02004050 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004051 if( status != PSA_SUCCESS )
4052 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004053
Gilles Peskineedf9a652018-08-17 18:11:56 +02004054 /* For all currently supported modes, the tag is at the end of the
4055 * ciphertext. */
4056 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4057 {
4058 status = PSA_ERROR_BUFFER_TOO_SMALL;
4059 goto exit;
4060 }
4061 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004062
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004063#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004064 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004065 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004066 status = mbedtls_to_psa_error(
4067 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4068 MBEDTLS_GCM_ENCRYPT,
4069 plaintext_length,
4070 nonce, nonce_length,
4071 additional_data, additional_data_length,
4072 plaintext, ciphertext,
4073 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004074 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004075 else
4076#endif /* MBEDTLS_GCM_C */
4077#if defined(MBEDTLS_CCM_C)
4078 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004079 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004080 status = mbedtls_to_psa_error(
4081 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4082 plaintext_length,
4083 nonce, nonce_length,
4084 additional_data,
4085 additional_data_length,
4086 plaintext, ciphertext,
4087 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004088 }
mohammad16035c8845f2018-05-09 05:40:09 -07004089 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004090#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004091#if defined(MBEDTLS_CHACHAPOLY_C)
4092 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4093 {
4094 if( nonce_length != 12 || operation.tag_length != 16 )
4095 {
4096 status = PSA_ERROR_NOT_SUPPORTED;
4097 goto exit;
4098 }
4099 status = mbedtls_to_psa_error(
4100 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4101 plaintext_length,
4102 nonce,
4103 additional_data,
4104 additional_data_length,
4105 plaintext,
4106 ciphertext,
4107 tag ) );
4108 }
4109 else
4110#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004111 {
Steven Cooreman7196fef2021-02-10 17:13:28 +01004112 (void) tag;
mohammad1603554faad2018-06-03 15:07:38 +03004113 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004114 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004115
Gilles Peskineedf9a652018-08-17 18:11:56 +02004116 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4117 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004118
Gilles Peskineedf9a652018-08-17 18:11:56 +02004119exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004120 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004121 if( status == PSA_SUCCESS )
4122 *ciphertext_length = plaintext_length + operation.tag_length;
4123 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004124}
4125
Gilles Peskineee652a32018-06-01 19:23:52 +02004126/* Locate the tag in a ciphertext buffer containing the encrypted data
4127 * followed by the tag. Return the length of the part preceding the tag in
4128 * *plaintext_length. This is the size of the plaintext in modes where
4129 * the encrypted data has the same size as the plaintext, such as
4130 * CCM and GCM. */
4131static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4132 const uint8_t *ciphertext,
4133 size_t ciphertext_length,
4134 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004135 const uint8_t **p_tag )
4136{
4137 size_t payload_length;
4138 if( tag_length > ciphertext_length )
4139 return( PSA_ERROR_INVALID_ARGUMENT );
4140 payload_length = ciphertext_length - tag_length;
4141 if( payload_length > plaintext_size )
4142 return( PSA_ERROR_BUFFER_TOO_SMALL );
4143 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004144 return( PSA_SUCCESS );
4145}
4146
Ronald Croncf56a0a2020-08-04 09:51:30 +02004147psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004148 psa_algorithm_t alg,
4149 const uint8_t *nonce,
4150 size_t nonce_length,
4151 const uint8_t *additional_data,
4152 size_t additional_data_length,
4153 const uint8_t *ciphertext,
4154 size_t ciphertext_length,
4155 uint8_t *plaintext,
4156 size_t plaintext_size,
4157 size_t *plaintext_length )
4158{
mohammad16035955c982018-04-26 00:53:03 +03004159 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004160 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004161 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004162
Gilles Peskineee652a32018-06-01 19:23:52 +02004163 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004164
Ronald Croncf56a0a2020-08-04 09:51:30 +02004165 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004166 if( status != PSA_SUCCESS )
4167 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004168
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004169 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4170 ciphertext, ciphertext_length,
4171 plaintext_size, &tag );
4172 if( status != PSA_SUCCESS )
4173 goto exit;
4174
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004175#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004176 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004177 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004178 status = mbedtls_to_psa_error(
4179 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4180 ciphertext_length - operation.tag_length,
4181 nonce, nonce_length,
4182 additional_data,
4183 additional_data_length,
4184 tag, operation.tag_length,
4185 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004186 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004187 else
4188#endif /* MBEDTLS_GCM_C */
4189#if defined(MBEDTLS_CCM_C)
4190 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004191 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004192 status = mbedtls_to_psa_error(
4193 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4194 ciphertext_length - operation.tag_length,
4195 nonce, nonce_length,
4196 additional_data,
4197 additional_data_length,
4198 ciphertext, plaintext,
4199 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004200 }
mohammad160339574652018-06-01 04:39:53 -07004201 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004202#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004203#if defined(MBEDTLS_CHACHAPOLY_C)
4204 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4205 {
4206 if( nonce_length != 12 || operation.tag_length != 16 )
4207 {
4208 status = PSA_ERROR_NOT_SUPPORTED;
4209 goto exit;
4210 }
4211 status = mbedtls_to_psa_error(
4212 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4213 ciphertext_length - operation.tag_length,
4214 nonce,
4215 additional_data,
4216 additional_data_length,
4217 tag,
4218 ciphertext,
4219 plaintext ) );
4220 }
4221 else
4222#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004223 {
mohammad1603554faad2018-06-03 15:07:38 +03004224 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004225 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004226
Gilles Peskineedf9a652018-08-17 18:11:56 +02004227 if( status != PSA_SUCCESS && plaintext_size != 0 )
4228 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004229
Gilles Peskineedf9a652018-08-17 18:11:56 +02004230exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004231 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004232 if( status == PSA_SUCCESS )
4233 *plaintext_length = ciphertext_length - operation.tag_length;
4234 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004235}
4236
Gilles Peskinea0655c32018-04-30 17:06:50 +02004237
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004238
Gilles Peskinee59236f2018-01-27 23:32:46 +01004239/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004240/* Generators */
4241/****************************************************************/
4242
John Durkop07cc04a2020-11-16 22:08:34 -08004243#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4244 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4245 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4246#define AT_LEAST_ONE_BUILTIN_KDF
4247#endif
4248
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004249#define HKDF_STATE_INIT 0 /* no input yet */
4250#define HKDF_STATE_STARTED 1 /* got salt */
4251#define HKDF_STATE_KEYED 2 /* got key */
4252#define HKDF_STATE_OUTPUT 3 /* output started */
4253
Gilles Peskinecbe66502019-05-16 16:59:18 +02004254static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004255 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004256{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004257 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4258 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004259 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004260 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004261}
4262
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004263psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004264{
4265 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004266 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004267 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004268 {
4269 /* The object has (apparently) been initialized but it is not
4270 * in use. It's ok to call abort on such an object, and there's
4271 * nothing to do. */
4272 }
4273 else
John Durkopd0321952020-10-29 21:37:36 -07004274#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004275 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004276 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004277 mbedtls_free( operation->ctx.hkdf.info );
4278 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004279 }
John Durkop07cc04a2020-11-16 22:08:34 -08004280 else
4281#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4282#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4283 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4284 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004285 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004286 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004287 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004288 if( operation->ctx.tls12_prf.seed != NULL )
4289 {
4290 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4291 operation->ctx.tls12_prf.seed_length );
4292 mbedtls_free( operation->ctx.tls12_prf.seed );
4293 }
4294
4295 if( operation->ctx.tls12_prf.label != NULL )
4296 {
4297 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4298 operation->ctx.tls12_prf.label_length );
4299 mbedtls_free( operation->ctx.tls12_prf.label );
4300 }
4301
4302 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4303
4304 /* We leave the fields Ai and output_block to be erased safely by the
4305 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004306 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004307 else
John Durkop07cc04a2020-11-16 22:08:34 -08004308#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4309 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004310 {
4311 status = PSA_ERROR_BAD_STATE;
4312 }
Janos Follath083036a2019-06-11 10:22:26 +01004313 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004314 return( status );
4315}
4316
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004317psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004318 size_t *capacity)
4319{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004320 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004321 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004322 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004323 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004324 }
4325
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004326 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004327 return( PSA_SUCCESS );
4328}
4329
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004330psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004331 size_t capacity )
4332{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004333 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004334 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004335 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004336 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004337 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004338 return( PSA_SUCCESS );
4339}
4340
John Durkopd0321952020-10-29 21:37:36 -07004341#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004342/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004343 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004344static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004345 psa_algorithm_t hash_alg,
4346 uint8_t *output,
4347 size_t output_length )
4348{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004349 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004350 psa_status_t status;
4351
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004352 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4353 return( PSA_ERROR_BAD_STATE );
4354 hkdf->state = HKDF_STATE_OUTPUT;
4355
Gilles Peskinebef7f142018-07-12 17:22:21 +02004356 while( output_length != 0 )
4357 {
4358 /* Copy what remains of the current block */
4359 uint8_t n = hash_length - hkdf->offset_in_block;
4360 if( n > output_length )
4361 n = (uint8_t) output_length;
4362 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4363 output += n;
4364 output_length -= n;
4365 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004366 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004367 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004368 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004369 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004370 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004371 * object was corrupted or if this function is called directly
4372 * inside the library. */
4373 if( hkdf->block_number == 0xff )
4374 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004375
4376 /* We need a new block */
4377 ++hkdf->block_number;
4378 hkdf->offset_in_block = 0;
4379 status = psa_hmac_setup_internal( &hkdf->hmac,
4380 hkdf->prk, hash_length,
4381 hash_alg );
4382 if( status != PSA_SUCCESS )
4383 return( status );
4384 if( hkdf->block_number != 1 )
4385 {
4386 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4387 hkdf->output_block,
4388 hash_length );
4389 if( status != PSA_SUCCESS )
4390 return( status );
4391 }
4392 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4393 hkdf->info,
4394 hkdf->info_length );
4395 if( status != PSA_SUCCESS )
4396 return( status );
4397 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4398 &hkdf->block_number, 1 );
4399 if( status != PSA_SUCCESS )
4400 return( status );
4401 status = psa_hmac_finish_internal( &hkdf->hmac,
4402 hkdf->output_block,
4403 sizeof( hkdf->output_block ) );
4404 if( status != PSA_SUCCESS )
4405 return( status );
4406 }
4407
4408 return( PSA_SUCCESS );
4409}
John Durkop07cc04a2020-11-16 22:08:34 -08004410#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004411
John Durkop07cc04a2020-11-16 22:08:34 -08004412#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4413 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004414static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4415 psa_tls12_prf_key_derivation_t *tls12_prf,
4416 psa_algorithm_t alg )
4417{
4418 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004419 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004420 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4421 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004422
Janos Follath7742fee2019-06-17 12:58:10 +01004423 /* We can't be wanting more output after block 0xff, otherwise
4424 * the capacity check in psa_key_derivation_output_bytes() would have
4425 * prevented this call. It could happen only if the operation
4426 * object was corrupted or if this function is called directly
4427 * inside the library. */
4428 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004429 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004430
4431 /* We need a new block */
4432 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004433 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004434
4435 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4436 *
4437 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4438 *
4439 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4440 * HMAC_hash(secret, A(2) + seed) +
4441 * HMAC_hash(secret, A(3) + seed) + ...
4442 *
4443 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004444 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004445 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004446 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004447 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004448 * is currently extracted as `output_block` and where i is
4449 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004450 */
4451
Janos Follathea29bfb2019-06-19 12:21:20 +01004452 /* Save the hash context before using it, to preserve the hash state with
4453 * only the inner padding in it. We need this, because inner padding depends
4454 * on the key (secret in the RFC's terminology). */
4455 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4456 if( status != PSA_SUCCESS )
4457 goto cleanup;
4458
4459 /* Calculate A(i) where i = tls12_prf->block_number. */
4460 if( tls12_prf->block_number == 1 )
4461 {
4462 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4463 * the variable seed and in this instance means it in the context of the
4464 * P_hash function, where seed = label + seed.) */
4465 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4466 tls12_prf->label, tls12_prf->label_length );
4467 if( status != PSA_SUCCESS )
4468 goto cleanup;
4469 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4470 tls12_prf->seed, tls12_prf->seed_length );
4471 if( status != PSA_SUCCESS )
4472 goto cleanup;
4473 }
4474 else
4475 {
4476 /* A(i) = HMAC_hash(secret, A(i-1)) */
4477 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4478 tls12_prf->Ai, hash_length );
4479 if( status != PSA_SUCCESS )
4480 goto cleanup;
4481 }
4482
4483 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4484 tls12_prf->Ai, hash_length );
4485 if( status != PSA_SUCCESS )
4486 goto cleanup;
4487 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4488 if( status != PSA_SUCCESS )
4489 goto cleanup;
4490
4491 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4492 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4493 tls12_prf->Ai, hash_length );
4494 if( status != PSA_SUCCESS )
4495 goto cleanup;
4496 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4497 tls12_prf->label, tls12_prf->label_length );
4498 if( status != PSA_SUCCESS )
4499 goto cleanup;
4500 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4501 tls12_prf->seed, tls12_prf->seed_length );
4502 if( status != PSA_SUCCESS )
4503 goto cleanup;
4504 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4505 tls12_prf->output_block, hash_length );
4506 if( status != PSA_SUCCESS )
4507 goto cleanup;
4508 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4509 if( status != PSA_SUCCESS )
4510 goto cleanup;
4511
Janos Follath7742fee2019-06-17 12:58:10 +01004512
4513cleanup:
4514
Janos Follathea29bfb2019-06-19 12:21:20 +01004515 cleanup_status = psa_hash_abort( &backup );
4516 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4517 status = cleanup_status;
4518
4519 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004520}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004521
Janos Follath844eb0e2019-06-19 12:10:49 +01004522static psa_status_t psa_key_derivation_tls12_prf_read(
4523 psa_tls12_prf_key_derivation_t *tls12_prf,
4524 psa_algorithm_t alg,
4525 uint8_t *output,
4526 size_t output_length )
4527{
4528 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004529 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004530 psa_status_t status;
4531 uint8_t offset, length;
4532
4533 while( output_length != 0 )
4534 {
4535 /* Check if we have fully processed the current block. */
4536 if( tls12_prf->left_in_block == 0 )
4537 {
4538 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4539 alg );
4540 if( status != PSA_SUCCESS )
4541 return( status );
4542
4543 continue;
4544 }
4545
4546 if( tls12_prf->left_in_block > output_length )
4547 length = (uint8_t) output_length;
4548 else
4549 length = tls12_prf->left_in_block;
4550
4551 offset = hash_length - tls12_prf->left_in_block;
4552 memcpy( output, tls12_prf->output_block + offset, length );
4553 output += length;
4554 output_length -= length;
4555 tls12_prf->left_in_block -= length;
4556 }
4557
4558 return( PSA_SUCCESS );
4559}
John Durkop07cc04a2020-11-16 22:08:34 -08004560#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4561 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004562
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004563psa_status_t psa_key_derivation_output_bytes(
4564 psa_key_derivation_operation_t *operation,
4565 uint8_t *output,
4566 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004567{
4568 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004569 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004570
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004571 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004572 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004573 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004574 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004575 }
4576
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004577 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004578 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004579 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004580 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004581 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004582 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004583 goto exit;
4584 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004585 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004586 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004587 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004588 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004589 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4590 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004591 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004592 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004593 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004594 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004595 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004596
John Durkopd0321952020-10-29 21:37:36 -07004597#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004598 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004599 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004600 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004601 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004602 output, output_length );
4603 }
Janos Follathadbec812019-06-14 11:05:39 +01004604 else
John Durkop07cc04a2020-11-16 22:08:34 -08004605#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4606#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4607 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004608 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004609 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004610 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004611 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004612 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004613 output_length );
4614 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004615 else
John Durkop07cc04a2020-11-16 22:08:34 -08004616#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4617 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004618 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004619 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004620 return( PSA_ERROR_BAD_STATE );
4621 }
4622
4623exit:
4624 if( status != PSA_SUCCESS )
4625 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004626 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004627 * This allows us to differentiate between exhausted operations and
4628 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4629 * operations. */
4630 psa_algorithm_t alg = operation->alg;
4631 psa_key_derivation_abort( operation );
4632 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004633 memset( output, '!', output_length );
4634 }
4635 return( status );
4636}
4637
David Brown7807bf72021-02-09 16:28:23 -07004638#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004639static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4640{
4641 if( data_size >= 8 )
4642 mbedtls_des_key_set_parity( data );
4643 if( data_size >= 16 )
4644 mbedtls_des_key_set_parity( data + 8 );
4645 if( data_size >= 24 )
4646 mbedtls_des_key_set_parity( data + 16 );
4647}
David Brown7807bf72021-02-09 16:28:23 -07004648#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004649
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004650static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004651 psa_key_slot_t *slot,
4652 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004653 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004654{
4655 uint8_t *data = NULL;
4656 size_t bytes = PSA_BITS_TO_BYTES( bits );
4657 psa_status_t status;
4658
Gilles Peskine8e338702019-07-30 20:06:31 +02004659 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004660 return( PSA_ERROR_INVALID_ARGUMENT );
4661 if( bits % 8 != 0 )
4662 return( PSA_ERROR_INVALID_ARGUMENT );
4663 data = mbedtls_calloc( 1, bytes );
4664 if( data == NULL )
4665 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4666
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004667 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004668 if( status != PSA_SUCCESS )
4669 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004670#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004671 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004672 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004673#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004674
4675 status = psa_allocate_buffer_to_slot( slot, bytes );
4676 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004677 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004678
Ronald Cronbf33c932020-11-28 18:06:53 +01004679 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004680 psa_key_attributes_t attributes = {
4681 .core = slot->attr
4682 };
4683
Ronald Cronbf33c932020-11-28 18:06:53 +01004684 status = psa_driver_wrapper_import_key( &attributes,
4685 data, bytes,
4686 slot->key.data,
4687 slot->key.bytes,
4688 &slot->key.bytes, &bits );
4689 if( bits != slot->attr.bits )
4690 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004691
4692exit:
4693 mbedtls_free( data );
4694 return( status );
4695}
4696
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004697psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004698 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004699 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004700{
4701 psa_status_t status;
4702 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004703 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004704
Ronald Cron81709fc2020-11-14 12:10:32 +01004705 *key = MBEDTLS_SVC_KEY_ID_INIT;
4706
Gilles Peskine0f84d622019-09-12 19:03:13 +02004707 /* Reject any attempt to create a zero-length key so that we don't
4708 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4709 if( psa_get_key_bits( attributes ) == 0 )
4710 return( PSA_ERROR_INVALID_ARGUMENT );
4711
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004712 if( ! operation->can_output_key )
4713 return( PSA_ERROR_NOT_PERMITTED );
4714
Ronald Cron81709fc2020-11-14 12:10:32 +01004715 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4716 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004717#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4718 if( driver != NULL )
4719 {
4720 /* Deriving a key in a secure element is not implemented yet. */
4721 status = PSA_ERROR_NOT_SUPPORTED;
4722 }
4723#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004724 if( status == PSA_SUCCESS )
4725 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004726 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004727 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004728 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004729 }
4730 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004731 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004732 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004733 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004734
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004735 return( status );
4736}
4737
Gilles Peskineeab56e42018-07-12 17:12:33 +02004738
4739
4740/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004741/* Key derivation */
4742/****************************************************************/
4743
Steven Cooreman932ffb72021-02-15 12:14:32 +01004744#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004745static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004746 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004747 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004748{
John Durkop07cc04a2020-11-16 22:08:34 -08004749 int is_kdf_alg_supported;
4750
Janos Follath5fe19732019-06-20 15:09:30 +01004751 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4752 * initialisers for this union leave some bytes unspecified.) */
4753 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4754
Gilles Peskine969c5d62019-01-16 15:53:06 +01004755 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004756#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004757 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4758 is_kdf_alg_supported = 1;
4759 else
4760#endif
4761#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4762 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4763 is_kdf_alg_supported = 1;
4764 else
4765#endif
4766#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4767 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4768 is_kdf_alg_supported = 1;
4769 else
4770#endif
4771 is_kdf_alg_supported = 0;
4772
4773 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004774 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004775 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004776 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004777 if( hash_size == 0 )
4778 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004779 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4780 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004781 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004782 {
4783 return( PSA_ERROR_NOT_SUPPORTED );
4784 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004785 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004786 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004787 }
John Durkop07cc04a2020-11-16 22:08:34 -08004788
4789 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004790}
John Durkop07cc04a2020-11-16 22:08:34 -08004791#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004792
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004793psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004794 psa_algorithm_t alg )
4795{
4796 psa_status_t status;
4797
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004798 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004799 return( PSA_ERROR_BAD_STATE );
4800
Gilles Peskine6843c292019-01-18 16:44:49 +01004801 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4802 return( PSA_ERROR_INVALID_ARGUMENT );
4803 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004804 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004805#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004806 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004807 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004808#else
4809 return( PSA_ERROR_NOT_SUPPORTED );
4810#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004811 }
4812 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4813 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004814#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004815 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004816#else
4817 return( PSA_ERROR_NOT_SUPPORTED );
4818#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004819 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004820 else
4821 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004822
4823 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004824 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004825 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004826}
4827
John Durkopd0321952020-10-29 21:37:36 -07004828#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004829static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004830 psa_algorithm_t hash_alg,
4831 psa_key_derivation_step_t step,
4832 const uint8_t *data,
4833 size_t data_length )
4834{
4835 psa_status_t status;
4836 switch( step )
4837 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004838 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004839 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004840 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004841 status = psa_hmac_setup_internal( &hkdf->hmac,
4842 data, data_length,
4843 hash_alg );
4844 if( status != PSA_SUCCESS )
4845 return( status );
4846 hkdf->state = HKDF_STATE_STARTED;
4847 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004848 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004849 /* If no salt was provided, use an empty salt. */
4850 if( hkdf->state == HKDF_STATE_INIT )
4851 {
4852 status = psa_hmac_setup_internal( &hkdf->hmac,
4853 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004854 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004855 if( status != PSA_SUCCESS )
4856 return( status );
4857 hkdf->state = HKDF_STATE_STARTED;
4858 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004859 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004860 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004861 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4862 data, data_length );
4863 if( status != PSA_SUCCESS )
4864 return( status );
4865 status = psa_hmac_finish_internal( &hkdf->hmac,
4866 hkdf->prk,
4867 sizeof( hkdf->prk ) );
4868 if( status != PSA_SUCCESS )
4869 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004870 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004871 hkdf->block_number = 0;
4872 hkdf->state = HKDF_STATE_KEYED;
4873 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004874 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004875 if( hkdf->state == HKDF_STATE_OUTPUT )
4876 return( PSA_ERROR_BAD_STATE );
4877 if( hkdf->info_set )
4878 return( PSA_ERROR_BAD_STATE );
4879 hkdf->info_length = data_length;
4880 if( data_length != 0 )
4881 {
4882 hkdf->info = mbedtls_calloc( 1, data_length );
4883 if( hkdf->info == NULL )
4884 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4885 memcpy( hkdf->info, data, data_length );
4886 }
4887 hkdf->info_set = 1;
4888 return( PSA_SUCCESS );
4889 default:
4890 return( PSA_ERROR_INVALID_ARGUMENT );
4891 }
4892}
John Durkop07cc04a2020-11-16 22:08:34 -08004893#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004894
John Durkop07cc04a2020-11-16 22:08:34 -08004895#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4896 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004897static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4898 const uint8_t *data,
4899 size_t data_length )
4900{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004901 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004902 return( PSA_ERROR_BAD_STATE );
4903
Janos Follathd6dce9f2019-07-04 09:11:38 +01004904 if( data_length != 0 )
4905 {
4906 prf->seed = mbedtls_calloc( 1, data_length );
4907 if( prf->seed == NULL )
4908 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004909
Janos Follathd6dce9f2019-07-04 09:11:38 +01004910 memcpy( prf->seed, data, data_length );
4911 prf->seed_length = data_length;
4912 }
Janos Follathf08e2652019-06-13 09:05:41 +01004913
Gilles Peskine43f958b2020-12-13 14:55:14 +01004914 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004915
4916 return( PSA_SUCCESS );
4917}
4918
Janos Follath81550542019-06-13 14:26:34 +01004919static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4920 psa_algorithm_t hash_alg,
4921 const uint8_t *data,
4922 size_t data_length )
4923{
4924 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004925 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004926 return( PSA_ERROR_BAD_STATE );
4927
4928 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4929 if( status != PSA_SUCCESS )
4930 return( status );
4931
Gilles Peskine43f958b2020-12-13 14:55:14 +01004932 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004933
4934 return( PSA_SUCCESS );
4935}
4936
Janos Follath63028dd2019-06-13 09:15:47 +01004937static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4938 const uint8_t *data,
4939 size_t data_length )
4940{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004941 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004942 return( PSA_ERROR_BAD_STATE );
4943
Janos Follathd6dce9f2019-07-04 09:11:38 +01004944 if( data_length != 0 )
4945 {
4946 prf->label = mbedtls_calloc( 1, data_length );
4947 if( prf->label == NULL )
4948 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004949
Janos Follathd6dce9f2019-07-04 09:11:38 +01004950 memcpy( prf->label, data, data_length );
4951 prf->label_length = data_length;
4952 }
Janos Follath63028dd2019-06-13 09:15:47 +01004953
Gilles Peskine43f958b2020-12-13 14:55:14 +01004954 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004955
4956 return( PSA_SUCCESS );
4957}
4958
Janos Follathb03233e2019-06-11 15:30:30 +01004959static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4960 psa_algorithm_t hash_alg,
4961 psa_key_derivation_step_t step,
4962 const uint8_t *data,
4963 size_t data_length )
4964{
Janos Follathb03233e2019-06-11 15:30:30 +01004965 switch( step )
4966 {
Janos Follathf08e2652019-06-13 09:05:41 +01004967 case PSA_KEY_DERIVATION_INPUT_SEED:
4968 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004969 case PSA_KEY_DERIVATION_INPUT_SECRET:
4970 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004971 case PSA_KEY_DERIVATION_INPUT_LABEL:
4972 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004973 default:
4974 return( PSA_ERROR_INVALID_ARGUMENT );
4975 }
4976}
John Durkop07cc04a2020-11-16 22:08:34 -08004977#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4978 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4979
4980#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4981static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4982 psa_tls12_prf_key_derivation_t *prf,
4983 psa_algorithm_t hash_alg,
4984 const uint8_t *data,
4985 size_t data_length )
4986{
4987 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004988 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004989 uint8_t *cur = pms;
4990
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004991 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004992 return( PSA_ERROR_INVALID_ARGUMENT );
4993
4994 /* Quoting RFC 4279, Section 2:
4995 *
4996 * The premaster secret is formed as follows: if the PSK is N octets
4997 * long, concatenate a uint16 with the value N, N zero octets, a second
4998 * uint16 with the value N, and the PSK itself.
4999 */
5000
5001 *cur++ = ( data_length >> 8 ) & 0xff;
5002 *cur++ = ( data_length >> 0 ) & 0xff;
5003 memset( cur, 0, data_length );
5004 cur += data_length;
5005 *cur++ = pms[0];
5006 *cur++ = pms[1];
5007 memcpy( cur, data, data_length );
5008 cur += data_length;
5009
5010 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5011
5012 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5013 return( status );
5014}
Janos Follath6660f0e2019-06-17 08:44:03 +01005015
5016static psa_status_t psa_tls12_prf_psk_to_ms_input(
5017 psa_tls12_prf_key_derivation_t *prf,
5018 psa_algorithm_t hash_alg,
5019 psa_key_derivation_step_t step,
5020 const uint8_t *data,
5021 size_t data_length )
5022{
5023 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005024 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005025 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5026 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005027 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005028
5029 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5030}
John Durkop07cc04a2020-11-16 22:08:34 -08005031#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005032
Gilles Peskineb8965192019-09-24 16:21:10 +02005033/** Check whether the given key type is acceptable for the given
5034 * input step of a key derivation.
5035 *
5036 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5037 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5038 * Both secret and non-secret inputs can alternatively have the type
5039 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5040 * that the input was passed as a buffer rather than via a key object.
5041 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005042static int psa_key_derivation_check_input_type(
5043 psa_key_derivation_step_t step,
5044 psa_key_type_t key_type )
5045{
5046 switch( step )
5047 {
5048 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005049 if( key_type == PSA_KEY_TYPE_DERIVE )
5050 return( PSA_SUCCESS );
5051 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005052 return( PSA_SUCCESS );
5053 break;
5054 case PSA_KEY_DERIVATION_INPUT_LABEL:
5055 case PSA_KEY_DERIVATION_INPUT_SALT:
5056 case PSA_KEY_DERIVATION_INPUT_INFO:
5057 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005058 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5059 return( PSA_SUCCESS );
5060 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005061 return( PSA_SUCCESS );
5062 break;
5063 }
5064 return( PSA_ERROR_INVALID_ARGUMENT );
5065}
5066
Janos Follathb80a94e2019-06-12 15:54:46 +01005067static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005068 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005069 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005070 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005071 const uint8_t *data,
5072 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005073{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005074 psa_status_t status;
5075 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5076
5077 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005078 if( status != PSA_SUCCESS )
5079 goto exit;
5080
John Durkopd0321952020-10-29 21:37:36 -07005081#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005082 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005083 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005084 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005085 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005086 step, data, data_length );
5087 }
John Durkop07cc04a2020-11-16 22:08:34 -08005088 else
5089#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5090#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5091 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005092 {
Janos Follathb03233e2019-06-11 15:30:30 +01005093 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5094 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5095 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005096 }
John Durkop07cc04a2020-11-16 22:08:34 -08005097 else
5098#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5099#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5100 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005101 {
5102 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5103 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5104 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005105 }
5106 else
John Durkop07cc04a2020-11-16 22:08:34 -08005107#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005108 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005109 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005110 (void) data;
5111 (void) data_length;
5112 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005113 return( PSA_ERROR_BAD_STATE );
5114 }
5115
Gilles Peskine224b0d62019-09-23 18:13:17 +02005116exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005117 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005118 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005119 return( status );
5120}
5121
Janos Follath51f4a0f2019-06-14 11:35:55 +01005122psa_status_t psa_key_derivation_input_bytes(
5123 psa_key_derivation_operation_t *operation,
5124 psa_key_derivation_step_t step,
5125 const uint8_t *data,
5126 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005127{
Gilles Peskineb8965192019-09-24 16:21:10 +02005128 return( psa_key_derivation_input_internal( operation, step,
5129 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005130 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005131}
5132
Janos Follath51f4a0f2019-06-14 11:35:55 +01005133psa_status_t psa_key_derivation_input_key(
5134 psa_key_derivation_operation_t *operation,
5135 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005136 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005137{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005138 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005139 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005140 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005141
Ronald Cron5c522922020-11-14 16:35:34 +01005142 status = psa_get_and_lock_transparent_key_slot_with_policy(
5143 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005144 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005145 {
5146 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005147 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005148 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005149
5150 /* Passing a key object as a SECRET input unlocks the permission
5151 * to output to a key object. */
5152 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5153 operation->can_output_key = 1;
5154
Ronald Cronf95a2b12020-10-22 15:24:49 +02005155 status = psa_key_derivation_input_internal( operation,
5156 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005157 slot->key.data,
5158 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005159
Ronald Cron5c522922020-11-14 16:35:34 +01005160 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005161
Ronald Cron5c522922020-11-14 16:35:34 +01005162 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005163}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005164
5165
5166
5167/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005168/* Key agreement */
5169/****************************************************************/
5170
John Durkop6ba40d12020-11-10 08:50:04 -08005171#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005172static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5173 size_t peer_key_length,
5174 const mbedtls_ecp_keypair *our_key,
5175 uint8_t *shared_secret,
5176 size_t shared_secret_size,
5177 size_t *shared_secret_length )
5178{
Steven Cooremand4867872020-08-05 16:31:39 +02005179 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005180 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005181 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005182 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005183 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005184 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005185
Ronald Cron90857082020-11-25 14:58:33 +01005186 status = mbedtls_psa_ecp_load_representation(
5187 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005188 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005189 peer_key,
5190 peer_key_length,
5191 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005192 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005193 goto exit;
5194
Jaeden Amero97271b32019-01-10 19:38:51 +00005195 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005196 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005197 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005198 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005199 status = mbedtls_to_psa_error(
5200 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5201 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005202 goto exit;
5203
Jaeden Amero97271b32019-01-10 19:38:51 +00005204 status = mbedtls_to_psa_error(
5205 mbedtls_ecdh_calc_secret( &ecdh,
5206 shared_secret_length,
5207 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005208 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005209 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005210 if( status != PSA_SUCCESS )
5211 goto exit;
5212 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5213 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005214
5215exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005216 if( status != PSA_SUCCESS )
5217 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005218 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005219 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005220 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005221
Jaeden Amero97271b32019-01-10 19:38:51 +00005222 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005223}
John Durkop6ba40d12020-11-10 08:50:04 -08005224#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005225
Gilles Peskine01d718c2018-09-18 12:01:02 +02005226#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5227
Gilles Peskine0216fe12019-04-11 21:23:21 +02005228static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5229 psa_key_slot_t *private_key,
5230 const uint8_t *peer_key,
5231 size_t peer_key_length,
5232 uint8_t *shared_secret,
5233 size_t shared_secret_size,
5234 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005235{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005236 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005237 {
John Durkop6ba40d12020-11-10 08:50:04 -08005238#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005239 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005240 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005241 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005242 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005243 psa_status_t status = mbedtls_psa_ecp_load_representation(
5244 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005245 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005246 private_key->key.data,
5247 private_key->key.bytes,
5248 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005249 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005250 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005251 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005252 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005253 shared_secret, shared_secret_size,
5254 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005255 mbedtls_ecp_keypair_free( ecp );
5256 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005257 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005258#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005259 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005260 (void) private_key;
5261 (void) peer_key;
5262 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005263 (void) shared_secret;
5264 (void) shared_secret_size;
5265 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005266 return( PSA_ERROR_NOT_SUPPORTED );
5267 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005268}
5269
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005270/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005271 * to potentially free embedded data structures and wipe confidential data.
5272 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005273static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005274 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005275 psa_key_slot_t *private_key,
5276 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005277 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005278{
5279 psa_status_t status;
5280 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5281 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005283
5284 /* Step 1: run the secret agreement algorithm to generate the shared
5285 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005286 status = psa_key_agreement_raw_internal( ka_alg,
5287 private_key,
5288 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005289 shared_secret,
5290 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005291 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005292 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005293 goto exit;
5294
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005295 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005296 * the shared secret. A shared secret is permitted wherever a key
5297 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005298 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005299 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005300 shared_secret,
5301 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005302exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005303 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005304 return( status );
5305}
5306
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005307psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005308 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005309 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005310 const uint8_t *peer_key,
5311 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005312{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005313 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005314 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005315 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005316
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005317 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005318 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005319 status = psa_get_and_lock_transparent_key_slot_with_policy(
5320 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005321 if( status != PSA_SUCCESS )
5322 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005323 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005324 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005325 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005326 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005327 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005328 else
5329 {
5330 /* If a private key has been added as SECRET, we allow the derived
5331 * key material to be used as a key in PSA Crypto. */
5332 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5333 operation->can_output_key = 1;
5334 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005335
Ronald Cron5c522922020-11-14 16:35:34 +01005336 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005337
Ronald Cron5c522922020-11-14 16:35:34 +01005338 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005339}
5340
Gilles Peskinebe697d82019-05-16 18:00:41 +02005341psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005342 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005343 const uint8_t *peer_key,
5344 size_t peer_key_length,
5345 uint8_t *output,
5346 size_t output_size,
5347 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005348{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005350 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005351 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005352
5353 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5354 {
5355 status = PSA_ERROR_INVALID_ARGUMENT;
5356 goto exit;
5357 }
Ronald Cron5c522922020-11-14 16:35:34 +01005358 status = psa_get_and_lock_transparent_key_slot_with_policy(
5359 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005360 if( status != PSA_SUCCESS )
5361 goto exit;
5362
5363 status = psa_key_agreement_raw_internal( alg, slot,
5364 peer_key, peer_key_length,
5365 output, output_size,
5366 output_length );
5367
5368exit:
5369 if( status != PSA_SUCCESS )
5370 {
5371 /* If an error happens and is not handled properly, the output
5372 * may be used as a key to protect sensitive data. Arrange for such
5373 * a key to be random, which is likely to result in decryption or
5374 * verification errors. This is better than filling the buffer with
5375 * some constant data such as zeros, which would result in the data
5376 * being protected with a reproducible, easily knowable key.
5377 */
5378 psa_generate_random( output, output_size );
5379 *output_length = output_size;
5380 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005381
Ronald Cron5c522922020-11-14 16:35:34 +01005382 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005383
Ronald Cron5c522922020-11-14 16:35:34 +01005384 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005385}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005386
5387
Gilles Peskine30524eb2020-11-13 17:02:26 +01005388
Gilles Peskine86a440b2018-11-12 18:39:40 +01005389/****************************************************************/
5390/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005391/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005392
Gilles Peskine30524eb2020-11-13 17:02:26 +01005393/** Initialize the PSA random generator.
5394 */
5395static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5396{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005397#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5398 memset( rng, 0, sizeof( *rng ) );
5399#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5400
Gilles Peskine30524eb2020-11-13 17:02:26 +01005401 /* Set default configuration if
5402 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5403 if( rng->entropy_init == NULL )
5404 rng->entropy_init = mbedtls_entropy_init;
5405 if( rng->entropy_free == NULL )
5406 rng->entropy_free = mbedtls_entropy_free;
5407
5408 rng->entropy_init( &rng->entropy );
5409#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5410 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5411 /* The PSA entropy injection feature depends on using NV seed as an entropy
5412 * source. Add NV seed as an entropy source for PSA entropy injection. */
5413 mbedtls_entropy_add_source( &rng->entropy,
5414 mbedtls_nv_seed_poll, NULL,
5415 MBEDTLS_ENTROPY_BLOCK_SIZE,
5416 MBEDTLS_ENTROPY_SOURCE_STRONG );
5417#endif
5418
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005419 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005420#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005421}
5422
5423/** Deinitialize the PSA random generator.
5424 */
5425static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5426{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005427#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5428 memset( rng, 0, sizeof( *rng ) );
5429#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005430 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005431 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005432#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005433}
5434
5435/** Seed the PSA random generator.
5436 */
5437static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5438{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005439#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5440 /* Do nothing: the external RNG seeds itself. */
5441 (void) rng;
5442 return( PSA_SUCCESS );
5443#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005444 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005445 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5446 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005447 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005448#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005449}
5450
Gilles Peskinee59236f2018-01-27 23:32:46 +01005451psa_status_t psa_generate_random( uint8_t *output,
5452 size_t output_size )
5453{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005454 GUARD_MODULE_INITIALIZED;
5455
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005456#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5457
5458 size_t output_length = 0;
5459 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5460 output, output_size,
5461 &output_length );
5462 if( status != PSA_SUCCESS )
5463 return( status );
5464 /* Breaking up a request into smaller chunks is currently not supported
5465 * for the extrernal RNG interface. */
5466 if( output_length != output_size )
5467 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5468 return( PSA_SUCCESS );
5469
5470#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5471
Gilles Peskine71ddab92021-01-04 21:01:07 +01005472 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005473 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005474 size_t request_size =
5475 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5476 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5477 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005478 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5479 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005480 if( ret != 0 )
5481 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005482 output_size -= request_size;
5483 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005484 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005485 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005486#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005487}
5488
Gilles Peskine8814fc42020-12-14 15:33:44 +01005489/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005490 *
5491 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5492 * `psa_generate_random(...)`. The state parameter is ignored since the
5493 * PSA API doesn't support passing an explicit state.
5494 *
5495 * In the non-external case, psa_generate_random() calls an
5496 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5497 * and semantics as mbedtls_psa_get_random(). As an optimization,
5498 * instead of doing this back-and-forth between the PSA API and the
5499 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5500 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005501 */
5502#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5503int mbedtls_psa_get_random( void *p_rng,
5504 unsigned char *output,
5505 size_t output_size )
5506{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005507 /* This function takes a pointer to the RNG state because that's what
5508 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5509 * its own state internally and doesn't let the caller access that state.
5510 * So we just ignore the state parameter, and in practice we'll pass
5511 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005512 (void) p_rng;
5513 psa_status_t status = psa_generate_random( output, output_size );
5514 if( status == PSA_SUCCESS )
5515 return( 0 );
5516 else
5517 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5518}
5519#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5520
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005521#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5522#include "mbedtls/entropy_poll.h"
5523
Gilles Peskine7228da22019-07-15 11:06:15 +02005524psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005525 size_t seed_size )
5526{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005527 if( global_data.initialized )
5528 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005529
5530 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5531 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5532 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5533 return( PSA_ERROR_INVALID_ARGUMENT );
5534
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005535 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005536}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005537#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005538
Ronald Cron3772afe2021-02-08 16:10:05 +01005539/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005540 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005541 * \param type The key type
5542 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005543 *
5544 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005545 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005546 * \retval #PSA_ERROR_INVALID_ARGUMENT
5547 * The size in bits of the key is not valid.
5548 * \retval #PSA_ERROR_NOT_SUPPORTED
5549 * The type and/or the size in bits of the key or the combination of
5550 * the two is not supported.
5551 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005552static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5553 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005554{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005556
Gilles Peskinee59236f2018-01-27 23:32:46 +01005557 if( key_type_is_raw_bytes( type ) )
5558 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005559 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005560 if( status != PSA_SUCCESS )
5561 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005562 }
5563 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005564#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005565 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5566 {
5567 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5568 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005569
Ronald Cron01b2aba2020-10-05 09:42:02 +02005570 /* Accept only byte-aligned keys, for the same reasons as
5571 * in psa_import_rsa_key(). */
5572 if( bits % 8 != 0 )
5573 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005574 }
5575 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005576#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005577
Ronald Cron5c4d3862020-12-07 11:07:24 +01005578#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005579 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5580 {
Ronald Crond81ab562021-02-16 09:01:16 +01005581 /* To avoid empty block, return successfully here. */
5582 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005583 }
5584 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005585#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005586 {
5587 return( PSA_ERROR_NOT_SUPPORTED );
5588 }
5589
5590 return( PSA_SUCCESS );
5591}
5592
Ronald Cron55ed0592020-10-05 10:30:40 +02005593psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005594 const psa_key_attributes_t *attributes,
5595 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005596{
5597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005598 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005599
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005600 if( ( attributes->domain_parameters == NULL ) &&
5601 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005602 return( PSA_ERROR_INVALID_ARGUMENT );
5603
Ronald Cron01b2aba2020-10-05 09:42:02 +02005604 if( key_type_is_raw_bytes( type ) )
5605 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005606 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005607 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005608 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005609
David Brown12ca5032021-02-11 11:02:00 -07005610#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005611 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005612 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005613#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005614 }
5615 else
5616
John Durkop07cc04a2020-11-16 22:08:34 -08005617#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005618 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005619 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005620 return( mbedtls_psa_rsa_generate_key( attributes,
5621 key_buffer,
5622 key_buffer_size,
5623 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005624 }
5625 else
John Durkop07cc04a2020-11-16 22:08:34 -08005626#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005627
John Durkop9814fa22020-11-04 12:28:15 -08005628#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005629 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005630 {
Ronald Cron7023db52020-11-20 18:17:42 +01005631 return( mbedtls_psa_ecp_generate_key( attributes,
5632 key_buffer,
5633 key_buffer_size,
5634 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005635 }
5636 else
John Durkop9814fa22020-11-04 12:28:15 -08005637#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005638 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005639 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005640 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005641 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005642
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005643 return( PSA_SUCCESS );
5644}
Darryl Green0c6575a2018-11-07 16:05:30 +00005645
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005646psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005647 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005648{
5649 psa_status_t status;
5650 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005651 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005652 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005653
Ronald Cron81709fc2020-11-14 12:10:32 +01005654 *key = MBEDTLS_SVC_KEY_ID_INIT;
5655
Gilles Peskine0f84d622019-09-12 19:03:13 +02005656 /* Reject any attempt to create a zero-length key so that we don't
5657 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5658 if( psa_get_key_bits( attributes ) == 0 )
5659 return( PSA_ERROR_INVALID_ARGUMENT );
5660
Ronald Cron81709fc2020-11-14 12:10:32 +01005661 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5662 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005663 if( status != PSA_SUCCESS )
5664 goto exit;
5665
Ronald Cron977c2472020-10-13 08:32:21 +02005666 /* In the case of a transparent key or an opaque key stored in local
5667 * storage (thus not in the case of generating a key in a secure element
5668 * or cryptoprocessor with storage), we have to allocate a buffer to
5669 * hold the generated key material. */
5670 if( slot->key.data == NULL )
5671 {
5672 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5673 PSA_KEY_LOCATION_LOCAL_STORAGE )
5674 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005675 status = psa_validate_key_type_and_size_for_key_generation(
5676 attributes->core.type, attributes->core.bits );
5677 if( status != PSA_SUCCESS )
5678 goto exit;
5679
5680 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5681 attributes->core.type,
5682 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005683 }
5684 else
5685 {
5686 status = psa_driver_wrapper_get_key_buffer_size(
5687 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005688 if( status != PSA_SUCCESS )
5689 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005690 }
Ronald Cron977c2472020-10-13 08:32:21 +02005691
5692 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5693 if( status != PSA_SUCCESS )
5694 goto exit;
5695 }
5696
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005697 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005698 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005699
Ronald Cron2b56bc82020-10-05 10:02:26 +02005700 if( status != PSA_SUCCESS )
5701 psa_remove_key_data_from_memory( slot );
5702
Gilles Peskine11792082019-08-06 18:36:36 +02005703exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005704 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005705 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005706 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005707 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005708
Darryl Green0c6575a2018-11-07 16:05:30 +00005709 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005710}
5711
Gilles Peskinee59236f2018-01-27 23:32:46 +01005712/****************************************************************/
5713/* Module setup */
5714/****************************************************************/
5715
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005716#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005717psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5718 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5719 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5720{
5721 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5722 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005723 global_data.rng.entropy_init = entropy_init;
5724 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005725 return( PSA_SUCCESS );
5726}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005727#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005728
Gilles Peskinee59236f2018-01-27 23:32:46 +01005729void mbedtls_psa_crypto_free( void )
5730{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005731 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005732 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5733 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005734 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005735 }
5736 /* Wipe all remaining data, including configuration.
5737 * In particular, this sets all state indicator to the value
5738 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005739 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005740#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005741 /* Unregister all secure element drivers, so that we restart from
5742 * a pristine state. */
5743 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005744#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005745}
5746
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005747#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5748/** Recover a transaction that was interrupted by a power failure.
5749 *
5750 * This function is called during initialization, before psa_crypto_init()
5751 * returns. If this function returns a failure status, the initialization
5752 * fails.
5753 */
5754static psa_status_t psa_crypto_recover_transaction(
5755 const psa_crypto_transaction_t *transaction )
5756{
5757 switch( transaction->unknown.type )
5758 {
5759 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5760 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005761 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005762 * is implemented.
5763 * https://github.com/ARMmbed/mbed-crypto/issues/218
5764 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005765 default:
5766 /* We found an unsupported transaction in the storage.
5767 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005768 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005769 }
5770}
5771#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5772
Gilles Peskinee59236f2018-01-27 23:32:46 +01005773psa_status_t psa_crypto_init( void )
5774{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005775 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005776
Gilles Peskinec6b69072018-11-20 21:42:52 +01005777 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005778 if( global_data.initialized != 0 )
5779 return( PSA_SUCCESS );
5780
Gilles Peskine30524eb2020-11-13 17:02:26 +01005781 /* Initialize and seed the random generator. */
5782 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005783 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005784 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005785 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005786 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005787 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005788
Gilles Peskine66fb1262018-12-10 16:29:04 +01005789 status = psa_initialize_key_slots( );
5790 if( status != PSA_SUCCESS )
5791 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005792
Gilles Peskined9348f22019-10-01 15:22:29 +02005793#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5794 status = psa_init_all_se_drivers( );
5795 if( status != PSA_SUCCESS )
5796 goto exit;
5797#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5798
Gilles Peskine4b734222019-07-24 15:56:31 +02005799#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005800 status = psa_crypto_load_transaction( );
5801 if( status == PSA_SUCCESS )
5802 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005803 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5804 if( status != PSA_SUCCESS )
5805 goto exit;
5806 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005807 }
5808 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5809 {
5810 /* There's no transaction to complete. It's all good. */
5811 status = PSA_SUCCESS;
5812 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005813#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005814
Gilles Peskinec6b69072018-11-20 21:42:52 +01005815 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005816 global_data.initialized = 1;
5817
5818exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005819 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005820 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005821 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005822}
5823
5824#endif /* MBEDTLS_PSA_CRYPTO_C */