blob: 57053efb0d64bb6b3d567ff3eb2c7c001a194c69 [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)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002148static const 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{
2199 switch( operation->alg )
2200 {
Gilles Peskine81736312018-06-26 15:04:31 +02002201 case 0:
2202 /* The object has (apparently) been initialized but it is not
2203 * in use. It's ok to call abort on such an object, and there's
2204 * nothing to do. */
2205 break;
John Durkopee4e6602020-11-27 08:48:46 -08002206#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207 case PSA_ALG_MD2:
2208 mbedtls_md2_free( &operation->ctx.md2 );
2209 break;
2210#endif
John Durkopee4e6602020-11-27 08:48:46 -08002211#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212 case PSA_ALG_MD4:
2213 mbedtls_md4_free( &operation->ctx.md4 );
2214 break;
2215#endif
John Durkopee4e6602020-11-27 08:48:46 -08002216#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002217 case PSA_ALG_MD5:
2218 mbedtls_md5_free( &operation->ctx.md5 );
2219 break;
2220#endif
John Durkopee4e6602020-11-27 08:48:46 -08002221#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002222 case PSA_ALG_RIPEMD160:
2223 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2224 break;
2225#endif
John Durkopee4e6602020-11-27 08:48:46 -08002226#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002227 case PSA_ALG_SHA_1:
2228 mbedtls_sha1_free( &operation->ctx.sha1 );
2229 break;
2230#endif
John Durkop6ca23272020-12-03 06:01:32 -08002231#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002232 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002233 mbedtls_sha256_free( &operation->ctx.sha256 );
2234 break;
2235#endif
2236#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002237 case PSA_ALG_SHA_256:
2238 mbedtls_sha256_free( &operation->ctx.sha256 );
2239 break;
2240#endif
John Durkop6ca23272020-12-03 06:01:32 -08002241#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002242 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002243 mbedtls_sha512_free( &operation->ctx.sha512 );
2244 break;
2245#endif
2246#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002247 case PSA_ALG_SHA_512:
2248 mbedtls_sha512_free( &operation->ctx.sha512 );
2249 break;
2250#endif
2251 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002252 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002253 }
2254 operation->alg = 0;
2255 return( PSA_SUCCESS );
2256}
2257
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002258psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259 psa_algorithm_t alg )
2260{
Janos Follath24eed8d2019-11-22 13:21:35 +00002261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002262
2263 /* A context must be freshly initialized before it can be set up. */
2264 if( operation->alg != 0 )
2265 {
2266 return( PSA_ERROR_BAD_STATE );
2267 }
2268
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002269 switch( alg )
2270 {
John Durkopee4e6602020-11-27 08:48:46 -08002271#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002272 case PSA_ALG_MD2:
2273 mbedtls_md2_init( &operation->ctx.md2 );
2274 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2275 break;
2276#endif
John Durkopee4e6602020-11-27 08:48:46 -08002277#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278 case PSA_ALG_MD4:
2279 mbedtls_md4_init( &operation->ctx.md4 );
2280 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2281 break;
2282#endif
John Durkopee4e6602020-11-27 08:48:46 -08002283#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002284 case PSA_ALG_MD5:
2285 mbedtls_md5_init( &operation->ctx.md5 );
2286 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2287 break;
2288#endif
John Durkopee4e6602020-11-27 08:48:46 -08002289#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290 case PSA_ALG_RIPEMD160:
2291 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2292 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2293 break;
2294#endif
John Durkopee4e6602020-11-27 08:48:46 -08002295#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002296 case PSA_ALG_SHA_1:
2297 mbedtls_sha1_init( &operation->ctx.sha1 );
2298 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2299 break;
2300#endif
John Durkopee4e6602020-11-27 08:48:46 -08002301#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002302 case PSA_ALG_SHA_224:
2303 mbedtls_sha256_init( &operation->ctx.sha256 );
2304 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2305 break;
John Durkopee4e6602020-11-27 08:48:46 -08002306#endif
2307#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002308 case PSA_ALG_SHA_256:
2309 mbedtls_sha256_init( &operation->ctx.sha256 );
2310 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2311 break;
2312#endif
John Durkopee4e6602020-11-27 08:48:46 -08002313#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002314 case PSA_ALG_SHA_384:
2315 mbedtls_sha512_init( &operation->ctx.sha512 );
2316 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2317 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002318#endif
John Durkopee4e6602020-11-27 08:48:46 -08002319#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320 case PSA_ALG_SHA_512:
2321 mbedtls_sha512_init( &operation->ctx.sha512 );
2322 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2323 break;
2324#endif
2325 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002326 return( PSA_ALG_IS_HASH( alg ) ?
2327 PSA_ERROR_NOT_SUPPORTED :
2328 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002329 }
2330 if( ret == 0 )
2331 operation->alg = alg;
2332 else
2333 psa_hash_abort( operation );
2334 return( mbedtls_to_psa_error( ret ) );
2335}
2336
2337psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2338 const uint8_t *input,
2339 size_t input_length )
2340{
Janos Follath24eed8d2019-11-22 13:21:35 +00002341 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002342
2343 /* Don't require hash implementations to behave correctly on a
2344 * zero-length input, which may have an invalid pointer. */
2345 if( input_length == 0 )
2346 return( PSA_SUCCESS );
2347
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002348 switch( operation->alg )
2349 {
John Durkopee4e6602020-11-27 08:48:46 -08002350#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002351 case PSA_ALG_MD2:
2352 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2353 input, input_length );
2354 break;
2355#endif
John Durkopee4e6602020-11-27 08:48:46 -08002356#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002357 case PSA_ALG_MD4:
2358 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2359 input, input_length );
2360 break;
2361#endif
John Durkopee4e6602020-11-27 08:48:46 -08002362#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002363 case PSA_ALG_MD5:
2364 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2365 input, input_length );
2366 break;
2367#endif
John Durkopee4e6602020-11-27 08:48:46 -08002368#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002369 case PSA_ALG_RIPEMD160:
2370 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2371 input, input_length );
2372 break;
2373#endif
John Durkopee4e6602020-11-27 08:48:46 -08002374#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002375 case PSA_ALG_SHA_1:
2376 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2377 input, input_length );
2378 break;
2379#endif
John Durkop6ca23272020-12-03 06:01:32 -08002380#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002381 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002382 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2383 input, input_length );
2384 break;
2385#endif
2386#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002387 case PSA_ALG_SHA_256:
2388 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2389 input, input_length );
2390 break;
2391#endif
John Durkop6ca23272020-12-03 06:01:32 -08002392#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002394 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2395 input, input_length );
2396 break;
2397#endif
2398#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399 case PSA_ALG_SHA_512:
2400 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2401 input, input_length );
2402 break;
2403#endif
2404 default:
John Durkopee4e6602020-11-27 08:48:46 -08002405 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002406 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002407 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002408
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409 if( ret != 0 )
2410 psa_hash_abort( operation );
2411 return( mbedtls_to_psa_error( ret ) );
2412}
2413
2414psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2415 uint8_t *hash,
2416 size_t hash_size,
2417 size_t *hash_length )
2418{
itayzafrir40835d42018-08-02 13:14:17 +03002419 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002421 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002422
2423 /* Fill the output buffer with something that isn't a valid hash
2424 * (barring an attack on the hash and deliberately-crafted input),
2425 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002426 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002427 /* If hash_size is 0 then hash may be NULL and then the
2428 * call to memset would have undefined behavior. */
2429 if( hash_size != 0 )
2430 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002431
2432 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002433 {
2434 status = PSA_ERROR_BUFFER_TOO_SMALL;
2435 goto exit;
2436 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002437
2438 switch( operation->alg )
2439 {
John Durkopee4e6602020-11-27 08:48:46 -08002440#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002441 case PSA_ALG_MD2:
2442 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2443 break;
2444#endif
John Durkopee4e6602020-11-27 08:48:46 -08002445#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002446 case PSA_ALG_MD4:
2447 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2448 break;
2449#endif
John Durkopee4e6602020-11-27 08:48:46 -08002450#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002451 case PSA_ALG_MD5:
2452 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2453 break;
2454#endif
John Durkopee4e6602020-11-27 08:48:46 -08002455#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002456 case PSA_ALG_RIPEMD160:
2457 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2458 break;
2459#endif
John Durkopee4e6602020-11-27 08:48:46 -08002460#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461 case PSA_ALG_SHA_1:
2462 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2463 break;
2464#endif
John Durkop6ca23272020-12-03 06:01:32 -08002465#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002466 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002467 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2468 break;
2469#endif
2470#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002471 case PSA_ALG_SHA_256:
2472 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2473 break;
2474#endif
John Durkop6ca23272020-12-03 06:01:32 -08002475#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002476 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002477 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2478 break;
2479#endif
2480#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002481 case PSA_ALG_SHA_512:
2482 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2483 break;
2484#endif
2485 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002486 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002487 }
itayzafrir40835d42018-08-02 13:14:17 +03002488 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002489
itayzafrir40835d42018-08-02 13:14:17 +03002490exit:
2491 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002492 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002493 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002494 return( psa_hash_abort( operation ) );
2495 }
2496 else
2497 {
2498 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002499 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002500 }
2501}
2502
Gilles Peskine2d277862018-06-18 15:41:12 +02002503psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2504 const uint8_t *hash,
2505 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002506{
2507 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2508 size_t actual_hash_length;
2509 psa_status_t status = psa_hash_finish( operation,
2510 actual_hash, sizeof( actual_hash ),
2511 &actual_hash_length );
2512 if( status != PSA_SUCCESS )
2513 return( status );
2514 if( actual_hash_length != hash_length )
2515 return( PSA_ERROR_INVALID_SIGNATURE );
2516 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2517 return( PSA_ERROR_INVALID_SIGNATURE );
2518 return( PSA_SUCCESS );
2519}
2520
Gilles Peskine0a749c82019-11-28 19:33:58 +01002521psa_status_t psa_hash_compute( psa_algorithm_t alg,
2522 const uint8_t *input, size_t input_length,
2523 uint8_t *hash, size_t hash_size,
2524 size_t *hash_length )
2525{
2526 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2528
2529 *hash_length = hash_size;
2530 status = psa_hash_setup( &operation, alg );
2531 if( status != PSA_SUCCESS )
2532 goto exit;
2533 status = psa_hash_update( &operation, input, input_length );
2534 if( status != PSA_SUCCESS )
2535 goto exit;
2536 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2537 if( status != PSA_SUCCESS )
2538 goto exit;
2539
2540exit:
2541 if( status == PSA_SUCCESS )
2542 status = psa_hash_abort( &operation );
2543 else
2544 psa_hash_abort( &operation );
2545 return( status );
2546}
2547
2548psa_status_t psa_hash_compare( psa_algorithm_t alg,
2549 const uint8_t *input, size_t input_length,
2550 const uint8_t *hash, size_t hash_length )
2551{
2552 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2553 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2554
2555 status = psa_hash_setup( &operation, alg );
2556 if( status != PSA_SUCCESS )
2557 goto exit;
2558 status = psa_hash_update( &operation, input, input_length );
2559 if( status != PSA_SUCCESS )
2560 goto exit;
2561 status = psa_hash_verify( &operation, hash, hash_length );
2562 if( status != PSA_SUCCESS )
2563 goto exit;
2564
2565exit:
2566 if( status == PSA_SUCCESS )
2567 status = psa_hash_abort( &operation );
2568 else
2569 psa_hash_abort( &operation );
2570 return( status );
2571}
2572
Gilles Peskineeb35d782019-01-22 17:56:16 +01002573psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2574 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002575{
2576 if( target_operation->alg != 0 )
2577 return( PSA_ERROR_BAD_STATE );
2578
2579 switch( source_operation->alg )
2580 {
2581 case 0:
2582 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002583#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002584 case PSA_ALG_MD2:
2585 mbedtls_md2_clone( &target_operation->ctx.md2,
2586 &source_operation->ctx.md2 );
2587 break;
2588#endif
John Durkopee4e6602020-11-27 08:48:46 -08002589#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002590 case PSA_ALG_MD4:
2591 mbedtls_md4_clone( &target_operation->ctx.md4,
2592 &source_operation->ctx.md4 );
2593 break;
2594#endif
John Durkopee4e6602020-11-27 08:48:46 -08002595#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002596 case PSA_ALG_MD5:
2597 mbedtls_md5_clone( &target_operation->ctx.md5,
2598 &source_operation->ctx.md5 );
2599 break;
2600#endif
John Durkopee4e6602020-11-27 08:48:46 -08002601#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002602 case PSA_ALG_RIPEMD160:
2603 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2604 &source_operation->ctx.ripemd160 );
2605 break;
2606#endif
John Durkopee4e6602020-11-27 08:48:46 -08002607#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002608 case PSA_ALG_SHA_1:
2609 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2610 &source_operation->ctx.sha1 );
2611 break;
2612#endif
John Durkop6ca23272020-12-03 06:01:32 -08002613#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002614 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002615 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2616 &source_operation->ctx.sha256 );
2617 break;
2618#endif
2619#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002620 case PSA_ALG_SHA_256:
2621 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2622 &source_operation->ctx.sha256 );
2623 break;
2624#endif
John Durkop6ca23272020-12-03 06:01:32 -08002625#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002626 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002627 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2628 &source_operation->ctx.sha512 );
2629 break;
2630#endif
2631#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002632 case PSA_ALG_SHA_512:
2633 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2634 &source_operation->ctx.sha512 );
2635 break;
2636#endif
2637 default:
2638 return( PSA_ERROR_NOT_SUPPORTED );
2639 }
2640
2641 target_operation->alg = source_operation->alg;
2642 return( PSA_SUCCESS );
2643}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002644
2645
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002646/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647/* MAC */
2648/****************************************************************/
2649
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002650static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002651 psa_algorithm_t alg,
2652 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002653 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002654 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002655{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002657 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002659 if( PSA_ALG_IS_AEAD( alg ) )
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002660 alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002661
Gilles Peskine8c9def32018-02-08 10:02:12 +01002662 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2663 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002664 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002666 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002667 mode = MBEDTLS_MODE_STREAM;
2668 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002669 case PSA_ALG_CTR:
2670 mode = MBEDTLS_MODE_CTR;
2671 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002672 case PSA_ALG_CFB:
2673 mode = MBEDTLS_MODE_CFB;
2674 break;
2675 case PSA_ALG_OFB:
2676 mode = MBEDTLS_MODE_OFB;
2677 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002678 case PSA_ALG_ECB_NO_PADDING:
2679 mode = MBEDTLS_MODE_ECB;
2680 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002681 case PSA_ALG_CBC_NO_PADDING:
2682 mode = MBEDTLS_MODE_CBC;
2683 break;
2684 case PSA_ALG_CBC_PKCS7:
2685 mode = MBEDTLS_MODE_CBC;
2686 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002687 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002688 mode = MBEDTLS_MODE_CCM;
2689 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002690 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002691 mode = MBEDTLS_MODE_GCM;
2692 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002693 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02002694 mode = MBEDTLS_MODE_CHACHAPOLY;
2695 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002696 default:
2697 return( NULL );
2698 }
2699 }
2700 else if( alg == PSA_ALG_CMAC )
2701 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702 else
2703 return( NULL );
2704
2705 switch( key_type )
2706 {
2707 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002708 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002709 break;
2710 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002711 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2712 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002713 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002714 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002715 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002716 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002717 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2718 * but two-key Triple-DES is functionally three-key Triple-DES
2719 * with K1=K3, so that's how we present it to mbedtls. */
2720 if( key_bits == 128 )
2721 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002722 break;
2723 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002724 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002725 break;
2726 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002727 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002729 case PSA_KEY_TYPE_CHACHA20:
2730 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2731 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002732 default:
2733 return( NULL );
2734 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002735 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002736 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737
Jaeden Amero23bbb752018-06-26 14:16:54 +01002738 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2739 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740}
2741
John Durkop6ba40d12020-11-10 08:50:04 -08002742#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002743static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002744{
Gilles Peskine2d277862018-06-18 15:41:12 +02002745 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002746 {
2747 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002748 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002749 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002750 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002751 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002752 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002753 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002754 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002755 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002756 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002757 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002758 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002759 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002760 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002761 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002762 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002763 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002764 return( 128 );
2765 default:
2766 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002767 }
2768}
John Durkop07cc04a2020-11-16 22:08:34 -08002769#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002770
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002771/* Initialize the MAC operation structure. Once this function has been
2772 * called, psa_mac_abort can run and will do the right thing. */
2773static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2774 psa_algorithm_t alg )
2775{
2776 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2777
Steven Cooreman15472f82021-03-02 16:16:22 +01002778 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002779 operation->key_set = 0;
2780 operation->iv_set = 0;
2781 operation->iv_required = 0;
2782 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002783 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002784
2785#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002786 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002787 {
2788 operation->iv_required = 0;
2789 mbedtls_cipher_init( &operation->ctx.cmac );
2790 status = PSA_SUCCESS;
2791 }
2792 else
2793#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002794#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002795 if( PSA_ALG_IS_HMAC( operation->alg ) )
2796 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002797 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2798 operation->ctx.hmac.hash_ctx.alg = 0;
2799 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002800 }
2801 else
John Durkopd0321952020-10-29 21:37:36 -07002802#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002803 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002804 if( ! PSA_ALG_IS_MAC( alg ) )
2805 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002806 }
2807
2808 if( status != PSA_SUCCESS )
2809 memset( operation, 0, sizeof( *operation ) );
2810 return( status );
2811}
2812
John Durkop6ba40d12020-11-10 08:50:04 -08002813#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002814static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2815{
Gilles Peskine3f108122018-12-07 18:14:53 +01002816 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002817 return( psa_hash_abort( &hmac->hash_ctx ) );
2818}
John Durkop6ba40d12020-11-10 08:50:04 -08002819#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002820
Gilles Peskine8c9def32018-02-08 10:02:12 +01002821psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2822{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002823 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002824 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002825 /* The object has (apparently) been initialized but it is not
2826 * in use. It's ok to call abort on such an object, and there's
2827 * nothing to do. */
2828 return( PSA_SUCCESS );
2829 }
2830 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002831#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002832 if( operation->alg == PSA_ALG_CMAC )
2833 {
2834 mbedtls_cipher_free( &operation->ctx.cmac );
2835 }
2836 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002837#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002838#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002839 if( PSA_ALG_IS_HMAC( operation->alg ) )
2840 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002841 psa_hmac_abort_internal( &operation->ctx.hmac );
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 /* Sanity check (shouldn't happen: operation->alg should
2847 * always have been initialized to a valid value). */
2848 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002849 }
Moran Peker41deec42018-04-04 15:43:05 +03002850
Gilles Peskine8c9def32018-02-08 10:02:12 +01002851 operation->alg = 0;
2852 operation->key_set = 0;
2853 operation->iv_set = 0;
2854 operation->iv_required = 0;
2855 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002856 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002857
Gilles Peskine8c9def32018-02-08 10:02:12 +01002858 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002859
2860bad_state:
2861 /* If abort is called on an uninitialized object, we can't trust
2862 * anything. Wipe the object in case it contains confidential data.
2863 * This may result in a memory leak if a pointer gets overwritten,
2864 * but it's too late to do anything about this. */
2865 memset( operation, 0, sizeof( *operation ) );
2866 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002867}
2868
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002869#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002870static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2871 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002872{
Janos Follath24eed8d2019-11-22 13:21:35 +00002873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002874 const mbedtls_cipher_info_t *cipher_info =
2875 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2876 slot->attr.type, slot->attr.bits,
2877 NULL );
2878 if( cipher_info == NULL )
2879 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002880
2881 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2882 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002883 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002884
2885 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002886 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002887 slot->attr.bits );
2888exit:
2889 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002890}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002891#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002892
John Durkop6ba40d12020-11-10 08:50:04 -08002893#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002894static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2895 const uint8_t *key,
2896 size_t key_length,
2897 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002898{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002899 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002900 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002901 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002902 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002903 psa_status_t status;
2904
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002905 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2906 * overflow below. This should never trigger if the hash algorithm
2907 * is implemented correctly. */
2908 /* The size checks against the ipad and opad buffers cannot be written
2909 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2910 * because that triggers -Wlogical-op on GCC 7.3. */
2911 if( block_size > sizeof( ipad ) )
2912 return( PSA_ERROR_NOT_SUPPORTED );
2913 if( block_size > sizeof( hmac->opad ) )
2914 return( PSA_ERROR_NOT_SUPPORTED );
2915 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002916 return( PSA_ERROR_NOT_SUPPORTED );
2917
Gilles Peskined223b522018-06-11 18:12:58 +02002918 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002919 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002920 status = psa_hash_compute( hash_alg, key, key_length,
2921 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002922 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002923 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002924 }
Gilles Peskine96889972018-07-12 17:07:03 +02002925 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2926 * but it is permitted. It is common when HMAC is used in HKDF, for
2927 * example. Don't call `memcpy` in the 0-length because `key` could be
2928 * an invalid pointer which would make the behavior undefined. */
2929 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002930 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002931
Gilles Peskined223b522018-06-11 18:12:58 +02002932 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2933 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002934 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002935 ipad[i] ^= 0x36;
2936 memset( ipad + key_length, 0x36, block_size - key_length );
2937
2938 /* Copy the key material from ipad to opad, flipping the requisite bits,
2939 * and filling the rest of opad with the requisite constant. */
2940 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002941 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2942 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002943
Gilles Peskine01126fa2018-07-12 17:04:55 +02002944 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002945 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002946 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002947
Gilles Peskine01126fa2018-07-12 17:04:55 +02002948 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002949
2950cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002951 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002952
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002953 return( status );
2954}
John Durkop6ba40d12020-11-10 08:50:04 -08002955#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002956
Gilles Peskine89167cb2018-07-08 20:12:23 +02002957static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002958 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002959 psa_algorithm_t alg,
2960 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002962 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002963 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002964 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002965 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002966 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002967
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002968 /* A context must be freshly initialized before it can be set up. */
2969 if( operation->alg != 0 )
2970 {
2971 return( PSA_ERROR_BAD_STATE );
2972 }
2973
Steven Cooreman15472f82021-03-02 16:16:22 +01002974 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002975 if( status != PSA_SUCCESS )
2976 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002977 if( is_sign )
2978 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002979
Ronald Cron5c522922020-11-14 16:35:34 +01002980 status = psa_get_and_lock_transparent_key_slot_with_policy(
2981 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002982 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002983 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002984
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002985 /* Validate the combination of key type and algorithm */
2986 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002987 if( status != PSA_SUCCESS )
2988 goto exit;
2989
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002990 /* Get the output length for the algorithm and key combination. None of the
2991 * currently supported algorithms have an output length dependent on actual
2992 * key size, so setting it to a bogus value is currently OK. */
2993 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002994
2995 if( operation->mac_size < 4 )
2996 {
2997 /* A very short MAC is too short for security since it can be
2998 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2999 * so we make this our minimum, even though 32 bits is still
3000 * too small for security. */
3001 status = PSA_ERROR_NOT_SUPPORTED;
3002 goto exit;
3003 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003004
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01003005 if( operation->mac_size >
3006 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
3007 {
3008 /* It's impossible to "truncate" to a larger length than the full length
3009 * of the algorithm. */
3010 status = PSA_ERROR_INVALID_ARGUMENT;
3011 goto exit;
3012 }
3013
Gilles Peskine8c9def32018-02-08 10:02:12 +01003014#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01003015 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003016 {
Steven Cooreman15472f82021-03-02 16:16:22 +01003017 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003018 }
3019 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003020#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003021#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01003022 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003023 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003024 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01003025 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003026 {
3027 status = PSA_ERROR_NOT_SUPPORTED;
3028 goto exit;
3029 }
3030
Gilles Peskine8e338702019-07-30 20:06:31 +02003031 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003032 {
3033 status = PSA_ERROR_INVALID_ARGUMENT;
3034 goto exit;
3035 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003036
Gilles Peskine01126fa2018-07-12 17:04:55 +02003037 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003038 slot->key.data,
3039 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01003040 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003041 }
3042 else
John Durkopd0321952020-10-29 21:37:36 -07003043#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003044 {
3045 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003046 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003047
Gilles Peskinefbfac682018-07-08 20:51:54 +02003048exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003049 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003050 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003051 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003052 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003053 else
3054 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003055 operation->key_set = 1;
3056 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003057
Ronald Cron5c522922020-11-14 16:35:34 +01003058 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003059
Ronald Cron5c522922020-11-14 16:35:34 +01003060 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003061}
3062
Gilles Peskine89167cb2018-07-08 20:12:23 +02003063psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003064 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003065 psa_algorithm_t alg )
3066{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003067 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003068}
3069
3070psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003071 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003072 psa_algorithm_t alg )
3073{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003074 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003075}
3076
Gilles Peskine8c9def32018-02-08 10:02:12 +01003077psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3078 const uint8_t *input,
3079 size_t input_length )
3080{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003081 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003082 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003083 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003084 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003085 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003086 operation->has_input = 1;
3087
Gilles Peskine8c9def32018-02-08 10:02:12 +01003088#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003089 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003090 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003091 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3092 input, input_length );
3093 status = mbedtls_to_psa_error( ret );
3094 }
3095 else
3096#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003097#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003098 if( PSA_ALG_IS_HMAC( operation->alg ) )
3099 {
3100 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3101 input_length );
3102 }
3103 else
John Durkopd0321952020-10-29 21:37:36 -07003104#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003105 {
3106 /* This shouldn't happen if `operation` was initialized by
3107 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003108 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003109 }
3110
Gilles Peskinefbfac682018-07-08 20:51:54 +02003111 if( status != PSA_SUCCESS )
3112 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003113 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003114}
3115
John Durkop6ba40d12020-11-10 08:50:04 -08003116#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003117static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3118 uint8_t *mac,
3119 size_t mac_size )
3120{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003121 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003122 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3123 size_t hash_size = 0;
3124 size_t block_size = psa_get_hash_block_size( hash_alg );
3125 psa_status_t status;
3126
Gilles Peskine01126fa2018-07-12 17:04:55 +02003127 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3128 if( status != PSA_SUCCESS )
3129 return( status );
3130 /* From here on, tmp needs to be wiped. */
3131
3132 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3133 if( status != PSA_SUCCESS )
3134 goto exit;
3135
3136 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3137 if( status != PSA_SUCCESS )
3138 goto exit;
3139
3140 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3141 if( status != PSA_SUCCESS )
3142 goto exit;
3143
Gilles Peskined911eb72018-08-14 15:18:45 +02003144 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3145 if( status != PSA_SUCCESS )
3146 goto exit;
3147
3148 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003149
3150exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003151 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003152 return( status );
3153}
John Durkop6ba40d12020-11-10 08:50:04 -08003154#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003155
mohammad16036df908f2018-04-02 08:34:15 -07003156static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003157 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003158 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003159{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003160 if( ! operation->key_set )
3161 return( PSA_ERROR_BAD_STATE );
3162 if( operation->iv_required && ! operation->iv_set )
3163 return( PSA_ERROR_BAD_STATE );
3164
Gilles Peskine8c9def32018-02-08 10:02:12 +01003165 if( mac_size < operation->mac_size )
3166 return( PSA_ERROR_BUFFER_TOO_SMALL );
3167
Gilles Peskine8c9def32018-02-08 10:02:12 +01003168#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003169 if( operation->alg == PSA_ALG_CMAC )
3170 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003171 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003172 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3173 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003174 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003175 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003176 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003177 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003178 else
3179#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003180#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003181 if( PSA_ALG_IS_HMAC( operation->alg ) )
3182 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003183 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003184 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003185 }
3186 else
John Durkopd0321952020-10-29 21:37:36 -07003187#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003188 {
3189 /* This shouldn't happen if `operation` was initialized by
3190 * a setup function. */
3191 return( PSA_ERROR_BAD_STATE );
3192 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003193}
3194
Gilles Peskineacd4be32018-07-08 19:56:25 +02003195psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3196 uint8_t *mac,
3197 size_t mac_size,
3198 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003199{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003200 psa_status_t status;
3201
Jaeden Amero252ef282019-02-15 14:05:35 +00003202 if( operation->alg == 0 )
3203 {
3204 return( PSA_ERROR_BAD_STATE );
3205 }
3206
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003207 /* Fill the output buffer with something that isn't a valid mac
3208 * (barring an attack on the mac and deliberately-crafted input),
3209 * in case the caller doesn't check the return status properly. */
3210 *mac_length = mac_size;
3211 /* If mac_size is 0 then mac may be NULL and then the
3212 * call to memset would have undefined behavior. */
3213 if( mac_size != 0 )
3214 memset( mac, '!', mac_size );
3215
Gilles Peskine89167cb2018-07-08 20:12:23 +02003216 if( ! operation->is_sign )
3217 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003218 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003219 }
mohammad16036df908f2018-04-02 08:34:15 -07003220
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003221 status = psa_mac_finish_internal( operation, mac, mac_size );
3222
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003223 if( status == PSA_SUCCESS )
3224 {
3225 status = psa_mac_abort( operation );
3226 if( status == PSA_SUCCESS )
3227 *mac_length = operation->mac_size;
3228 else
3229 memset( mac, '!', mac_size );
3230 }
3231 else
3232 psa_mac_abort( operation );
3233 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003234}
3235
Gilles Peskineacd4be32018-07-08 19:56:25 +02003236psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3237 const uint8_t *mac,
3238 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003239{
Gilles Peskine828ed142018-06-18 23:25:51 +02003240 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003241 psa_status_t status;
3242
Jaeden Amero252ef282019-02-15 14:05:35 +00003243 if( operation->alg == 0 )
3244 {
3245 return( PSA_ERROR_BAD_STATE );
3246 }
3247
Gilles Peskine89167cb2018-07-08 20:12:23 +02003248 if( operation->is_sign )
3249 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003250 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003251 }
3252 if( operation->mac_size != mac_length )
3253 {
3254 status = PSA_ERROR_INVALID_SIGNATURE;
3255 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003256 }
mohammad16036df908f2018-04-02 08:34:15 -07003257
3258 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003259 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003260 if( status != PSA_SUCCESS )
3261 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003262
3263 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3264 status = PSA_ERROR_INVALID_SIGNATURE;
3265
3266cleanup:
3267 if( status == PSA_SUCCESS )
3268 status = psa_mac_abort( operation );
3269 else
3270 psa_mac_abort( operation );
3271
Gilles Peskine3f108122018-12-07 18:14:53 +01003272 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003273
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003274 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003275}
3276
3277
Gilles Peskine20035e32018-02-03 22:44:14 +01003278
Gilles Peskine20035e32018-02-03 22:44:14 +01003279/****************************************************************/
3280/* Asymmetric cryptography */
3281/****************************************************************/
3282
John Durkop6ba40d12020-11-10 08:50:04 -08003283#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3284 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003285/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003286 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003287static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3288 size_t hash_length,
3289 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003290{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003291 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003292 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003293 *md_alg = mbedtls_md_get_type( md_info );
3294
3295 /* The Mbed TLS RSA module uses an unsigned int for hash length
3296 * parameters. Validate that it fits so that we don't risk an
3297 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003298#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003299 if( hash_length > UINT_MAX )
3300 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003301#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003302
John Durkop0e005192020-10-31 22:06:54 -07003303#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003304 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3305 * must be correct. */
3306 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3307 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003308 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003309 if( md_info == NULL )
3310 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003311 if( mbedtls_md_get_size( md_info ) != hash_length )
3312 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003313 }
John Durkop0e005192020-10-31 22:06:54 -07003314#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003315
John Durkop0e005192020-10-31 22:06:54 -07003316#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003317 /* PSS requires a hash internally. */
3318 if( PSA_ALG_IS_RSA_PSS( alg ) )
3319 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003320 if( md_info == NULL )
3321 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003322 }
John Durkop0e005192020-10-31 22:06:54 -07003323#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003324
Gilles Peskine61b91d42018-06-08 16:09:36 +02003325 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003326}
3327
Gilles Peskine2b450e32018-06-27 15:42:46 +02003328static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3329 psa_algorithm_t alg,
3330 const uint8_t *hash,
3331 size_t hash_length,
3332 uint8_t *signature,
3333 size_t signature_size,
3334 size_t *signature_length )
3335{
3336 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003337 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003338 mbedtls_md_type_t md_alg;
3339
3340 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3341 if( status != PSA_SUCCESS )
3342 return( status );
3343
Gilles Peskine630a18a2018-06-29 17:49:35 +02003344 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003345 return( PSA_ERROR_BUFFER_TOO_SMALL );
3346
John Durkop0e005192020-10-31 22:06:54 -07003347#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003348 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3349 {
3350 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3351 MBEDTLS_MD_NONE );
3352 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003353 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003354 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003355 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003356 md_alg,
3357 (unsigned int) hash_length,
3358 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003359 signature );
3360 }
3361 else
John Durkop0e005192020-10-31 22:06:54 -07003362#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3363#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003364 if( PSA_ALG_IS_RSA_PSS( alg ) )
3365 {
3366 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3367 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003368 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003369 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003370 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003371 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003372 (unsigned int) hash_length,
3373 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003374 signature );
3375 }
3376 else
John Durkop0e005192020-10-31 22:06:54 -07003377#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003378 {
3379 return( PSA_ERROR_INVALID_ARGUMENT );
3380 }
3381
3382 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003383 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003384 return( mbedtls_to_psa_error( ret ) );
3385}
3386
3387static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3388 psa_algorithm_t alg,
3389 const uint8_t *hash,
3390 size_t hash_length,
3391 const uint8_t *signature,
3392 size_t signature_length )
3393{
3394 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003396 mbedtls_md_type_t md_alg;
3397
3398 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3399 if( status != PSA_SUCCESS )
3400 return( status );
3401
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003402 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3403 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003404
John Durkop0e005192020-10-31 22:06:54 -07003405#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003406 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3407 {
3408 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3409 MBEDTLS_MD_NONE );
3410 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003411 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003412 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003413 MBEDTLS_RSA_PUBLIC,
3414 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003415 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003416 hash,
3417 signature );
3418 }
3419 else
John Durkop0e005192020-10-31 22:06:54 -07003420#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3421#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003422 if( PSA_ALG_IS_RSA_PSS( alg ) )
3423 {
3424 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3425 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003426 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003427 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003428 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003429 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003430 (unsigned int) hash_length,
3431 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003432 signature );
3433 }
3434 else
John Durkop0e005192020-10-31 22:06:54 -07003435#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003436 {
3437 return( PSA_ERROR_INVALID_ARGUMENT );
3438 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003439
3440 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3441 * the rest of the signature is invalid". This has little use in
3442 * practice and PSA doesn't report this distinction. */
3443 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3444 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003445 return( mbedtls_to_psa_error( ret ) );
3446}
John Durkop6ba40d12020-11-10 08:50:04 -08003447#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3448 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003449
John Durkop6ba40d12020-11-10 08:50:04 -08003450#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3451 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003452/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3453 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3454 * (even though these functions don't modify it). */
3455static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3456 psa_algorithm_t alg,
3457 const uint8_t *hash,
3458 size_t hash_length,
3459 uint8_t *signature,
3460 size_t signature_size,
3461 size_t *signature_length )
3462{
Janos Follath24eed8d2019-11-22 13:21:35 +00003463 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003464 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003465 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003466 mbedtls_mpi_init( &r );
3467 mbedtls_mpi_init( &s );
3468
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003469 if( signature_size < 2 * curve_bytes )
3470 {
3471 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3472 goto cleanup;
3473 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003474
John Durkop0ea39e02020-10-13 19:58:20 -07003475#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003476 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3477 {
3478 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3479 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3480 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003481 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3482 &ecp->d, hash,
3483 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003484 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003485 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003486 }
3487 else
John Durkop0ea39e02020-10-13 19:58:20 -07003488#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003489 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003490 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003491 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3492 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003493 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003494 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003495 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003496
3497 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3498 signature,
3499 curve_bytes ) );
3500 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3501 signature + curve_bytes,
3502 curve_bytes ) );
3503
3504cleanup:
3505 mbedtls_mpi_free( &r );
3506 mbedtls_mpi_free( &s );
3507 if( ret == 0 )
3508 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003509 return( mbedtls_to_psa_error( ret ) );
3510}
3511
3512static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3513 const uint8_t *hash,
3514 size_t hash_length,
3515 const uint8_t *signature,
3516 size_t signature_length )
3517{
Janos Follath24eed8d2019-11-22 13:21:35 +00003518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003519 mbedtls_mpi r, s;
3520 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3521 mbedtls_mpi_init( &r );
3522 mbedtls_mpi_init( &s );
3523
3524 if( signature_length != 2 * curve_bytes )
3525 return( PSA_ERROR_INVALID_SIGNATURE );
3526
3527 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3528 signature,
3529 curve_bytes ) );
3530 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3531 signature + curve_bytes,
3532 curve_bytes ) );
3533
Steven Cooremanacda8342020-07-24 23:09:52 +02003534 /* Check whether the public part is loaded. If not, load it. */
3535 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3536 {
3537 MBEDTLS_MPI_CHK(
3538 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003539 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003540 }
3541
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003542 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3543 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003544
3545cleanup:
3546 mbedtls_mpi_free( &r );
3547 mbedtls_mpi_free( &s );
3548 return( mbedtls_to_psa_error( ret ) );
3549}
John Durkop6ba40d12020-11-10 08:50:04 -08003550#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3551 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003552
Ronald Croncf56a0a2020-08-04 09:51:30 +02003553psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003554 psa_algorithm_t alg,
3555 const uint8_t *hash,
3556 size_t hash_length,
3557 uint8_t *signature,
3558 size_t signature_size,
3559 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003560{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003561 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003562 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003563 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003564
3565 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003566 /* Immediately reject a zero-length signature buffer. This guarantees
3567 * that signature must be a valid pointer. (On the other hand, the hash
3568 * buffer can in principle be empty since it doesn't actually have
3569 * to be a hash.) */
3570 if( signature_size == 0 )
3571 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003572
Ronald Cron5c522922020-11-14 16:35:34 +01003573 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3574 PSA_KEY_USAGE_SIGN_HASH,
3575 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003576 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003577 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003578 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003579 {
3580 status = PSA_ERROR_INVALID_ARGUMENT;
3581 goto exit;
3582 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003583
Steven Cooremancd84cb42020-07-16 20:28:36 +02003584 /* Try any of the available accelerators first */
3585 status = psa_driver_wrapper_sign_hash( slot,
3586 alg,
3587 hash,
3588 hash_length,
3589 signature,
3590 signature_size,
3591 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003592 if( status != PSA_ERROR_NOT_SUPPORTED ||
3593 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003594 goto exit;
3595
Steven Cooreman7a250572020-07-17 16:43:05 +02003596 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003597#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3598 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003599 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003600 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003601 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003602
Ronald Cron90857082020-11-25 14:58:33 +01003603 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3604 slot->key.data,
3605 slot->key.bytes,
3606 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003607 if( status != PSA_SUCCESS )
3608 goto exit;
3609
Steven Cooremana2371e52020-07-28 14:30:39 +02003610 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003611 alg,
3612 hash, hash_length,
3613 signature, signature_size,
3614 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003615
Steven Cooremana2371e52020-07-28 14:30:39 +02003616 mbedtls_rsa_free( rsa );
3617 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003618 }
3619 else
John Durkop6ba40d12020-11-10 08:50:04 -08003620#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3621 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003622 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003623 {
John Durkop9814fa22020-11-04 12:28:15 -08003624#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3625 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003626 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003627#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003628 PSA_ALG_IS_ECDSA( alg )
3629#else
3630 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3631#endif
3632 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003633 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003634 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003635 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01003636 slot->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01003637 slot->key.data,
3638 slot->key.bytes,
3639 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003640 if( status != PSA_SUCCESS )
3641 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003642 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003643 alg,
3644 hash, hash_length,
3645 signature, signature_size,
3646 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003647 mbedtls_ecp_keypair_free( ecp );
3648 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003649 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003650 else
John Durkop9814fa22020-11-04 12:28:15 -08003651#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3652 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003653 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003654 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003655 }
itayzafrir5c753392018-05-08 11:18:38 +03003656 }
3657 else
itayzafrir5c753392018-05-08 11:18:38 +03003658 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003659 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003660 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003661
3662exit:
3663 /* Fill the unused part of the output buffer (the whole buffer on error,
3664 * the trailing part on success) with something that isn't a valid mac
3665 * (barring an attack on the mac and deliberately-crafted input),
3666 * in case the caller doesn't check the return status properly. */
3667 if( status == PSA_SUCCESS )
3668 memset( signature + *signature_length, '!',
3669 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003670 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003671 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003672 /* If signature_size is 0 then we have nothing to do. We must not call
3673 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003674
Ronald Cron5c522922020-11-14 16:35:34 +01003675 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003676
Ronald Cron5c522922020-11-14 16:35:34 +01003677 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003678}
3679
Ronald Croncf56a0a2020-08-04 09:51:30 +02003680psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003681 psa_algorithm_t alg,
3682 const uint8_t *hash,
3683 size_t hash_length,
3684 const uint8_t *signature,
3685 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003686{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003687 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003688 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003689 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003690
Ronald Cron5c522922020-11-14 16:35:34 +01003691 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3692 PSA_KEY_USAGE_VERIFY_HASH,
3693 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003694 if( status != PSA_SUCCESS )
3695 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003696
Steven Cooreman55ae2172020-07-17 19:46:15 +02003697 /* Try any of the available accelerators first */
3698 status = psa_driver_wrapper_verify_hash( slot,
3699 alg,
3700 hash,
3701 hash_length,
3702 signature,
3703 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003704 if( status != PSA_ERROR_NOT_SUPPORTED ||
3705 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003706 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003707
John Durkop6ba40d12020-11-10 08:50:04 -08003708#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3709 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003710 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003711 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003712 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003713
Ronald Cron90857082020-11-25 14:58:33 +01003714 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3715 slot->key.data,
3716 slot->key.bytes,
3717 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003718 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003719 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003720
Steven Cooremana2371e52020-07-28 14:30:39 +02003721 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003722 alg,
3723 hash, hash_length,
3724 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003725 mbedtls_rsa_free( rsa );
3726 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003727 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003728 }
3729 else
John Durkop6ba40d12020-11-10 08:50:04 -08003730#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3731 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003732 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003733 {
John Durkop9814fa22020-11-04 12:28:15 -08003734#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3735 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003736 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003737 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003738 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003739 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01003740 slot->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01003741 slot->key.data,
3742 slot->key.bytes,
3743 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003744 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003745 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003746 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003747 hash, hash_length,
3748 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003749 mbedtls_ecp_keypair_free( ecp );
3750 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003751 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003752 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003753 else
John Durkop9814fa22020-11-04 12:28:15 -08003754#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3755 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003756 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003757 status = PSA_ERROR_INVALID_ARGUMENT;
3758 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003759 }
itayzafrir5c753392018-05-08 11:18:38 +03003760 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003761 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003762 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003763 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003764 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003765
3766exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003767 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003768
Ronald Cron5c522922020-11-14 16:35:34 +01003769 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003770}
3771
John Durkop0e005192020-10-31 22:06:54 -07003772#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003773static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3774 mbedtls_rsa_context *rsa )
3775{
3776 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3777 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3778 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3779 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3780}
John Durkop0e005192020-10-31 22:06:54 -07003781#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003782
Ronald Croncf56a0a2020-08-04 09:51:30 +02003783psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003784 psa_algorithm_t alg,
3785 const uint8_t *input,
3786 size_t input_length,
3787 const uint8_t *salt,
3788 size_t salt_length,
3789 uint8_t *output,
3790 size_t output_size,
3791 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003792{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003793 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003794 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003795 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003796
Darryl Green5cc689a2018-07-24 15:34:10 +01003797 (void) input;
3798 (void) input_length;
3799 (void) salt;
3800 (void) output;
3801 (void) output_size;
3802
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003803 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003804
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003805 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3806 return( PSA_ERROR_INVALID_ARGUMENT );
3807
Ronald Cron5c522922020-11-14 16:35:34 +01003808 status = psa_get_and_lock_transparent_key_slot_with_policy(
3809 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003810 if( status != PSA_SUCCESS )
3811 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003812 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3813 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003814 {
3815 status = PSA_ERROR_INVALID_ARGUMENT;
3816 goto exit;
3817 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003818
John Durkop6ba40d12020-11-10 08:50:04 -08003819#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3820 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003821 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003822 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003823 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003824 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3825 slot->key.data,
3826 slot->key.bytes,
3827 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003828 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003829 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003830
3831 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003832 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003833 status = PSA_ERROR_BUFFER_TOO_SMALL;
3834 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003835 }
John Durkop0e005192020-10-31 22:06:54 -07003836#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003837 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003838 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003839 status = mbedtls_to_psa_error(
3840 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003841 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003842 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003843 MBEDTLS_RSA_PUBLIC,
3844 input_length,
3845 input,
3846 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003847 }
3848 else
John Durkop0e005192020-10-31 22:06:54 -07003849#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3850#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003851 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003852 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003853 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003854 status = mbedtls_to_psa_error(
3855 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003856 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003857 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003858 MBEDTLS_RSA_PUBLIC,
3859 salt, salt_length,
3860 input_length,
3861 input,
3862 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003863 }
3864 else
John Durkop0e005192020-10-31 22:06:54 -07003865#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003866 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003867 status = PSA_ERROR_INVALID_ARGUMENT;
3868 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003869 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003870rsa_exit:
3871 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003872 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003873
Steven Cooremana2371e52020-07-28 14:30:39 +02003874 mbedtls_rsa_free( rsa );
3875 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003876 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003877 else
John Durkop9814fa22020-11-04 12:28:15 -08003878#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003879 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003880 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003881 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003882 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003883
3884exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003885 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003886
Ronald Cron5c522922020-11-14 16:35:34 +01003887 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003888}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003889
Ronald Croncf56a0a2020-08-04 09:51:30 +02003890psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003891 psa_algorithm_t alg,
3892 const uint8_t *input,
3893 size_t input_length,
3894 const uint8_t *salt,
3895 size_t salt_length,
3896 uint8_t *output,
3897 size_t output_size,
3898 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003899{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003900 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003901 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003902 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003903
Darryl Green5cc689a2018-07-24 15:34:10 +01003904 (void) input;
3905 (void) input_length;
3906 (void) salt;
3907 (void) output;
3908 (void) output_size;
3909
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003910 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003911
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003912 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3913 return( PSA_ERROR_INVALID_ARGUMENT );
3914
Ronald Cron5c522922020-11-14 16:35:34 +01003915 status = psa_get_and_lock_transparent_key_slot_with_policy(
3916 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003917 if( status != PSA_SUCCESS )
3918 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003919 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003920 {
3921 status = PSA_ERROR_INVALID_ARGUMENT;
3922 goto exit;
3923 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003924
John Durkop6ba40d12020-11-10 08:50:04 -08003925#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3926 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003927 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003928 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003929 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003930 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3931 slot->key.data,
3932 slot->key.bytes,
3933 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003934 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003935 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003936
Steven Cooremana2371e52020-07-28 14:30:39 +02003937 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003938 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003939 status = PSA_ERROR_INVALID_ARGUMENT;
3940 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003941 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003942
John Durkop0e005192020-10-31 22:06:54 -07003943#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003944 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003945 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003946 status = mbedtls_to_psa_error(
3947 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003948 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003949 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003950 MBEDTLS_RSA_PRIVATE,
3951 output_length,
3952 input,
3953 output,
3954 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003955 }
3956 else
John Durkop0e005192020-10-31 22:06:54 -07003957#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3958#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003959 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003960 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003961 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003962 status = mbedtls_to_psa_error(
3963 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003964 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003965 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003966 MBEDTLS_RSA_PRIVATE,
3967 salt, salt_length,
3968 output_length,
3969 input,
3970 output,
3971 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003972 }
3973 else
John Durkop0e005192020-10-31 22:06:54 -07003974#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003975 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003976 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003977 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003978
Steven Cooreman4fed4552020-08-03 14:46:03 +02003979rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003980 mbedtls_rsa_free( rsa );
3981 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003982 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003983 else
John Durkop6ba40d12020-11-10 08:50:04 -08003984#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3985 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003986 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003987 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003988 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003989
3990exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003991 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003992
Ronald Cron5c522922020-11-14 16:35:34 +01003993 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003994}
Gilles Peskine20035e32018-02-03 22:44:14 +01003995
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003996
3997
mohammad1603503973b2018-03-12 15:59:30 +02003998/****************************************************************/
3999/* Symmetric cryptography */
4000/****************************************************************/
4001
Gilles Peskinee553c652018-06-04 16:22:46 +02004002static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004003 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004004 psa_algorithm_t alg,
4005 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004006{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004007 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004008 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004009 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004010 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004011 size_t key_bits;
4012 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004013 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4014 PSA_KEY_USAGE_ENCRYPT :
4015 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004016
Steven Cooremand3feccd2020-09-01 15:56:14 +02004017 /* A context must be freshly initialized before it can be set up. */
4018 if( operation->alg != 0 )
4019 return( PSA_ERROR_BAD_STATE );
4020
Steven Cooremana07b9972020-09-10 14:54:14 +02004021 /* The requested algorithm must be one that can be processed by cipher. */
4022 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004023 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004024
Steven Cooremanef8575e2020-09-11 11:44:50 +02004025 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004026 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004027 if( status != PSA_SUCCESS )
4028 goto exit;
4029
4030 /* Initialize the operation struct members, except for alg. The alg member
4031 * is used to indicate to psa_cipher_abort that there are resources to free,
4032 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004033 operation->key_set = 0;
4034 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004035 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004036 operation->iv_size = 0;
4037 operation->block_size = 0;
4038 if( alg == PSA_ALG_ECB_NO_PADDING )
4039 operation->iv_required = 0;
4040 else
4041 operation->iv_required = 1;
4042
Steven Cooremana07b9972020-09-10 14:54:14 +02004043 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004044 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004045 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004046 slot,
4047 alg );
4048 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004049 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004050 slot,
4051 alg );
4052
Steven Cooremanef8575e2020-09-11 11:44:50 +02004053 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004054 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004055 /* Once the driver context is initialised, it needs to be freed using
4056 * psa_cipher_abort. Indicate this through setting alg. */
4057 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004058 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004059
Steven Cooremand3feccd2020-09-01 15:56:14 +02004060 if( status != PSA_ERROR_NOT_SUPPORTED ||
4061 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4062 goto exit;
4063
Steven Cooremana07b9972020-09-10 14:54:14 +02004064 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004065 * available for the given algorithm & key. */
4066 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004067
Steven Cooremana07b9972020-09-10 14:54:14 +02004068 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004069 * psa_cipher_abort. Indicate there is something to be freed through setting
4070 * alg, and indicate the operation is being done using mbedtls crypto through
4071 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004072 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004073 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004074
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004075 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004076 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004077 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004078 {
4079 status = PSA_ERROR_NOT_SUPPORTED;
4080 goto exit;
4081 }
mohammad1603503973b2018-03-12 15:59:30 +02004082
mohammad1603503973b2018-03-12 15:59:30 +02004083 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004084 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004085 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004086
David Brown12ca5032021-02-11 11:02:00 -07004087#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004088 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004089 {
4090 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004091 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004092 memcpy( keys, slot->key.data, 16 );
4093 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004094 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4095 keys,
4096 192, cipher_operation );
4097 }
4098 else
4099#endif
4100 {
4101 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004102 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004103 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004104 }
Moran Peker41deec42018-04-04 15:43:05 +03004105 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004106 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004107
David Brown63ca2602021-01-26 11:51:12 -07004108#if defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
4109 defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004110 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004111 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004112 case PSA_ALG_CBC_NO_PADDING:
4113 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4114 MBEDTLS_PADDING_NONE );
4115 break;
4116 case PSA_ALG_CBC_PKCS7:
4117 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4118 MBEDTLS_PADDING_PKCS7 );
4119 break;
4120 default:
4121 /* The algorithm doesn't involve padding. */
4122 ret = 0;
4123 break;
4124 }
4125 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004126 goto exit;
David Brown288a96e2021-02-09 16:27:55 -07004127#endif /* MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING || MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7 */
mohammad16038481e742018-03-18 13:57:31 +02004128
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004129 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004130 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004131 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4132 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004133 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004134 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004135 }
David Brown1bfe4d72021-02-16 12:54:35 -07004136#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +02004137 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004138 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004139 operation->iv_size = 12;
4140#endif
mohammad1603503973b2018-03-12 15:59:30 +02004141
Steven Cooreman7df02922020-09-09 15:28:49 +02004142 status = PSA_SUCCESS;
4143
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004144exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004145 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004146 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004147 if( status == PSA_SUCCESS )
4148 {
4149 /* Update operation flags for both driver and software implementations */
4150 operation->key_set = 1;
4151 }
4152 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004153 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004154
Ronald Cron5c522922020-11-14 16:35:34 +01004155 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004156
Ronald Cron5c522922020-11-14 16:35:34 +01004157 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004158}
4159
Gilles Peskinefe119512018-07-08 21:39:34 +02004160psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004161 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004162 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004163{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004164 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004165}
4166
Gilles Peskinefe119512018-07-08 21:39:34 +02004167psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004168 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004169 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004170{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004171 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004172}
4173
Gilles Peskinefe119512018-07-08 21:39:34 +02004174psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004175 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004176 size_t iv_size,
4177 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004178{
itayzafrir534bd7c2018-08-02 13:56:32 +03004179 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004181 if( operation->iv_set || ! operation->iv_required )
4182 {
4183 return( PSA_ERROR_BAD_STATE );
4184 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004185
Steven Cooremanef8575e2020-09-11 11:44:50 +02004186 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004187 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004188 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004189 iv,
4190 iv_size,
4191 iv_length );
4192 goto exit;
4193 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004194
Moran Peker41deec42018-04-04 15:43:05 +03004195 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004196 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004197 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004198 goto exit;
4199 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004200 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004201 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004202 if( ret != 0 )
4203 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004204 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004205 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004206 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004207
mohammad16038481e742018-03-18 13:57:31 +02004208 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004209 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004210
Moran Peker395db872018-05-31 14:07:14 +03004211exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004212 if( status == PSA_SUCCESS )
4213 operation->iv_set = 1;
4214 else
Moran Peker395db872018-05-31 14:07:14 +03004215 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004216 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004217}
4218
Gilles Peskinefe119512018-07-08 21:39:34 +02004219psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004220 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004221 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004222{
itayzafrir534bd7c2018-08-02 13:56:32 +03004223 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004224 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004225 if( operation->iv_set || ! operation->iv_required )
4226 {
4227 return( PSA_ERROR_BAD_STATE );
4228 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004229
Steven Cooremanef8575e2020-09-11 11:44:50 +02004230 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004231 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004232 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004233 iv,
4234 iv_length );
4235 goto exit;
4236 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004237
Moran Pekera28258c2018-05-29 16:25:04 +03004238 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004239 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004240 status = PSA_ERROR_INVALID_ARGUMENT;
4241 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004242 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004243 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4244 status = mbedtls_to_psa_error( ret );
4245exit:
4246 if( status == PSA_SUCCESS )
4247 operation->iv_set = 1;
4248 else
mohammad1603503973b2018-03-12 15:59:30 +02004249 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004250 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004251}
4252
Steven Cooreman177deba2020-09-07 17:14:14 +02004253/* Process input for which the algorithm is set to ECB mode. This requires
4254 * manual processing, since the PSA API is defined as being able to process
4255 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4256 * underlying mbedtls_cipher_update only takes full blocks. */
4257static psa_status_t psa_cipher_update_ecb_internal(
4258 mbedtls_cipher_context_t *ctx,
4259 const uint8_t *input,
4260 size_t input_length,
4261 uint8_t *output,
4262 size_t output_size,
4263 size_t *output_length )
4264{
4265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4266 size_t block_size = ctx->cipher_info->block_size;
4267 size_t internal_output_length = 0;
4268 *output_length = 0;
4269
4270 if( input_length == 0 )
4271 {
4272 status = PSA_SUCCESS;
4273 goto exit;
4274 }
4275
4276 if( ctx->unprocessed_len > 0 )
4277 {
4278 /* Fill up to block size, and run the block if there's a full one. */
4279 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4280
4281 if( input_length < bytes_to_copy )
4282 bytes_to_copy = input_length;
4283
4284 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4285 input, bytes_to_copy );
4286 input_length -= bytes_to_copy;
4287 input += bytes_to_copy;
4288 ctx->unprocessed_len += bytes_to_copy;
4289
4290 if( ctx->unprocessed_len == block_size )
4291 {
4292 status = mbedtls_to_psa_error(
4293 mbedtls_cipher_update( ctx,
4294 ctx->unprocessed_data,
4295 block_size,
4296 output, &internal_output_length ) );
4297
4298 if( status != PSA_SUCCESS )
4299 goto exit;
4300
4301 output += internal_output_length;
4302 output_size -= internal_output_length;
4303 *output_length += internal_output_length;
4304 ctx->unprocessed_len = 0;
4305 }
4306 }
4307
4308 while( input_length >= block_size )
4309 {
4310 /* Run all full blocks we have, one by one */
4311 status = mbedtls_to_psa_error(
4312 mbedtls_cipher_update( ctx, input,
4313 block_size,
4314 output, &internal_output_length ) );
4315
4316 if( status != PSA_SUCCESS )
4317 goto exit;
4318
4319 input_length -= block_size;
4320 input += block_size;
4321
4322 output += internal_output_length;
4323 output_size -= internal_output_length;
4324 *output_length += internal_output_length;
4325 }
4326
4327 if( input_length > 0 )
4328 {
4329 /* Save unprocessed bytes for later processing */
4330 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4331 input, input_length );
4332 ctx->unprocessed_len += input_length;
4333 }
4334
4335 status = PSA_SUCCESS;
4336
4337exit:
4338 return( status );
4339}
4340
Gilles Peskinee553c652018-06-04 16:22:46 +02004341psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4342 const uint8_t *input,
4343 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004344 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004345 size_t output_size,
4346 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004347{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004349 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004350 if( operation->alg == 0 )
4351 {
4352 return( PSA_ERROR_BAD_STATE );
4353 }
4354 if( operation->iv_required && ! operation->iv_set )
4355 {
4356 return( PSA_ERROR_BAD_STATE );
4357 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004358
Steven Cooremanef8575e2020-09-11 11:44:50 +02004359 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004360 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004361 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004362 input,
4363 input_length,
4364 output,
4365 output_size,
4366 output_length );
4367 goto exit;
4368 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004369
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004370 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004371 {
4372 /* Take the unprocessed partial block left over from previous
4373 * update calls, if any, plus the input to this call. Remove
4374 * the last partial block, if any. You get the data that will be
4375 * output in this call. */
4376 expected_output_size =
4377 ( operation->ctx.cipher.unprocessed_len + input_length )
4378 / operation->block_size * operation->block_size;
4379 }
4380 else
4381 {
4382 expected_output_size = input_length;
4383 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004384
Gilles Peskine89d789c2018-06-04 17:17:16 +02004385 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004386 {
4387 status = PSA_ERROR_BUFFER_TOO_SMALL;
4388 goto exit;
4389 }
mohammad160382759612018-03-12 18:16:40 +02004390
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004391 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4392 {
4393 /* mbedtls_cipher_update has an API inconsistency: it will only
4394 * process a single block at a time in ECB mode. Abstract away that
4395 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004396 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4397 input,
4398 input_length,
4399 output,
4400 output_size,
4401 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004402 }
4403 else
4404 {
4405 status = mbedtls_to_psa_error(
4406 mbedtls_cipher_update( &operation->ctx.cipher, input,
4407 input_length, output, output_length ) );
4408 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004409exit:
4410 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004411 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004412 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004413}
4414
Gilles Peskinee553c652018-06-04 16:22:46 +02004415psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4416 uint8_t *output,
4417 size_t output_size,
4418 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004419{
David Saadab4ecc272019-02-14 13:48:10 +02004420 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004421 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004422 if( operation->alg == 0 )
4423 {
4424 return( PSA_ERROR_BAD_STATE );
4425 }
4426 if( operation->iv_required && ! operation->iv_set )
4427 {
4428 return( PSA_ERROR_BAD_STATE );
4429 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004430
Steven Cooremanef8575e2020-09-11 11:44:50 +02004431 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004432 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004433 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004434 output,
4435 output_size,
4436 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004437 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004438 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004439
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004440 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004441 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004442 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004443 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004444 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004445 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004446 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004447 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004448 }
4449
Steven Cooremanef8575e2020-09-11 11:44:50 +02004450 status = mbedtls_to_psa_error(
4451 mbedtls_cipher_finish( &operation->ctx.cipher,
4452 temp_output_buffer,
4453 output_length ) );
4454 if( status != PSA_SUCCESS )
4455 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004456
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004457 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004458 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004459 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004460 memcpy( output, temp_output_buffer, *output_length );
4461 else
Janos Follath315b51c2018-07-09 16:04:51 +01004462 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004463
Steven Cooremanef8575e2020-09-11 11:44:50 +02004464exit:
4465 if( operation->mbedtls_in_use == 1 )
4466 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004467
Steven Cooremanef8575e2020-09-11 11:44:50 +02004468 if( status == PSA_SUCCESS )
4469 return( psa_cipher_abort( operation ) );
4470 else
4471 {
4472 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004473 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004474
Steven Cooremanef8575e2020-09-11 11:44:50 +02004475 return( status );
4476 }
mohammad1603503973b2018-03-12 15:59:30 +02004477}
4478
Gilles Peskinee553c652018-06-04 16:22:46 +02004479psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4480{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004481 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004482 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004483 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004484 * in use. It's ok to call abort on such an object, and there's
4485 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004486 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004487 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004488
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004489 /* Sanity check (shouldn't happen: operation->alg should
4490 * always have been initialized to a valid value). */
4491 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4492 return( PSA_ERROR_BAD_STATE );
4493
Steven Cooremanef8575e2020-09-11 11:44:50 +02004494 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004495 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004496 else
4497 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004498
Moran Peker41deec42018-04-04 15:43:05 +03004499 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004500 operation->key_set = 0;
4501 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004502 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004503 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004504 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004505 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004506
Moran Peker395db872018-05-31 14:07:14 +03004507 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004508}
4509
Gilles Peskinea0655c32018-04-30 17:06:50 +02004510
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004511
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004512
mohammad16035955c982018-04-26 00:53:03 +03004513/****************************************************************/
4514/* AEAD */
4515/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004516
Gilles Peskineedf9a652018-08-17 18:11:56 +02004517typedef struct
4518{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004519 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004520 const mbedtls_cipher_info_t *cipher_info;
4521 union
4522 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004523 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004524#if defined(MBEDTLS_CCM_C)
4525 mbedtls_ccm_context ccm;
4526#endif /* MBEDTLS_CCM_C */
4527#if defined(MBEDTLS_GCM_C)
4528 mbedtls_gcm_context gcm;
4529#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004530#if defined(MBEDTLS_CHACHAPOLY_C)
4531 mbedtls_chachapoly_context chachapoly;
4532#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004533 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004534 psa_algorithm_t core_alg;
4535 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004536 uint8_t tag_length;
4537} aead_operation_t;
4538
Ronald Cronf95a2b12020-10-22 15:24:49 +02004539#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4540
Gilles Peskine30a9e412019-01-14 18:36:12 +01004541static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004542{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004543 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004544 {
4545#if defined(MBEDTLS_CCM_C)
4546 case PSA_ALG_CCM:
4547 mbedtls_ccm_free( &operation->ctx.ccm );
4548 break;
4549#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004550#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004551 case PSA_ALG_GCM:
4552 mbedtls_gcm_free( &operation->ctx.gcm );
4553 break;
4554#endif /* MBEDTLS_GCM_C */
4555 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004556
Ronald Cron5c522922020-11-14 16:35:34 +01004557 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004558}
4559
4560static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004561 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004562 psa_key_usage_t usage,
4563 psa_algorithm_t alg )
4564{
4565 psa_status_t status;
4566 size_t key_bits;
4567 mbedtls_cipher_id_t cipher_id;
4568
Ronald Cron5c522922020-11-14 16:35:34 +01004569 status = psa_get_and_lock_transparent_key_slot_with_policy(
4570 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004571 if( status != PSA_SUCCESS )
4572 return( status );
4573
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004574 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004575
4576 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004577 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004578 &cipher_id );
4579 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004580 {
4581 status = PSA_ERROR_NOT_SUPPORTED;
4582 goto cleanup;
4583 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004584
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004585 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004586 {
4587#if defined(MBEDTLS_CCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004588 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004589 operation->core_alg = PSA_ALG_CCM;
4590 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004591 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4592 * The call to mbedtls_ccm_encrypt_and_tag or
4593 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004594 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004595 {
4596 status = PSA_ERROR_INVALID_ARGUMENT;
4597 goto cleanup;
4598 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004599 mbedtls_ccm_init( &operation->ctx.ccm );
4600 status = mbedtls_to_psa_error(
4601 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004602 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004603 (unsigned int) key_bits ) );
4604 if( status != 0 )
4605 goto cleanup;
4606 break;
4607#endif /* MBEDTLS_CCM_C */
4608
4609#if defined(MBEDTLS_GCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004610 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004611 operation->core_alg = PSA_ALG_GCM;
4612 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004613 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4614 * The call to mbedtls_gcm_crypt_and_tag or
4615 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004616 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004617 {
4618 status = PSA_ERROR_INVALID_ARGUMENT;
4619 goto cleanup;
4620 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004621 mbedtls_gcm_init( &operation->ctx.gcm );
4622 status = mbedtls_to_psa_error(
4623 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004624 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004625 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004626 if( status != 0 )
4627 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004628 break;
4629#endif /* MBEDTLS_GCM_C */
4630
Gilles Peskine26869f22019-05-06 15:25:00 +02004631#if defined(MBEDTLS_CHACHAPOLY_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004632 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02004633 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4634 operation->full_tag_length = 16;
4635 /* We only support the default tag length. */
4636 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004637 {
4638 status = PSA_ERROR_NOT_SUPPORTED;
4639 goto cleanup;
4640 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004641 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4642 status = mbedtls_to_psa_error(
4643 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004644 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004645 if( status != 0 )
4646 goto cleanup;
4647 break;
4648#endif /* MBEDTLS_CHACHAPOLY_C */
4649
Gilles Peskineedf9a652018-08-17 18:11:56 +02004650 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004651 status = PSA_ERROR_NOT_SUPPORTED;
4652 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004653 }
4654
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004655 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4656 {
4657 status = PSA_ERROR_INVALID_ARGUMENT;
4658 goto cleanup;
4659 }
4660 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004661
Gilles Peskineedf9a652018-08-17 18:11:56 +02004662 return( PSA_SUCCESS );
4663
4664cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004665 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004666 return( status );
4667}
4668
Ronald Croncf56a0a2020-08-04 09:51:30 +02004669psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004670 psa_algorithm_t alg,
4671 const uint8_t *nonce,
4672 size_t nonce_length,
4673 const uint8_t *additional_data,
4674 size_t additional_data_length,
4675 const uint8_t *plaintext,
4676 size_t plaintext_length,
4677 uint8_t *ciphertext,
4678 size_t ciphertext_size,
4679 size_t *ciphertext_length )
4680{
mohammad16035955c982018-04-26 00:53:03 +03004681 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004682 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004683 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004684
mohammad1603f08a5502018-06-03 15:05:47 +03004685 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004686
Ronald Croncf56a0a2020-08-04 09:51:30 +02004687 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004688 if( status != PSA_SUCCESS )
4689 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004690
Gilles Peskineedf9a652018-08-17 18:11:56 +02004691 /* For all currently supported modes, the tag is at the end of the
4692 * ciphertext. */
4693 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4694 {
4695 status = PSA_ERROR_BUFFER_TOO_SMALL;
4696 goto exit;
4697 }
4698 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004699
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004700#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004701 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004702 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004703 status = mbedtls_to_psa_error(
4704 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4705 MBEDTLS_GCM_ENCRYPT,
4706 plaintext_length,
4707 nonce, nonce_length,
4708 additional_data, additional_data_length,
4709 plaintext, ciphertext,
4710 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004711 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004712 else
4713#endif /* MBEDTLS_GCM_C */
4714#if defined(MBEDTLS_CCM_C)
4715 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004716 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004717 status = mbedtls_to_psa_error(
4718 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4719 plaintext_length,
4720 nonce, nonce_length,
4721 additional_data,
4722 additional_data_length,
4723 plaintext, ciphertext,
4724 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004725 }
mohammad16035c8845f2018-05-09 05:40:09 -07004726 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004727#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004728#if defined(MBEDTLS_CHACHAPOLY_C)
4729 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4730 {
4731 if( nonce_length != 12 || operation.tag_length != 16 )
4732 {
4733 status = PSA_ERROR_NOT_SUPPORTED;
4734 goto exit;
4735 }
4736 status = mbedtls_to_psa_error(
4737 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4738 plaintext_length,
4739 nonce,
4740 additional_data,
4741 additional_data_length,
4742 plaintext,
4743 ciphertext,
4744 tag ) );
4745 }
4746 else
4747#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004748 {
Steven Cooreman7196fef2021-02-10 17:13:28 +01004749 (void) tag;
mohammad1603554faad2018-06-03 15:07:38 +03004750 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004751 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004752
Gilles Peskineedf9a652018-08-17 18:11:56 +02004753 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4754 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004755
Gilles Peskineedf9a652018-08-17 18:11:56 +02004756exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004757 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004758 if( status == PSA_SUCCESS )
4759 *ciphertext_length = plaintext_length + operation.tag_length;
4760 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004761}
4762
Gilles Peskineee652a32018-06-01 19:23:52 +02004763/* Locate the tag in a ciphertext buffer containing the encrypted data
4764 * followed by the tag. Return the length of the part preceding the tag in
4765 * *plaintext_length. This is the size of the plaintext in modes where
4766 * the encrypted data has the same size as the plaintext, such as
4767 * CCM and GCM. */
4768static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4769 const uint8_t *ciphertext,
4770 size_t ciphertext_length,
4771 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004772 const uint8_t **p_tag )
4773{
4774 size_t payload_length;
4775 if( tag_length > ciphertext_length )
4776 return( PSA_ERROR_INVALID_ARGUMENT );
4777 payload_length = ciphertext_length - tag_length;
4778 if( payload_length > plaintext_size )
4779 return( PSA_ERROR_BUFFER_TOO_SMALL );
4780 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004781 return( PSA_SUCCESS );
4782}
4783
Ronald Croncf56a0a2020-08-04 09:51:30 +02004784psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004785 psa_algorithm_t alg,
4786 const uint8_t *nonce,
4787 size_t nonce_length,
4788 const uint8_t *additional_data,
4789 size_t additional_data_length,
4790 const uint8_t *ciphertext,
4791 size_t ciphertext_length,
4792 uint8_t *plaintext,
4793 size_t plaintext_size,
4794 size_t *plaintext_length )
4795{
mohammad16035955c982018-04-26 00:53:03 +03004796 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004797 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004798 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004799
Gilles Peskineee652a32018-06-01 19:23:52 +02004800 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004801
Ronald Croncf56a0a2020-08-04 09:51:30 +02004802 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004803 if( status != PSA_SUCCESS )
4804 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004805
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004806 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4807 ciphertext, ciphertext_length,
4808 plaintext_size, &tag );
4809 if( status != PSA_SUCCESS )
4810 goto exit;
4811
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004812#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004813 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004814 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004815 status = mbedtls_to_psa_error(
4816 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4817 ciphertext_length - operation.tag_length,
4818 nonce, nonce_length,
4819 additional_data,
4820 additional_data_length,
4821 tag, operation.tag_length,
4822 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004823 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004824 else
4825#endif /* MBEDTLS_GCM_C */
4826#if defined(MBEDTLS_CCM_C)
4827 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004828 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004829 status = mbedtls_to_psa_error(
4830 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4831 ciphertext_length - operation.tag_length,
4832 nonce, nonce_length,
4833 additional_data,
4834 additional_data_length,
4835 ciphertext, plaintext,
4836 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004837 }
mohammad160339574652018-06-01 04:39:53 -07004838 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004839#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004840#if defined(MBEDTLS_CHACHAPOLY_C)
4841 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4842 {
4843 if( nonce_length != 12 || operation.tag_length != 16 )
4844 {
4845 status = PSA_ERROR_NOT_SUPPORTED;
4846 goto exit;
4847 }
4848 status = mbedtls_to_psa_error(
4849 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4850 ciphertext_length - operation.tag_length,
4851 nonce,
4852 additional_data,
4853 additional_data_length,
4854 tag,
4855 ciphertext,
4856 plaintext ) );
4857 }
4858 else
4859#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004860 {
mohammad1603554faad2018-06-03 15:07:38 +03004861 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004862 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004863
Gilles Peskineedf9a652018-08-17 18:11:56 +02004864 if( status != PSA_SUCCESS && plaintext_size != 0 )
4865 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004866
Gilles Peskineedf9a652018-08-17 18:11:56 +02004867exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004868 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004869 if( status == PSA_SUCCESS )
4870 *plaintext_length = ciphertext_length - operation.tag_length;
4871 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004872}
4873
Gilles Peskinea0655c32018-04-30 17:06:50 +02004874
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004875
Gilles Peskine20035e32018-02-03 22:44:14 +01004876/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004877/* Generators */
4878/****************************************************************/
4879
John Durkop07cc04a2020-11-16 22:08:34 -08004880#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4881 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4882 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4883#define AT_LEAST_ONE_BUILTIN_KDF
4884#endif
4885
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004886#define HKDF_STATE_INIT 0 /* no input yet */
4887#define HKDF_STATE_STARTED 1 /* got salt */
4888#define HKDF_STATE_KEYED 2 /* got key */
4889#define HKDF_STATE_OUTPUT 3 /* output started */
4890
Gilles Peskinecbe66502019-05-16 16:59:18 +02004891static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004892 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004893{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004894 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4895 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004896 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004897 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004898}
4899
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004900psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004901{
4902 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004903 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004904 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004905 {
4906 /* The object has (apparently) been initialized but it is not
4907 * in use. It's ok to call abort on such an object, and there's
4908 * nothing to do. */
4909 }
4910 else
John Durkopd0321952020-10-29 21:37:36 -07004911#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004912 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004913 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004914 mbedtls_free( operation->ctx.hkdf.info );
4915 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004916 }
John Durkop07cc04a2020-11-16 22:08:34 -08004917 else
4918#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4919#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4920 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4921 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004922 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004923 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004924 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004925 if( operation->ctx.tls12_prf.seed != NULL )
4926 {
4927 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4928 operation->ctx.tls12_prf.seed_length );
4929 mbedtls_free( operation->ctx.tls12_prf.seed );
4930 }
4931
4932 if( operation->ctx.tls12_prf.label != NULL )
4933 {
4934 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4935 operation->ctx.tls12_prf.label_length );
4936 mbedtls_free( operation->ctx.tls12_prf.label );
4937 }
4938
4939 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4940
4941 /* We leave the fields Ai and output_block to be erased safely by the
4942 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004943 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004944 else
John Durkop07cc04a2020-11-16 22:08:34 -08004945#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4946 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004947 {
4948 status = PSA_ERROR_BAD_STATE;
4949 }
Janos Follath083036a2019-06-11 10:22:26 +01004950 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004951 return( status );
4952}
4953
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004954psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004955 size_t *capacity)
4956{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004957 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004958 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004959 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004960 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004961 }
4962
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004963 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004964 return( PSA_SUCCESS );
4965}
4966
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004968 size_t capacity )
4969{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004970 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004971 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004972 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004973 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004974 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004975 return( PSA_SUCCESS );
4976}
4977
John Durkopd0321952020-10-29 21:37:36 -07004978#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004979/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004980 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004981static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004982 psa_algorithm_t hash_alg,
4983 uint8_t *output,
4984 size_t output_length )
4985{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004986 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004987 psa_status_t status;
4988
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004989 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4990 return( PSA_ERROR_BAD_STATE );
4991 hkdf->state = HKDF_STATE_OUTPUT;
4992
Gilles Peskinebef7f142018-07-12 17:22:21 +02004993 while( output_length != 0 )
4994 {
4995 /* Copy what remains of the current block */
4996 uint8_t n = hash_length - hkdf->offset_in_block;
4997 if( n > output_length )
4998 n = (uint8_t) output_length;
4999 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5000 output += n;
5001 output_length -= n;
5002 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005003 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005004 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005005 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005006 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005007 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005008 * object was corrupted or if this function is called directly
5009 * inside the library. */
5010 if( hkdf->block_number == 0xff )
5011 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005012
5013 /* We need a new block */
5014 ++hkdf->block_number;
5015 hkdf->offset_in_block = 0;
5016 status = psa_hmac_setup_internal( &hkdf->hmac,
5017 hkdf->prk, hash_length,
5018 hash_alg );
5019 if( status != PSA_SUCCESS )
5020 return( status );
5021 if( hkdf->block_number != 1 )
5022 {
5023 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5024 hkdf->output_block,
5025 hash_length );
5026 if( status != PSA_SUCCESS )
5027 return( status );
5028 }
5029 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5030 hkdf->info,
5031 hkdf->info_length );
5032 if( status != PSA_SUCCESS )
5033 return( status );
5034 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5035 &hkdf->block_number, 1 );
5036 if( status != PSA_SUCCESS )
5037 return( status );
5038 status = psa_hmac_finish_internal( &hkdf->hmac,
5039 hkdf->output_block,
5040 sizeof( hkdf->output_block ) );
5041 if( status != PSA_SUCCESS )
5042 return( status );
5043 }
5044
5045 return( PSA_SUCCESS );
5046}
John Durkop07cc04a2020-11-16 22:08:34 -08005047#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005048
John Durkop07cc04a2020-11-16 22:08:34 -08005049#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5050 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005051static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5052 psa_tls12_prf_key_derivation_t *tls12_prf,
5053 psa_algorithm_t alg )
5054{
5055 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005056 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005057 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5058 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005059
Janos Follath7742fee2019-06-17 12:58:10 +01005060 /* We can't be wanting more output after block 0xff, otherwise
5061 * the capacity check in psa_key_derivation_output_bytes() would have
5062 * prevented this call. It could happen only if the operation
5063 * object was corrupted or if this function is called directly
5064 * inside the library. */
5065 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005066 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005067
5068 /* We need a new block */
5069 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005070 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005071
5072 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5073 *
5074 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5075 *
5076 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5077 * HMAC_hash(secret, A(2) + seed) +
5078 * HMAC_hash(secret, A(3) + seed) + ...
5079 *
5080 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005081 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005082 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005083 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005084 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005085 * is currently extracted as `output_block` and where i is
5086 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005087 */
5088
Janos Follathea29bfb2019-06-19 12:21:20 +01005089 /* Save the hash context before using it, to preserve the hash state with
5090 * only the inner padding in it. We need this, because inner padding depends
5091 * on the key (secret in the RFC's terminology). */
5092 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5093 if( status != PSA_SUCCESS )
5094 goto cleanup;
5095
5096 /* Calculate A(i) where i = tls12_prf->block_number. */
5097 if( tls12_prf->block_number == 1 )
5098 {
5099 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5100 * the variable seed and in this instance means it in the context of the
5101 * P_hash function, where seed = label + seed.) */
5102 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5103 tls12_prf->label, tls12_prf->label_length );
5104 if( status != PSA_SUCCESS )
5105 goto cleanup;
5106 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5107 tls12_prf->seed, tls12_prf->seed_length );
5108 if( status != PSA_SUCCESS )
5109 goto cleanup;
5110 }
5111 else
5112 {
5113 /* A(i) = HMAC_hash(secret, A(i-1)) */
5114 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5115 tls12_prf->Ai, hash_length );
5116 if( status != PSA_SUCCESS )
5117 goto cleanup;
5118 }
5119
5120 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5121 tls12_prf->Ai, hash_length );
5122 if( status != PSA_SUCCESS )
5123 goto cleanup;
5124 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5125 if( status != PSA_SUCCESS )
5126 goto cleanup;
5127
5128 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5129 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5130 tls12_prf->Ai, hash_length );
5131 if( status != PSA_SUCCESS )
5132 goto cleanup;
5133 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5134 tls12_prf->label, tls12_prf->label_length );
5135 if( status != PSA_SUCCESS )
5136 goto cleanup;
5137 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5138 tls12_prf->seed, tls12_prf->seed_length );
5139 if( status != PSA_SUCCESS )
5140 goto cleanup;
5141 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5142 tls12_prf->output_block, hash_length );
5143 if( status != PSA_SUCCESS )
5144 goto cleanup;
5145 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5146 if( status != PSA_SUCCESS )
5147 goto cleanup;
5148
Janos Follath7742fee2019-06-17 12:58:10 +01005149
5150cleanup:
5151
Janos Follathea29bfb2019-06-19 12:21:20 +01005152 cleanup_status = psa_hash_abort( &backup );
5153 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5154 status = cleanup_status;
5155
5156 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005157}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005158
Janos Follath844eb0e2019-06-19 12:10:49 +01005159static psa_status_t psa_key_derivation_tls12_prf_read(
5160 psa_tls12_prf_key_derivation_t *tls12_prf,
5161 psa_algorithm_t alg,
5162 uint8_t *output,
5163 size_t output_length )
5164{
5165 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005166 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005167 psa_status_t status;
5168 uint8_t offset, length;
5169
5170 while( output_length != 0 )
5171 {
5172 /* Check if we have fully processed the current block. */
5173 if( tls12_prf->left_in_block == 0 )
5174 {
5175 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5176 alg );
5177 if( status != PSA_SUCCESS )
5178 return( status );
5179
5180 continue;
5181 }
5182
5183 if( tls12_prf->left_in_block > output_length )
5184 length = (uint8_t) output_length;
5185 else
5186 length = tls12_prf->left_in_block;
5187
5188 offset = hash_length - tls12_prf->left_in_block;
5189 memcpy( output, tls12_prf->output_block + offset, length );
5190 output += length;
5191 output_length -= length;
5192 tls12_prf->left_in_block -= length;
5193 }
5194
5195 return( PSA_SUCCESS );
5196}
John Durkop07cc04a2020-11-16 22:08:34 -08005197#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5198 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005199
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005200psa_status_t psa_key_derivation_output_bytes(
5201 psa_key_derivation_operation_t *operation,
5202 uint8_t *output,
5203 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005204{
5205 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005206 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005207
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005208 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005209 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005210 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005211 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005212 }
5213
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005214 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005215 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005216 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005217 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005219 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005220 goto exit;
5221 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005222 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005223 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005224 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005225 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005226 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5227 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005228 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005229 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005230 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005231 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005232 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005233
John Durkopd0321952020-10-29 21:37:36 -07005234#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005235 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005236 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005237 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005238 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005239 output, output_length );
5240 }
Janos Follathadbec812019-06-14 11:05:39 +01005241 else
John Durkop07cc04a2020-11-16 22:08:34 -08005242#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5243#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5244 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005245 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005246 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005247 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005248 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005249 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005250 output_length );
5251 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005252 else
John Durkop07cc04a2020-11-16 22:08:34 -08005253#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5254 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005255 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005256 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005257 return( PSA_ERROR_BAD_STATE );
5258 }
5259
5260exit:
5261 if( status != PSA_SUCCESS )
5262 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005263 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264 * This allows us to differentiate between exhausted operations and
5265 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5266 * operations. */
5267 psa_algorithm_t alg = operation->alg;
5268 psa_key_derivation_abort( operation );
5269 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005270 memset( output, '!', output_length );
5271 }
5272 return( status );
5273}
5274
David Brown7807bf72021-02-09 16:28:23 -07005275#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02005276static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5277{
5278 if( data_size >= 8 )
5279 mbedtls_des_key_set_parity( data );
5280 if( data_size >= 16 )
5281 mbedtls_des_key_set_parity( data + 8 );
5282 if( data_size >= 24 )
5283 mbedtls_des_key_set_parity( data + 16 );
5284}
David Brown7807bf72021-02-09 16:28:23 -07005285#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005286
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005287static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005288 psa_key_slot_t *slot,
5289 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005290 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005291{
5292 uint8_t *data = NULL;
5293 size_t bytes = PSA_BITS_TO_BYTES( bits );
5294 psa_status_t status;
5295
Gilles Peskine8e338702019-07-30 20:06:31 +02005296 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005297 return( PSA_ERROR_INVALID_ARGUMENT );
5298 if( bits % 8 != 0 )
5299 return( PSA_ERROR_INVALID_ARGUMENT );
5300 data = mbedtls_calloc( 1, bytes );
5301 if( data == NULL )
5302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5303
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005304 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005305 if( status != PSA_SUCCESS )
5306 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07005307#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02005308 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005309 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07005310#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01005311
5312 status = psa_allocate_buffer_to_slot( slot, bytes );
5313 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00005314 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01005315
Ronald Cronbf33c932020-11-28 18:06:53 +01005316 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005317 psa_key_attributes_t attributes = {
5318 .core = slot->attr
5319 };
5320
Ronald Cronbf33c932020-11-28 18:06:53 +01005321 status = psa_driver_wrapper_import_key( &attributes,
5322 data, bytes,
5323 slot->key.data,
5324 slot->key.bytes,
5325 &slot->key.bytes, &bits );
5326 if( bits != slot->attr.bits )
5327 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005328
5329exit:
5330 mbedtls_free( data );
5331 return( status );
5332}
5333
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005334psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005335 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005336 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005337{
5338 psa_status_t status;
5339 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005340 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005341
Ronald Cron81709fc2020-11-14 12:10:32 +01005342 *key = MBEDTLS_SVC_KEY_ID_INIT;
5343
Gilles Peskine0f84d622019-09-12 19:03:13 +02005344 /* Reject any attempt to create a zero-length key so that we don't
5345 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5346 if( psa_get_key_bits( attributes ) == 0 )
5347 return( PSA_ERROR_INVALID_ARGUMENT );
5348
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005349 if( ! operation->can_output_key )
5350 return( PSA_ERROR_NOT_PERMITTED );
5351
Ronald Cron81709fc2020-11-14 12:10:32 +01005352 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5353 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005354#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5355 if( driver != NULL )
5356 {
5357 /* Deriving a key in a secure element is not implemented yet. */
5358 status = PSA_ERROR_NOT_SUPPORTED;
5359 }
5360#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005361 if( status == PSA_SUCCESS )
5362 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005363 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005364 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005365 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005366 }
5367 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005368 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005369 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005370 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005371
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005372 return( status );
5373}
5374
Gilles Peskineeab56e42018-07-12 17:12:33 +02005375
5376
5377/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005378/* Key derivation */
5379/****************************************************************/
5380
Steven Cooreman932ffb72021-02-15 12:14:32 +01005381#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005382static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005383 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005384 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005385{
John Durkop07cc04a2020-11-16 22:08:34 -08005386 int is_kdf_alg_supported;
5387
Janos Follath5fe19732019-06-20 15:09:30 +01005388 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5389 * initialisers for this union leave some bytes unspecified.) */
5390 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5391
Gilles Peskine969c5d62019-01-16 15:53:06 +01005392 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005393#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005394 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5395 is_kdf_alg_supported = 1;
5396 else
5397#endif
5398#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5399 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5400 is_kdf_alg_supported = 1;
5401 else
5402#endif
5403#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5404 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5405 is_kdf_alg_supported = 1;
5406 else
5407#endif
5408 is_kdf_alg_supported = 0;
5409
5410 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005411 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005412 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005413 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005414 if( hash_size == 0 )
5415 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005416 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5417 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005418 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005419 {
5420 return( PSA_ERROR_NOT_SUPPORTED );
5421 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005422 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005423 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005424 }
John Durkop07cc04a2020-11-16 22:08:34 -08005425
5426 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005427}
John Durkop07cc04a2020-11-16 22:08:34 -08005428#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005429
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005430psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005431 psa_algorithm_t alg )
5432{
5433 psa_status_t status;
5434
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005435 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005436 return( PSA_ERROR_BAD_STATE );
5437
Gilles Peskine6843c292019-01-18 16:44:49 +01005438 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5439 return( PSA_ERROR_INVALID_ARGUMENT );
5440 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005441 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005442#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005443 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005444 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005445#else
5446 return( PSA_ERROR_NOT_SUPPORTED );
5447#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005448 }
5449 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5450 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005451#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005452 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005453#else
5454 return( PSA_ERROR_NOT_SUPPORTED );
5455#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005456 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005457 else
5458 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005459
5460 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005461 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005462 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005463}
5464
John Durkopd0321952020-10-29 21:37:36 -07005465#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005466static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005467 psa_algorithm_t hash_alg,
5468 psa_key_derivation_step_t step,
5469 const uint8_t *data,
5470 size_t data_length )
5471{
5472 psa_status_t status;
5473 switch( step )
5474 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005475 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005476 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005477 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005478 status = psa_hmac_setup_internal( &hkdf->hmac,
5479 data, data_length,
5480 hash_alg );
5481 if( status != PSA_SUCCESS )
5482 return( status );
5483 hkdf->state = HKDF_STATE_STARTED;
5484 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005485 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005486 /* If no salt was provided, use an empty salt. */
5487 if( hkdf->state == HKDF_STATE_INIT )
5488 {
5489 status = psa_hmac_setup_internal( &hkdf->hmac,
5490 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005491 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005492 if( status != PSA_SUCCESS )
5493 return( status );
5494 hkdf->state = HKDF_STATE_STARTED;
5495 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005496 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005497 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005498 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5499 data, data_length );
5500 if( status != PSA_SUCCESS )
5501 return( status );
5502 status = psa_hmac_finish_internal( &hkdf->hmac,
5503 hkdf->prk,
5504 sizeof( hkdf->prk ) );
5505 if( status != PSA_SUCCESS )
5506 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005507 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005508 hkdf->block_number = 0;
5509 hkdf->state = HKDF_STATE_KEYED;
5510 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005511 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005512 if( hkdf->state == HKDF_STATE_OUTPUT )
5513 return( PSA_ERROR_BAD_STATE );
5514 if( hkdf->info_set )
5515 return( PSA_ERROR_BAD_STATE );
5516 hkdf->info_length = data_length;
5517 if( data_length != 0 )
5518 {
5519 hkdf->info = mbedtls_calloc( 1, data_length );
5520 if( hkdf->info == NULL )
5521 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5522 memcpy( hkdf->info, data, data_length );
5523 }
5524 hkdf->info_set = 1;
5525 return( PSA_SUCCESS );
5526 default:
5527 return( PSA_ERROR_INVALID_ARGUMENT );
5528 }
5529}
John Durkop07cc04a2020-11-16 22:08:34 -08005530#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005531
John Durkop07cc04a2020-11-16 22:08:34 -08005532#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5533 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005534static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5535 const uint8_t *data,
5536 size_t data_length )
5537{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005538 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005539 return( PSA_ERROR_BAD_STATE );
5540
Janos Follathd6dce9f2019-07-04 09:11:38 +01005541 if( data_length != 0 )
5542 {
5543 prf->seed = mbedtls_calloc( 1, data_length );
5544 if( prf->seed == NULL )
5545 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005546
Janos Follathd6dce9f2019-07-04 09:11:38 +01005547 memcpy( prf->seed, data, data_length );
5548 prf->seed_length = data_length;
5549 }
Janos Follathf08e2652019-06-13 09:05:41 +01005550
Gilles Peskine43f958b2020-12-13 14:55:14 +01005551 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005552
5553 return( PSA_SUCCESS );
5554}
5555
Janos Follath81550542019-06-13 14:26:34 +01005556static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5557 psa_algorithm_t hash_alg,
5558 const uint8_t *data,
5559 size_t data_length )
5560{
5561 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01005562 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01005563 return( PSA_ERROR_BAD_STATE );
5564
5565 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5566 if( status != PSA_SUCCESS )
5567 return( status );
5568
Gilles Peskine43f958b2020-12-13 14:55:14 +01005569 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005570
5571 return( PSA_SUCCESS );
5572}
5573
Janos Follath63028dd2019-06-13 09:15:47 +01005574static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5575 const uint8_t *data,
5576 size_t data_length )
5577{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005578 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005579 return( PSA_ERROR_BAD_STATE );
5580
Janos Follathd6dce9f2019-07-04 09:11:38 +01005581 if( data_length != 0 )
5582 {
5583 prf->label = mbedtls_calloc( 1, data_length );
5584 if( prf->label == NULL )
5585 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005586
Janos Follathd6dce9f2019-07-04 09:11:38 +01005587 memcpy( prf->label, data, data_length );
5588 prf->label_length = data_length;
5589 }
Janos Follath63028dd2019-06-13 09:15:47 +01005590
Gilles Peskine43f958b2020-12-13 14:55:14 +01005591 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005592
5593 return( PSA_SUCCESS );
5594}
5595
Janos Follathb03233e2019-06-11 15:30:30 +01005596static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5597 psa_algorithm_t hash_alg,
5598 psa_key_derivation_step_t step,
5599 const uint8_t *data,
5600 size_t data_length )
5601{
Janos Follathb03233e2019-06-11 15:30:30 +01005602 switch( step )
5603 {
Janos Follathf08e2652019-06-13 09:05:41 +01005604 case PSA_KEY_DERIVATION_INPUT_SEED:
5605 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005606 case PSA_KEY_DERIVATION_INPUT_SECRET:
5607 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005608 case PSA_KEY_DERIVATION_INPUT_LABEL:
5609 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005610 default:
5611 return( PSA_ERROR_INVALID_ARGUMENT );
5612 }
5613}
John Durkop07cc04a2020-11-16 22:08:34 -08005614#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5615 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5616
5617#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5618static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5619 psa_tls12_prf_key_derivation_t *prf,
5620 psa_algorithm_t hash_alg,
5621 const uint8_t *data,
5622 size_t data_length )
5623{
5624 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005625 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005626 uint8_t *cur = pms;
5627
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005628 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005629 return( PSA_ERROR_INVALID_ARGUMENT );
5630
5631 /* Quoting RFC 4279, Section 2:
5632 *
5633 * The premaster secret is formed as follows: if the PSK is N octets
5634 * long, concatenate a uint16 with the value N, N zero octets, a second
5635 * uint16 with the value N, and the PSK itself.
5636 */
5637
5638 *cur++ = ( data_length >> 8 ) & 0xff;
5639 *cur++ = ( data_length >> 0 ) & 0xff;
5640 memset( cur, 0, data_length );
5641 cur += data_length;
5642 *cur++ = pms[0];
5643 *cur++ = pms[1];
5644 memcpy( cur, data, data_length );
5645 cur += data_length;
5646
5647 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5648
5649 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5650 return( status );
5651}
Janos Follath6660f0e2019-06-17 08:44:03 +01005652
5653static psa_status_t psa_tls12_prf_psk_to_ms_input(
5654 psa_tls12_prf_key_derivation_t *prf,
5655 psa_algorithm_t hash_alg,
5656 psa_key_derivation_step_t step,
5657 const uint8_t *data,
5658 size_t data_length )
5659{
5660 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005661 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005662 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5663 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005664 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005665
5666 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5667}
John Durkop07cc04a2020-11-16 22:08:34 -08005668#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005669
Gilles Peskineb8965192019-09-24 16:21:10 +02005670/** Check whether the given key type is acceptable for the given
5671 * input step of a key derivation.
5672 *
5673 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5674 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5675 * Both secret and non-secret inputs can alternatively have the type
5676 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5677 * that the input was passed as a buffer rather than via a key object.
5678 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005679static int psa_key_derivation_check_input_type(
5680 psa_key_derivation_step_t step,
5681 psa_key_type_t key_type )
5682{
5683 switch( step )
5684 {
5685 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005686 if( key_type == PSA_KEY_TYPE_DERIVE )
5687 return( PSA_SUCCESS );
5688 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005689 return( PSA_SUCCESS );
5690 break;
5691 case PSA_KEY_DERIVATION_INPUT_LABEL:
5692 case PSA_KEY_DERIVATION_INPUT_SALT:
5693 case PSA_KEY_DERIVATION_INPUT_INFO:
5694 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005695 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5696 return( PSA_SUCCESS );
5697 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005698 return( PSA_SUCCESS );
5699 break;
5700 }
5701 return( PSA_ERROR_INVALID_ARGUMENT );
5702}
5703
Janos Follathb80a94e2019-06-12 15:54:46 +01005704static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005705 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005706 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005707 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005708 const uint8_t *data,
5709 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005710{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005711 psa_status_t status;
5712 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5713
5714 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005715 if( status != PSA_SUCCESS )
5716 goto exit;
5717
John Durkopd0321952020-10-29 21:37:36 -07005718#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005719 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005720 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005721 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005722 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005723 step, data, data_length );
5724 }
John Durkop07cc04a2020-11-16 22:08:34 -08005725 else
5726#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5727#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5728 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005729 {
Janos Follathb03233e2019-06-11 15:30:30 +01005730 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5731 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5732 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005733 }
John Durkop07cc04a2020-11-16 22:08:34 -08005734 else
5735#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5736#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5737 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005738 {
5739 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5740 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5741 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005742 }
5743 else
John Durkop07cc04a2020-11-16 22:08:34 -08005744#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005745 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005746 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005747 (void) data;
5748 (void) data_length;
5749 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005750 return( PSA_ERROR_BAD_STATE );
5751 }
5752
Gilles Peskine224b0d62019-09-23 18:13:17 +02005753exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005754 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005755 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005756 return( status );
5757}
5758
Janos Follath51f4a0f2019-06-14 11:35:55 +01005759psa_status_t psa_key_derivation_input_bytes(
5760 psa_key_derivation_operation_t *operation,
5761 psa_key_derivation_step_t step,
5762 const uint8_t *data,
5763 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005764{
Gilles Peskineb8965192019-09-24 16:21:10 +02005765 return( psa_key_derivation_input_internal( operation, step,
5766 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005767 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005768}
5769
Janos Follath51f4a0f2019-06-14 11:35:55 +01005770psa_status_t psa_key_derivation_input_key(
5771 psa_key_derivation_operation_t *operation,
5772 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005773 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005774{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005775 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005776 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005777 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005778
Ronald Cron5c522922020-11-14 16:35:34 +01005779 status = psa_get_and_lock_transparent_key_slot_with_policy(
5780 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005781 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005782 {
5783 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005784 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005785 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005786
5787 /* Passing a key object as a SECRET input unlocks the permission
5788 * to output to a key object. */
5789 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5790 operation->can_output_key = 1;
5791
Ronald Cronf95a2b12020-10-22 15:24:49 +02005792 status = psa_key_derivation_input_internal( operation,
5793 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005794 slot->key.data,
5795 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005796
Ronald Cron5c522922020-11-14 16:35:34 +01005797 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005798
Ronald Cron5c522922020-11-14 16:35:34 +01005799 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005800}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005801
5802
5803
5804/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005805/* Key agreement */
5806/****************************************************************/
5807
John Durkop6ba40d12020-11-10 08:50:04 -08005808#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005809static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5810 size_t peer_key_length,
5811 const mbedtls_ecp_keypair *our_key,
5812 uint8_t *shared_secret,
5813 size_t shared_secret_size,
5814 size_t *shared_secret_length )
5815{
Steven Cooremand4867872020-08-05 16:31:39 +02005816 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005817 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005818 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005819 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005820 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005821 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005822
Ronald Cron90857082020-11-25 14:58:33 +01005823 status = mbedtls_psa_ecp_load_representation(
5824 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005825 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005826 peer_key,
5827 peer_key_length,
5828 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005829 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005830 goto exit;
5831
Jaeden Amero97271b32019-01-10 19:38:51 +00005832 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005833 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005834 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005835 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005836 status = mbedtls_to_psa_error(
5837 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5838 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005839 goto exit;
5840
Jaeden Amero97271b32019-01-10 19:38:51 +00005841 status = mbedtls_to_psa_error(
5842 mbedtls_ecdh_calc_secret( &ecdh,
5843 shared_secret_length,
5844 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005845 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005846 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005847 if( status != PSA_SUCCESS )
5848 goto exit;
5849 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5850 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005851
5852exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005853 if( status != PSA_SUCCESS )
5854 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005855 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005856 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005857 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005858
Jaeden Amero97271b32019-01-10 19:38:51 +00005859 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005860}
John Durkop6ba40d12020-11-10 08:50:04 -08005861#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005862
Gilles Peskine01d718c2018-09-18 12:01:02 +02005863#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5864
Gilles Peskine0216fe12019-04-11 21:23:21 +02005865static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5866 psa_key_slot_t *private_key,
5867 const uint8_t *peer_key,
5868 size_t peer_key_length,
5869 uint8_t *shared_secret,
5870 size_t shared_secret_size,
5871 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005872{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005873 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005874 {
John Durkop6ba40d12020-11-10 08:50:04 -08005875#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005876 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005877 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005878 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005879 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005880 psa_status_t status = mbedtls_psa_ecp_load_representation(
5881 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005882 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005883 private_key->key.data,
5884 private_key->key.bytes,
5885 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005886 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005887 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005888 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005889 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005890 shared_secret, shared_secret_size,
5891 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005892 mbedtls_ecp_keypair_free( ecp );
5893 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005894 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005895#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005896 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005897 (void) private_key;
5898 (void) peer_key;
5899 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005900 (void) shared_secret;
5901 (void) shared_secret_size;
5902 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005903 return( PSA_ERROR_NOT_SUPPORTED );
5904 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005905}
5906
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005907/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005908 * to potentially free embedded data structures and wipe confidential data.
5909 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005910static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005911 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005912 psa_key_slot_t *private_key,
5913 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005914 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005915{
5916 psa_status_t status;
5917 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5918 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005919 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005920
5921 /* Step 1: run the secret agreement algorithm to generate the shared
5922 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005923 status = psa_key_agreement_raw_internal( ka_alg,
5924 private_key,
5925 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005926 shared_secret,
5927 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005928 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005929 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005930 goto exit;
5931
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005932 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005933 * the shared secret. A shared secret is permitted wherever a key
5934 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005935 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005936 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005937 shared_secret,
5938 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005939exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005940 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005941 return( status );
5942}
5943
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005944psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005945 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005946 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005947 const uint8_t *peer_key,
5948 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005949{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005950 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005951 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005952 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005953
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005954 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005955 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005956 status = psa_get_and_lock_transparent_key_slot_with_policy(
5957 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005958 if( status != PSA_SUCCESS )
5959 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005960 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005961 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005962 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005963 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005964 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005965 else
5966 {
5967 /* If a private key has been added as SECRET, we allow the derived
5968 * key material to be used as a key in PSA Crypto. */
5969 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5970 operation->can_output_key = 1;
5971 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005972
Ronald Cron5c522922020-11-14 16:35:34 +01005973 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005974
Ronald Cron5c522922020-11-14 16:35:34 +01005975 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005976}
5977
Gilles Peskinebe697d82019-05-16 18:00:41 +02005978psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005979 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005980 const uint8_t *peer_key,
5981 size_t peer_key_length,
5982 uint8_t *output,
5983 size_t output_size,
5984 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005985{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005986 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005987 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005988 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005989
5990 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5991 {
5992 status = PSA_ERROR_INVALID_ARGUMENT;
5993 goto exit;
5994 }
Ronald Cron5c522922020-11-14 16:35:34 +01005995 status = psa_get_and_lock_transparent_key_slot_with_policy(
5996 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005997 if( status != PSA_SUCCESS )
5998 goto exit;
5999
6000 status = psa_key_agreement_raw_internal( alg, slot,
6001 peer_key, peer_key_length,
6002 output, output_size,
6003 output_length );
6004
6005exit:
6006 if( status != PSA_SUCCESS )
6007 {
6008 /* If an error happens and is not handled properly, the output
6009 * may be used as a key to protect sensitive data. Arrange for such
6010 * a key to be random, which is likely to result in decryption or
6011 * verification errors. This is better than filling the buffer with
6012 * some constant data such as zeros, which would result in the data
6013 * being protected with a reproducible, easily knowable key.
6014 */
6015 psa_generate_random( output, output_size );
6016 *output_length = output_size;
6017 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006018
Ronald Cron5c522922020-11-14 16:35:34 +01006019 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006020
Ronald Cron5c522922020-11-14 16:35:34 +01006021 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006022}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006023
6024
Gilles Peskine30524eb2020-11-13 17:02:26 +01006025
Gilles Peskine86a440b2018-11-12 18:39:40 +01006026/****************************************************************/
6027/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006028/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006029
Gilles Peskine30524eb2020-11-13 17:02:26 +01006030/** Initialize the PSA random generator.
6031 */
6032static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
6033{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006034#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6035 memset( rng, 0, sizeof( *rng ) );
6036#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6037
Gilles Peskine30524eb2020-11-13 17:02:26 +01006038 /* Set default configuration if
6039 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6040 if( rng->entropy_init == NULL )
6041 rng->entropy_init = mbedtls_entropy_init;
6042 if( rng->entropy_free == NULL )
6043 rng->entropy_free = mbedtls_entropy_free;
6044
6045 rng->entropy_init( &rng->entropy );
6046#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6047 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6048 /* The PSA entropy injection feature depends on using NV seed as an entropy
6049 * source. Add NV seed as an entropy source for PSA entropy injection. */
6050 mbedtls_entropy_add_source( &rng->entropy,
6051 mbedtls_nv_seed_poll, NULL,
6052 MBEDTLS_ENTROPY_BLOCK_SIZE,
6053 MBEDTLS_ENTROPY_SOURCE_STRONG );
6054#endif
6055
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006056 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006057#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006058}
6059
6060/** Deinitialize the PSA random generator.
6061 */
6062static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6063{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006064#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6065 memset( rng, 0, sizeof( *rng ) );
6066#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006067 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006068 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006069#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006070}
6071
6072/** Seed the PSA random generator.
6073 */
6074static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6075{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006076#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6077 /* Do nothing: the external RNG seeds itself. */
6078 (void) rng;
6079 return( PSA_SUCCESS );
6080#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006081 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006082 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
6083 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006084 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006085#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006086}
6087
Gilles Peskinee59236f2018-01-27 23:32:46 +01006088psa_status_t psa_generate_random( uint8_t *output,
6089 size_t output_size )
6090{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006091 GUARD_MODULE_INITIALIZED;
6092
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006093#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6094
6095 size_t output_length = 0;
6096 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6097 output, output_size,
6098 &output_length );
6099 if( status != PSA_SUCCESS )
6100 return( status );
6101 /* Breaking up a request into smaller chunks is currently not supported
6102 * for the extrernal RNG interface. */
6103 if( output_length != output_size )
6104 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6105 return( PSA_SUCCESS );
6106
6107#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6108
Gilles Peskine71ddab92021-01-04 21:01:07 +01006109 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006110 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006111 size_t request_size =
6112 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6113 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6114 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006115 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6116 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006117 if( ret != 0 )
6118 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006119 output_size -= request_size;
6120 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006121 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006122 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006123#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006124}
6125
Gilles Peskine8814fc42020-12-14 15:33:44 +01006126/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006127 *
6128 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6129 * `psa_generate_random(...)`. The state parameter is ignored since the
6130 * PSA API doesn't support passing an explicit state.
6131 *
6132 * In the non-external case, psa_generate_random() calls an
6133 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6134 * and semantics as mbedtls_psa_get_random(). As an optimization,
6135 * instead of doing this back-and-forth between the PSA API and the
6136 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6137 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006138 */
6139#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6140int mbedtls_psa_get_random( void *p_rng,
6141 unsigned char *output,
6142 size_t output_size )
6143{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006144 /* This function takes a pointer to the RNG state because that's what
6145 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6146 * its own state internally and doesn't let the caller access that state.
6147 * So we just ignore the state parameter, and in practice we'll pass
6148 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006149 (void) p_rng;
6150 psa_status_t status = psa_generate_random( output, output_size );
6151 if( status == PSA_SUCCESS )
6152 return( 0 );
6153 else
6154 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6155}
6156#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6157
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006158#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6159#include "mbedtls/entropy_poll.h"
6160
Gilles Peskine7228da22019-07-15 11:06:15 +02006161psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006162 size_t seed_size )
6163{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006164 if( global_data.initialized )
6165 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006166
6167 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6168 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6169 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6170 return( PSA_ERROR_INVALID_ARGUMENT );
6171
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006172 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006173}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006174#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006175
Ronald Cron3772afe2021-02-08 16:10:05 +01006176/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02006177 *
Ronald Cron3772afe2021-02-08 16:10:05 +01006178 * \param type The key type
6179 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02006180 *
6181 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01006182 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02006183 * \retval #PSA_ERROR_INVALID_ARGUMENT
6184 * The size in bits of the key is not valid.
6185 * \retval #PSA_ERROR_NOT_SUPPORTED
6186 * The type and/or the size in bits of the key or the combination of
6187 * the two is not supported.
6188 */
Ronald Cron3772afe2021-02-08 16:10:05 +01006189static psa_status_t psa_validate_key_type_and_size_for_key_generation(
6190 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006191{
Ronald Cronf3bb7612020-10-02 20:11:59 +02006192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006193
Gilles Peskinee59236f2018-01-27 23:32:46 +01006194 if( key_type_is_raw_bytes( type ) )
6195 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02006196 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006197 if( status != PSA_SUCCESS )
6198 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006199 }
6200 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006201#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006202 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6203 {
6204 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6205 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006206
Ronald Cron01b2aba2020-10-05 09:42:02 +02006207 /* Accept only byte-aligned keys, for the same reasons as
6208 * in psa_import_rsa_key(). */
6209 if( bits % 8 != 0 )
6210 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006211 }
6212 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006213#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006214
Ronald Cron5c4d3862020-12-07 11:07:24 +01006215#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006216 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6217 {
Ronald Crond81ab562021-02-16 09:01:16 +01006218 /* To avoid empty block, return successfully here. */
6219 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006220 }
6221 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006222#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006223 {
6224 return( PSA_ERROR_NOT_SUPPORTED );
6225 }
6226
6227 return( PSA_SUCCESS );
6228}
6229
Ronald Cron55ed0592020-10-05 10:30:40 +02006230psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006231 const psa_key_attributes_t *attributes,
6232 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006233{
6234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006235 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006236
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006237 if( ( attributes->domain_parameters == NULL ) &&
6238 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006239 return( PSA_ERROR_INVALID_ARGUMENT );
6240
Ronald Cron01b2aba2020-10-05 09:42:02 +02006241 if( key_type_is_raw_bytes( type ) )
6242 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006243 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006244 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006245 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006246
David Brown12ca5032021-02-11 11:02:00 -07006247#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006248 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006249 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07006250#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006251 }
6252 else
6253
John Durkop07cc04a2020-11-16 22:08:34 -08006254#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006255 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006256 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01006257 return( mbedtls_psa_rsa_generate_key( attributes,
6258 key_buffer,
6259 key_buffer_size,
6260 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006261 }
6262 else
John Durkop07cc04a2020-11-16 22:08:34 -08006263#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006264
John Durkop9814fa22020-11-04 12:28:15 -08006265#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006266 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006267 {
Ronald Cron7023db52020-11-20 18:17:42 +01006268 return( mbedtls_psa_ecp_generate_key( attributes,
6269 key_buffer,
6270 key_buffer_size,
6271 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006272 }
6273 else
John Durkop9814fa22020-11-04 12:28:15 -08006274#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006275 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006276 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006278 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006279
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006280 return( PSA_SUCCESS );
6281}
Darryl Green0c6575a2018-11-07 16:05:30 +00006282
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006283psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006284 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006285{
6286 psa_status_t status;
6287 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006288 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02006289 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02006290
Ronald Cron81709fc2020-11-14 12:10:32 +01006291 *key = MBEDTLS_SVC_KEY_ID_INIT;
6292
Gilles Peskine0f84d622019-09-12 19:03:13 +02006293 /* Reject any attempt to create a zero-length key so that we don't
6294 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6295 if( psa_get_key_bits( attributes ) == 0 )
6296 return( PSA_ERROR_INVALID_ARGUMENT );
6297
Ronald Cron81709fc2020-11-14 12:10:32 +01006298 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6299 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006300 if( status != PSA_SUCCESS )
6301 goto exit;
6302
Ronald Cron977c2472020-10-13 08:32:21 +02006303 /* In the case of a transparent key or an opaque key stored in local
6304 * storage (thus not in the case of generating a key in a secure element
6305 * or cryptoprocessor with storage), we have to allocate a buffer to
6306 * hold the generated key material. */
6307 if( slot->key.data == NULL )
6308 {
6309 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
6310 PSA_KEY_LOCATION_LOCAL_STORAGE )
6311 {
Ronald Cron3772afe2021-02-08 16:10:05 +01006312 status = psa_validate_key_type_and_size_for_key_generation(
6313 attributes->core.type, attributes->core.bits );
6314 if( status != PSA_SUCCESS )
6315 goto exit;
6316
6317 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
6318 attributes->core.type,
6319 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02006320 }
6321 else
6322 {
6323 status = psa_driver_wrapper_get_key_buffer_size(
6324 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01006325 if( status != PSA_SUCCESS )
6326 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02006327 }
Ronald Cron977c2472020-10-13 08:32:21 +02006328
6329 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
6330 if( status != PSA_SUCCESS )
6331 goto exit;
6332 }
6333
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006334 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02006335 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02006336
Ronald Cron2b56bc82020-10-05 10:02:26 +02006337 if( status != PSA_SUCCESS )
6338 psa_remove_key_data_from_memory( slot );
6339
Gilles Peskine11792082019-08-06 18:36:36 +02006340exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006341 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006342 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006343 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006344 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006345
Darryl Green0c6575a2018-11-07 16:05:30 +00006346 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006347}
6348
Gilles Peskinee59236f2018-01-27 23:32:46 +01006349/****************************************************************/
6350/* Module setup */
6351/****************************************************************/
6352
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006353#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006354psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6355 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6356 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6357{
6358 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6359 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006360 global_data.rng.entropy_init = entropy_init;
6361 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006362 return( PSA_SUCCESS );
6363}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006364#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006365
Gilles Peskinee59236f2018-01-27 23:32:46 +01006366void mbedtls_psa_crypto_free( void )
6367{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006368 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006369 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6370 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006371 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006372 }
6373 /* Wipe all remaining data, including configuration.
6374 * In particular, this sets all state indicator to the value
6375 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006376 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006377#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006378 /* Unregister all secure element drivers, so that we restart from
6379 * a pristine state. */
6380 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006381#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006382}
6383
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006384#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6385/** Recover a transaction that was interrupted by a power failure.
6386 *
6387 * This function is called during initialization, before psa_crypto_init()
6388 * returns. If this function returns a failure status, the initialization
6389 * fails.
6390 */
6391static psa_status_t psa_crypto_recover_transaction(
6392 const psa_crypto_transaction_t *transaction )
6393{
6394 switch( transaction->unknown.type )
6395 {
6396 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6397 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006398 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006399 * is implemented.
6400 * https://github.com/ARMmbed/mbed-crypto/issues/218
6401 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006402 default:
6403 /* We found an unsupported transaction in the storage.
6404 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006405 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006406 }
6407}
6408#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6409
Gilles Peskinee59236f2018-01-27 23:32:46 +01006410psa_status_t psa_crypto_init( void )
6411{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006412 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006413
Gilles Peskinec6b69072018-11-20 21:42:52 +01006414 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006415 if( global_data.initialized != 0 )
6416 return( PSA_SUCCESS );
6417
Gilles Peskine30524eb2020-11-13 17:02:26 +01006418 /* Initialize and seed the random generator. */
6419 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006420 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006421 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006422 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006423 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006424 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006425
Gilles Peskine66fb1262018-12-10 16:29:04 +01006426 status = psa_initialize_key_slots( );
6427 if( status != PSA_SUCCESS )
6428 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006429
Gilles Peskined9348f22019-10-01 15:22:29 +02006430#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6431 status = psa_init_all_se_drivers( );
6432 if( status != PSA_SUCCESS )
6433 goto exit;
6434#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6435
Gilles Peskine4b734222019-07-24 15:56:31 +02006436#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006437 status = psa_crypto_load_transaction( );
6438 if( status == PSA_SUCCESS )
6439 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006440 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6441 if( status != PSA_SUCCESS )
6442 goto exit;
6443 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006444 }
6445 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6446 {
6447 /* There's no transaction to complete. It's all good. */
6448 status = PSA_SUCCESS;
6449 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006450#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006451
Gilles Peskinec6b69072018-11-20 21:42:52 +01006452 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006453 global_data.initialized = 1;
6454
6455exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006456 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006457 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006458 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006459}
6460
6461#endif /* MBEDTLS_PSA_CRYPTO_C */