blob: a112ff41bab08c418f18ce3599eeef7b89247bce [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 Cooreman5ad4bf72021-03-02 15:11:57 +0100548/** Return the output MAC length of a MAC algorithm, in bytes
549 *
Steven Cooreman7d4b0d72021-03-02 21:29:45 +0100550 * \param[in] algorithm The specific (non-wildcard) MAC algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100551 * \param[in] key_type The key type of the key to be used with the
552 * \p algorithm.
553 * \param[out] length The calculated output length of the given MAC
554 * \p algorithm when used with a key corresponding to
555 * the given \p key_type
556 *
557 * \retval #PSA_SUCCESS
558 * The \p length has been successfully calculated
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100559 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman7d4b0d72021-03-02 21:29:45 +0100560 * \p algorithm is not a valid, specific MAC algorithm recognized and
561 * supported by this core, or \p key_type describes a key which is
562 * inconsistent with the specified \p algorithm.
563 * \retval #PSA_ERROR_INVALID_ARGUMENT
564 * \p algorithm tries to truncate the MAC to a size which would be
565 * larger than the underlying algorithm's maximum output length.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100566 */
Steven Cooreman58c94d32021-03-02 21:31:17 +0100567MBEDTLS_STATIC_TESTABLE psa_status_t psa_get_mac_output_length(
568 psa_algorithm_t algorithm,
569 psa_key_type_t key_type,
570 size_t *length )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100571{
Steven Cooreman7d4b0d72021-03-02 21:29:45 +0100572 /* Get the default length for the algorithm and key combination. None of the
573 * currently supported algorithms have a default output length dependent on
574 * key size, so setting it to a bogus value is OK. */
575 size_t default_length = PSA_MAC_LENGTH( key_type, 0,
576 PSA_ALG_FULL_LENGTH_MAC( algorithm ) );
577
578 /* PSA_MAC_LENGTH, when called on a full-length algorithm identifier, can
579 * currently return either 0 (unknown algorithm) or 1 (cipher-MAC with
580 * stream cipher) in cases where the key type / algorithm combination would
581 * be invalid. */
582 if( default_length == 0 || default_length == 1 )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100583 return( PSA_ERROR_INVALID_ARGUMENT );
584
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100585 /* Output the expected (potentially truncated) length as long as it can
586 * actually be output by the algorithm */
587 if( PSA_ALG_FULL_LENGTH_MAC( algorithm ) == algorithm )
588 {
589 *length = default_length;
590 return( PSA_SUCCESS );
591 }
592 else if( PSA_MAC_TRUNCATED_LENGTH( algorithm ) <= default_length )
593 {
594 *length = PSA_MAC_TRUNCATED_LENGTH( algorithm );
595 return( PSA_SUCCESS );
596 }
597 else
598 return( PSA_ERROR_INVALID_ARGUMENT );
599}
600
Steven Cooreman75b74362020-07-28 14:30:13 +0200601/** Try to allocate a buffer to an empty key slot.
602 *
603 * \param[in,out] slot Key slot to attach buffer to.
604 * \param[in] buffer_length Requested size of the buffer.
605 *
606 * \retval #PSA_SUCCESS
607 * The buffer has been successfully allocated.
608 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
609 * Not enough memory was available for allocation.
610 * \retval #PSA_ERROR_ALREADY_EXISTS
611 * Trying to allocate a buffer to a non-empty key slot.
612 */
613static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
614 size_t buffer_length )
615{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100616 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200617 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200618
Ronald Cronea0f8a62020-11-25 17:52:23 +0100619 slot->key.data = mbedtls_calloc( 1, buffer_length );
620 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200621 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200622
Ronald Cronea0f8a62020-11-25 17:52:23 +0100623 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200625}
626
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200627psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
628 const uint8_t* data,
629 size_t data_length )
630{
631 psa_status_t status = psa_allocate_buffer_to_slot( slot,
632 data_length );
633 if( status != PSA_SUCCESS )
634 return( status );
635
Ronald Cronea0f8a62020-11-25 17:52:23 +0100636 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200637 return( PSA_SUCCESS );
638}
639
Ronald Crona0fe59f2020-11-29 11:14:53 +0100640psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100641 const psa_key_attributes_t *attributes,
642 const uint8_t *data, size_t data_length,
643 uint8_t *key_buffer, size_t key_buffer_size,
644 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100645{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
647 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100648
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200649 /* zero-length keys are never supported. */
650 if( data_length == 0 )
651 return( PSA_ERROR_NOT_SUPPORTED );
652
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100653 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100654 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100655 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200656
Steven Cooreman75b74362020-07-28 14:30:13 +0200657 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
658 if( data_length > SIZE_MAX / 8 )
659 return( PSA_ERROR_NOT_SUPPORTED );
660
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200661 /* Enforce a size limit, and in particular ensure that the bit
662 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100663 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200664 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200665
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100666 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200667 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200668 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200669
Ronald Crondd04d422020-11-28 15:14:42 +0100670 /* Copy the key material. */
671 memcpy( key_buffer, data, data_length );
672 *key_buffer_length = data_length;
673 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200674
Steven Cooreman40120f62020-10-29 11:42:22 +0100675 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100676 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100677 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200678 {
John Durkop9814fa22020-11-04 12:28:15 -0800679#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
680 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100681 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200682 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 return( mbedtls_psa_ecp_import_key( attributes,
684 data, data_length,
685 key_buffer, key_buffer_size,
686 key_buffer_length,
687 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100688 }
John Durkop9814fa22020-11-04 12:28:15 -0800689#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
690 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700691#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
692 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100693 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200694 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100695 return( mbedtls_psa_rsa_import_key( attributes,
696 data, data_length,
697 key_buffer, key_buffer_size,
698 key_buffer_length,
699 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200700 }
John Durkop9814fa22020-11-04 12:28:15 -0800701#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
702 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100703 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100704
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100705 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100706}
707
Gilles Peskinef603c712019-01-19 13:40:11 +0100708/** Calculate the intersection of two algorithm usage policies.
709 *
710 * Return 0 (which allows no operation) on incompatibility.
711 */
712static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100713 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100714 psa_algorithm_t alg1,
715 psa_algorithm_t alg2 )
716{
Gilles Peskine549ea862019-05-22 11:45:59 +0200717 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100718 if( alg1 == alg2 )
719 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100720 /* If the policies are from the same hash-and-sign family, check
721 * if one is a wildcard. If so the other has the specific algorithm. */
722 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
723 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
724 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100725 {
Steven Cooreman03488022021-02-18 12:07:20 +0100726 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
727 return( alg2 );
728 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
729 return( alg1 );
730 }
731 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100732 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100733 * restrictive tag length. */
734 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
735 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
736 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
737 {
738 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
739 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
740 size_t max_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100741
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100742 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100743 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
744 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100745 {
Steven Cooreman5d814812021-02-18 12:11:39 +0100746 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG( alg1, max_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100747 }
748 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100749 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100750 ( alg1_len <= alg2_len ) )
751 {
752 return( alg2 );
753 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100754 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100755 ( alg2_len <= alg1_len ) )
756 {
757 return( alg1 );
758 }
759 }
760 /* If the policies are from the same MAC family, check whether one
761 * of them is a minimum-MAC-length policy. Calculate the most
762 * restrictive tag length. */
763 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
764 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
765 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
766 {
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100767 /* Calculate the actual requested output length for both sides. In case
768 * of at-least-this-length wildcard algorithms, the requested output
769 * length is the shortest allowed length. */
770 size_t alg1_len = 0;
771 size_t alg2_len = 0;
772 if( PSA_SUCCESS != psa_get_mac_output_length(
773 PSA_ALG_TRUNCATED_MAC( alg1,
774 PSA_MAC_TRUNCATED_LENGTH( alg1 ) ),
775 key_type,
776 &alg1_len ) )
777 {
778 return( 0 );
779 }
780 if( PSA_SUCCESS != psa_get_mac_output_length(
781 PSA_ALG_TRUNCATED_MAC( alg2,
782 PSA_MAC_TRUNCATED_LENGTH( alg2 ) ),
783 key_type,
784 &alg2_len ) )
785 {
786 return( 0 );
787 }
788
Steven Cooreman03488022021-02-18 12:07:20 +0100789 size_t max_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100790
Steven Cooremana1d83222021-02-25 10:20:29 +0100791 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100792 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
793 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100794 {
Steven Cooremancaad4932021-02-18 11:28:17 +0100795 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, max_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100796 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100797 /* If only one is a wildcard, return specific algorithm if compatible. */
798 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100799 {
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100800 if( alg1_len <= alg2_len )
801 return( alg2 );
802 else
803 return( 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100804 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100805 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100806 {
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100807 if( alg2_len <= alg1_len )
808 return( alg1 );
809 else
810 return( 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100811 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100812 /* If none of them are wildcards, check whether we can match
813 * default-length with exact-length, and return exact-length in that
814 * case. */
815 if( alg1_len == alg2_len )
816 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100817 }
818 /* If the policies are incompatible, allow nothing. */
819 return( 0 );
820}
821
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100822static int psa_key_algorithm_permits( psa_key_type_t key_type,
823 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200824 psa_algorithm_t requested_alg )
825{
Gilles Peskine549ea862019-05-22 11:45:59 +0200826 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200827 if( requested_alg == policy_alg )
828 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100829 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
830 * and requested_alg is the same hash-and-sign family with any hash,
831 * then requested_alg is compliant with policy_alg. */
832 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
833 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200834 {
Steven Cooreman03488022021-02-18 12:07:20 +0100835 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
836 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
837 }
838 /* If policy_alg is a wildcard AEAD algorithm of the same base as
839 * the requested algorithm, check the requested tag length to be
840 * equal-length or longer than the wildcard-specified length. */
841 if( PSA_ALG_IS_AEAD( policy_alg ) &&
842 PSA_ALG_IS_AEAD( requested_alg ) &&
843 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
844 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100845 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100846 {
847 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
848 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
849 }
Steven Cooreman03488022021-02-18 12:07:20 +0100850 if( PSA_ALG_IS_MAC( policy_alg ) &&
851 PSA_ALG_IS_MAC( requested_alg ) &&
852 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100853 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100854 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100855 size_t actual_output_length;
856 size_t default_output_length;
857 if( PSA_SUCCESS != psa_get_mac_output_length(
858 requested_alg,
859 key_type,
860 &actual_output_length ) )
861 {
862 return( 0 );
863 }
864 if( PSA_SUCCESS != psa_get_mac_output_length(
865 PSA_ALG_FULL_LENGTH_MAC( requested_alg ),
866 key_type,
867 &default_output_length ) )
868 {
869 return( 0 );
870 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100871
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100872 /* If the policy is default-length, only allow an algorithm with
873 * a declared exact-length matching the default. */
874 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
875 return( actual_output_length == default_output_length );
876
877 /* If the requested algorithm is default-length, allow it if the policy
878 * is exactly the default length. */
879 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
880 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
881 {
882 return( 1 );
883 }
884
885 /* If policy_alg is a wildcard MAC algorithm of the same base as
886 * the requested algorithm, check the requested tag length to be
887 * equal-length or longer than the wildcard-specified length. */
888 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
889 {
890 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
891 actual_output_length );
892 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200893 }
Steven Cooremance48e852020-10-05 16:02:45 +0200894 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200895 * a key derivation with that key agreement should also be allowed. This
896 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200897 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
898 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
899 {
900 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
901 policy_alg );
902 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100903 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200904 return( 0 );
905}
906
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100907/** Test whether a policy permits an algorithm.
908 *
909 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100910 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100911 * \note This function requires providing the key type for which the policy is
912 * being validated, since some algorithm policy definitions (e.g. MAC)
913 * have different properties depending on what kind of cipher it is
914 * combined with.
915 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100916 * \retval PSA_SUCCESS When \p alg is a specific algorithm
917 * allowed by the \p policy.
918 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
919 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
920 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100921 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100923 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100925{
Steven Cooremand788fab2021-02-25 11:29:17 +0100926 /* '0' is not a valid algorithm */
927 if( alg == 0 )
928 return( PSA_ERROR_INVALID_ARGUMENT );
929
Steven Cooreman7e39f052021-02-23 14:18:32 +0100930 /* A requested algorithm cannot be a wildcard. */
931 if( PSA_ALG_IS_WILDCARD( alg ) )
932 return( PSA_ERROR_INVALID_ARGUMENT );
933
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100934 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
935 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100936 return( PSA_SUCCESS );
937 else
938 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100939}
940
Gilles Peskinef603c712019-01-19 13:40:11 +0100941/** Restrict a key policy based on a constraint.
942 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100943 * \note This function requires providing the key type for which the policy is
944 * being restricted, since some algorithm policy definitions (e.g. MAC)
945 * have different properties depending on what kind of cipher it is
946 * combined with.
947 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100948 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100949 * \param[in,out] policy The policy to restrict.
950 * \param[in] constraint The policy constraint to apply.
951 *
952 * \retval #PSA_SUCCESS
953 * \c *policy contains the intersection of the original value of
954 * \c *policy and \c *constraint.
955 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100956 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100957 * \c *policy is unchanged.
958 */
959static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100960 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100961 psa_key_policy_t *policy,
962 const psa_key_policy_t *constraint )
963{
964 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100965 psa_key_policy_algorithm_intersection( key_type, policy->alg,
966 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200967 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100968 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
969 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100970 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
971 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200972 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
973 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100974 policy->usage &= constraint->usage;
975 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200976 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100977 return( PSA_SUCCESS );
978}
979
Ronald Cron5c522922020-11-14 16:35:34 +0100980/** Get the description of a key given its identifier and policy constraints
981 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200982 *
Ronald Cron5c522922020-11-14 16:35:34 +0100983 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100984 * nonzero, the key must allow operations with this algorithm. If \p alg is
985 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100986 *
Ronald Cron5c522922020-11-14 16:35:34 +0100987 * In case of a persistent key, the function loads the description of the key
988 * into a key slot if not already done.
989 *
990 * On success, the returned key slot is locked. It is the responsibility of
991 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200992 */
Ronald Cron5c522922020-11-14 16:35:34 +0100993static psa_status_t psa_get_and_lock_key_slot_with_policy(
994 mbedtls_svc_key_id_t key,
995 psa_key_slot_t **p_slot,
996 psa_key_usage_t usage,
997 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100998{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200999 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1000 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001001
Ronald Cron5c522922020-11-14 16:35:34 +01001002 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001003 if( status != PSA_SUCCESS )
1004 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001005 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001006
1007 /* Enforce that usage policy for the key slot contains all the flags
1008 * required by the usage parameter. There is one exception: public
1009 * keys can always be exported, so we treat public key objects as
1010 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001011 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001012 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001013
Gilles Peskine8e338702019-07-30 20:06:31 +02001014 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +01001015 {
1016 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001017 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001018 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001019
1020 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001021 if( alg != 0 )
1022 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001023 status = psa_key_policy_permits( &slot->attr.policy,
1024 slot->attr.type,
1025 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001026 if( status != PSA_SUCCESS )
1027 goto error;
1028 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001029
Darryl Green06fd18d2018-07-16 11:21:11 +01001030 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001031
1032error:
1033 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001034 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001035
1036 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001037}
Darryl Green940d72c2018-07-13 13:18:51 +01001038
Ronald Cron5c522922020-11-14 16:35:34 +01001039/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001040 *
1041 * A transparent key is a key for which the key material is directly
1042 * available, as opposed to a key in a secure element.
1043 *
Ronald Cron5c522922020-11-14 16:35:34 +01001044 * This is a temporary function to use instead of
1045 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1046 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001047 *
Ronald Cron5c522922020-11-14 16:35:34 +01001048 * On success, the returned key slot is locked. It is the responsibility of the
1049 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001050 */
1051#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001052static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1053 mbedtls_svc_key_id_t key,
1054 psa_key_slot_t **p_slot,
1055 psa_key_usage_t usage,
1056 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001057{
Ronald Cron5c522922020-11-14 16:35:34 +01001058 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1059 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001060 if( status != PSA_SUCCESS )
1061 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001062
Gilles Peskineadad8132019-07-25 11:31:23 +02001063 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001064 {
Ronald Cron5c522922020-11-14 16:35:34 +01001065 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001066 *p_slot = NULL;
1067 return( PSA_ERROR_NOT_SUPPORTED );
1068 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001069
Gilles Peskine28f8f302019-07-24 13:30:31 +02001070 return( PSA_SUCCESS );
1071}
1072#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1073/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001074#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1075 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001076#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1077
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001078/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001079static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001080{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001081 /* Data pointer will always be either a valid pointer or NULL in an
1082 * initialized slot, so we can just free it. */
1083 if( slot->key.data != NULL )
1084 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1085
1086 mbedtls_free( slot->key.data );
1087 slot->key.data = NULL;
1088 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001089
1090 return( PSA_SUCCESS );
1091}
1092
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001093/** Completely wipe a slot in memory, including its policy.
1094 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001095psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001096{
1097 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001098
1099 /*
1100 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001101 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001102 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1103 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001104 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001105 */
Ronald Cron5c522922020-11-14 16:35:34 +01001106 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001107 {
1108#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001109 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001110#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001111 status = PSA_ERROR_CORRUPTION_DETECTED;
1112 }
1113
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001114 /* Multipart operations may still be using the key. This is safe
1115 * because all multipart operation objects are independent from
1116 * the key slot: if they need to access the key after the setup
1117 * phase, they have a copy of the key. Note that this means that
1118 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001119 /* At this point, key material and other type-specific content has
1120 * been wiped. Clear remaining metadata. We can call memset and not
1121 * zeroize because the metadata is not particularly sensitive. */
1122 memset( slot, 0, sizeof( *slot ) );
1123 return( status );
1124}
1125
Ronald Croncf56a0a2020-08-04 09:51:30 +02001126psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001127{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001128 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 psa_status_t status; /* status of the last operation */
1130 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001131#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1132 psa_se_drv_table_entry_t *driver;
1133#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001134
Ronald Croncf56a0a2020-08-04 09:51:30 +02001135 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001136 return( PSA_SUCCESS );
1137
Ronald Cronf2911112020-10-29 17:51:10 +01001138 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001139 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001140 * key, this will load the key description from persistent memory if not
1141 * done yet. We cannot avoid this loading as without it we don't know if
1142 * the key is operated by an SE or not and this information is needed by
1143 * the current implementation.
1144 */
Ronald Cron5c522922020-11-14 16:35:34 +01001145 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001146 if( status != PSA_SUCCESS )
1147 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001148
Ronald Cronf2911112020-10-29 17:51:10 +01001149 /*
1150 * If the key slot containing the key description is under access by the
1151 * library (apart from the present access), the key cannot be destroyed
1152 * yet. For the time being, just return in error. Eventually (to be
1153 * implemented), the key should be destroyed when all accesses have
1154 * stopped.
1155 */
Ronald Cron5c522922020-11-14 16:35:34 +01001156 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001157 {
Ronald Cron5c522922020-11-14 16:35:34 +01001158 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001159 return( PSA_ERROR_GENERIC_ERROR );
1160 }
1161
Gilles Peskine354f7672019-07-12 23:46:38 +02001162#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001163 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001164 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001165 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001166 /* For a key in a secure element, we need to do three things:
1167 * remove the key file in internal storage, destroy the
1168 * key inside the secure element, and update the driver's
1169 * persistent data. Start a transaction that will encompass these
1170 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001171 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001172 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001173 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001174 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001175 status = psa_crypto_save_transaction( );
1176 if( status != PSA_SUCCESS )
1177 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001178 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001179 /* We should still try to destroy the key in the secure
1180 * element and the key metadata in storage. This is especially
1181 * important if the error is that the storage is full.
1182 * But how to do it exactly without risking an inconsistent
1183 * state after a reset?
1184 * https://github.com/ARMmbed/mbed-crypto/issues/215
1185 */
1186 overall_status = status;
1187 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001188 }
1189
Ronald Cronea0f8a62020-11-25 17:52:23 +01001190 status = psa_destroy_se_key( driver,
1191 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001192 if( overall_status == PSA_SUCCESS )
1193 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001194 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001195#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1196
Darryl Greend49a4992018-06-18 17:27:26 +01001197#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001198 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001199 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001200 status = psa_destroy_persistent_key( slot->attr.id );
1201 if( overall_status == PSA_SUCCESS )
1202 overall_status = status;
1203
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001204 /* TODO: other slots may have a copy of the same key. We should
1205 * invalidate them.
1206 * https://github.com/ARMmbed/mbed-crypto/issues/214
1207 */
Darryl Greend49a4992018-06-18 17:27:26 +01001208 }
1209#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001210
Gilles Peskinefc762652019-07-22 19:30:34 +02001211#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1212 if( driver != NULL )
1213 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001214 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001215 if( overall_status == PSA_SUCCESS )
1216 overall_status = status;
1217 status = psa_crypto_stop_transaction( );
1218 if( overall_status == PSA_SUCCESS )
1219 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001220 }
1221#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1222
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001223#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1224exit:
1225#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001226 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001227 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1228 if( overall_status == PSA_SUCCESS )
1229 overall_status = status;
1230 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001231}
1232
John Durkop07cc04a2020-11-16 22:08:34 -08001233#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001234 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001235static psa_status_t psa_get_rsa_public_exponent(
1236 const mbedtls_rsa_context *rsa,
1237 psa_key_attributes_t *attributes )
1238{
1239 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001241 uint8_t *buffer = NULL;
1242 size_t buflen;
1243 mbedtls_mpi_init( &mpi );
1244
1245 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1246 if( ret != 0 )
1247 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001248 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1249 {
1250 /* It's the default value, which is reported as an empty string,
1251 * so there's nothing to do. */
1252 goto exit;
1253 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001254
1255 buflen = mbedtls_mpi_size( &mpi );
1256 buffer = mbedtls_calloc( 1, buflen );
1257 if( buffer == NULL )
1258 {
1259 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1260 goto exit;
1261 }
1262 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1263 if( ret != 0 )
1264 goto exit;
1265 attributes->domain_parameters = buffer;
1266 attributes->domain_parameters_size = buflen;
1267
1268exit:
1269 mbedtls_mpi_free( &mpi );
1270 if( ret != 0 )
1271 mbedtls_free( buffer );
1272 return( mbedtls_to_psa_error( ret ) );
1273}
John Durkop07cc04a2020-11-16 22:08:34 -08001274#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001275 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001276
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001277/** Retrieve all the publicly-accessible attributes of a key.
1278 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001279psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001280 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001281{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001282 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001283 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001284 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001285
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001286 psa_reset_key_attributes( attributes );
1287
Ronald Cron5c522922020-11-14 16:35:34 +01001288 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001289 if( status != PSA_SUCCESS )
1290 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001291
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001292 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001293 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1294 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1295
1296#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1297 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001298 psa_set_key_slot_number( attributes,
1299 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001300#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001301
Gilles Peskine8e338702019-07-30 20:06:31 +02001302 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001303 {
John Durkop07cc04a2020-11-16 22:08:34 -08001304#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001305 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001306 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001308#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001309 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001310 * is not yet implemented.
1311 * https://github.com/ARMmbed/mbed-crypto/issues/216
1312 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001313 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001314 break;
1315#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001316 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001317 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001318
Ronald Cron90857082020-11-25 14:58:33 +01001319 status = mbedtls_psa_rsa_load_representation(
1320 slot->attr.type,
1321 slot->key.data,
1322 slot->key.bytes,
1323 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001324 if( status != PSA_SUCCESS )
1325 break;
1326
Steven Cooremana2371e52020-07-28 14:30:39 +02001327 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001328 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001329 mbedtls_rsa_free( rsa );
1330 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001331 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001332 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001333#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001334 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001335 default:
1336 /* Nothing else to do. */
1337 break;
1338 }
1339
1340 if( status != PSA_SUCCESS )
1341 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001342
Ronald Cron5c522922020-11-14 16:35:34 +01001343 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001344
Ronald Cron5c522922020-11-14 16:35:34 +01001345 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001346}
1347
Gilles Peskinec8000c02019-08-02 20:15:51 +02001348#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1349psa_status_t psa_get_key_slot_number(
1350 const psa_key_attributes_t *attributes,
1351 psa_key_slot_number_t *slot_number )
1352{
1353 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1354 {
1355 *slot_number = attributes->slot_number;
1356 return( PSA_SUCCESS );
1357 }
1358 else
1359 return( PSA_ERROR_INVALID_ARGUMENT );
1360}
1361#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1362
Ronald Crond18b5f82020-11-25 16:46:05 +01001363static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1364 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001365 uint8_t *data,
1366 size_t data_size,
1367 size_t *data_length )
1368{
Ronald Crond18b5f82020-11-25 16:46:05 +01001369 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001370 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001371 memcpy( data, key_buffer, key_buffer_size );
1372 memset( data + key_buffer_size, 0,
1373 data_size - key_buffer_size );
1374 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001375 return( PSA_SUCCESS );
1376}
1377
Ronald Cron7285cda2020-11-26 14:46:37 +01001378psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001379 const psa_key_attributes_t *attributes,
1380 const uint8_t *key_buffer, size_t key_buffer_size,
1381 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001382{
Ronald Crond18b5f82020-11-25 16:46:05 +01001383 psa_key_type_t type = attributes->core.type;
1384
Ronald Crond18b5f82020-11-25 16:46:05 +01001385 if( key_type_is_raw_bytes( type ) ||
1386 PSA_KEY_TYPE_IS_RSA( type ) ||
1387 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001388 {
1389 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001390 key_buffer, key_buffer_size,
1391 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001392 }
1393 else
1394 {
1395 /* This shouldn't happen in the reference implementation, but
1396 it is valid for a special-purpose implementation to omit
1397 support for exporting certain key types. */
1398 return( PSA_ERROR_NOT_SUPPORTED );
1399 }
1400}
1401
1402psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1403 uint8_t *data,
1404 size_t data_size,
1405 size_t *data_length )
1406{
1407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1408 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1409 psa_key_slot_t *slot;
1410
Ronald Crone907e552021-01-18 13:22:38 +01001411 /* Reject a zero-length output buffer now, since this can never be a
1412 * valid key representation. This way we know that data must be a valid
1413 * pointer and we can do things like memset(data, ..., data_size). */
1414 if( data_size == 0 )
1415 return( PSA_ERROR_BUFFER_TOO_SMALL );
1416
Ronald Cron9486f9d2020-11-26 13:36:23 +01001417 /* Set the key to empty now, so that even when there are errors, we always
1418 * set data_length to a value between 0 and data_size. On error, setting
1419 * the key to empty is a good choice because an empty key representation is
1420 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001421 *data_length = 0;
1422
Ronald Cron9486f9d2020-11-26 13:36:23 +01001423 /* Export requires the EXPORT flag. There is an exception for public keys,
1424 * which don't require any flag, but
1425 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1426 */
1427 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1428 PSA_KEY_USAGE_EXPORT, 0 );
1429 if( status != PSA_SUCCESS )
1430 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001431
Ronald Crond18b5f82020-11-25 16:46:05 +01001432 psa_key_attributes_t attributes = {
1433 .core = slot->attr
1434 };
Ronald Cron67227982020-11-26 15:16:05 +01001435 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 slot->key.data, slot->key.bytes,
1437 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001438
Ronald Cron9486f9d2020-11-26 13:36:23 +01001439 unlock_status = psa_unlock_key_slot( slot );
1440
1441 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1442}
1443
Ronald Cron7285cda2020-11-26 14:46:37 +01001444psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001445 const psa_key_attributes_t *attributes,
1446 const uint8_t *key_buffer,
1447 size_t key_buffer_size,
1448 uint8_t *data,
1449 size_t data_size,
1450 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001451{
Ronald Crond18b5f82020-11-25 16:46:05 +01001452 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001453
Ronald Crond18b5f82020-11-25 16:46:05 +01001454 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001455 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001456 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001457 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001458 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001459 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001460 key_buffer, key_buffer_size,
1461 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001462 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001463
Ronald Crond18b5f82020-11-25 16:46:05 +01001464 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001465 {
John Durkop0e005192020-10-31 22:06:54 -07001466#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1467 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001468 return( mbedtls_psa_rsa_export_public_key( attributes,
1469 key_buffer,
1470 key_buffer_size,
1471 data,
1472 data_size,
1473 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001474#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001475 /* We don't know how to convert a private RSA key to public. */
1476 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001477#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1478 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001479 }
1480 else
Moran Pekera998bc62018-04-16 18:16:20 +03001481 {
John Durkop6ba40d12020-11-10 08:50:04 -08001482#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1483 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001484 return( mbedtls_psa_ecp_export_public_key( attributes,
1485 key_buffer,
1486 key_buffer_size,
1487 data,
1488 data_size,
1489 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001490#else
1491 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001492 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001493#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1494 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001495 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001496 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001497 else
1498 {
1499 /* This shouldn't happen in the reference implementation, but
1500 it is valid for a special-purpose implementation to omit
1501 support for exporting certain key types. */
1502 return( PSA_ERROR_NOT_SUPPORTED );
1503 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001504}
Ronald Crond18b5f82020-11-25 16:46:05 +01001505
Ronald Croncf56a0a2020-08-04 09:51:30 +02001506psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001507 uint8_t *data,
1508 size_t data_size,
1509 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001510{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001511 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001512 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001513 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001514
Ronald Crone907e552021-01-18 13:22:38 +01001515 /* Reject a zero-length output buffer now, since this can never be a
1516 * valid key representation. This way we know that data must be a valid
1517 * pointer and we can do things like memset(data, ..., data_size). */
1518 if( data_size == 0 )
1519 return( PSA_ERROR_BUFFER_TOO_SMALL );
1520
Darryl Greendd8fb772018-11-07 16:00:44 +00001521 /* Set the key to empty now, so that even when there are errors, we always
1522 * set data_length to a value between 0 and data_size. On error, setting
1523 * the key to empty is a good choice because an empty key representation is
1524 * unlikely to be accepted anywhere. */
1525 *data_length = 0;
1526
1527 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001528 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001529 if( status != PSA_SUCCESS )
1530 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001531
Ronald Cron9486f9d2020-11-26 13:36:23 +01001532 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1533 {
1534 status = PSA_ERROR_INVALID_ARGUMENT;
1535 goto exit;
1536 }
1537
Ronald Crond18b5f82020-11-25 16:46:05 +01001538 psa_key_attributes_t attributes = {
1539 .core = slot->attr
1540 };
Ronald Cron67227982020-11-26 15:16:05 +01001541 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001542 &attributes, slot->key.data, slot->key.bytes,
1543 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001544
1545exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001546 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001547
Ronald Cron5c522922020-11-14 16:35:34 +01001548 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001549}
1550
Gilles Peskine91e8c332019-08-02 19:19:39 +02001551#if defined(static_assert)
1552static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1553 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001554static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001555 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001556static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001557 "One or more key attribute flag is listed as both internal-only and external-only" );
1558#endif
1559
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001560/** Validate that a key policy is internally well-formed.
1561 *
1562 * This function only rejects invalid policies. It does not validate the
1563 * consistency of the policy with respect to other attributes of the key
1564 * such as the key type.
1565 */
1566static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001567{
1568 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001569 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001570 PSA_KEY_USAGE_ENCRYPT |
1571 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001572 PSA_KEY_USAGE_SIGN_HASH |
1573 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1575 return( PSA_ERROR_INVALID_ARGUMENT );
1576
Gilles Peskine4747d192019-04-17 15:05:45 +02001577 return( PSA_SUCCESS );
1578}
1579
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001580/** Validate the internal consistency of key attributes.
1581 *
1582 * This function only rejects invalid attribute values. If does not
1583 * validate the consistency of the attributes with any key data that may
1584 * be involved in the creation of the key.
1585 *
1586 * Call this function early in the key creation process.
1587 *
1588 * \param[in] attributes Key attributes for the new key.
1589 * \param[out] p_drv On any return, the driver for the key, if any.
1590 * NULL for a transparent key.
1591 *
1592 */
1593static psa_status_t psa_validate_key_attributes(
1594 const psa_key_attributes_t *attributes,
1595 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001596{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001597 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001598 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001599 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001600
Ronald Cron54b90082020-10-29 15:26:43 +01001601 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001602 if( status != PSA_SUCCESS )
1603 return( status );
1604
Ronald Crond2ed4812020-07-17 16:11:30 +02001605 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001606 if( status != PSA_SUCCESS )
1607 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001608
Ronald Cron65f38a32020-10-23 17:11:13 +02001609 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1610 {
1611 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1612 return( PSA_ERROR_INVALID_ARGUMENT );
1613 }
1614 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001615 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001616 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001617 if( status != PSA_SUCCESS )
1618 return( status );
1619 }
1620
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001621 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001622 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001623 return( status );
1624
1625 /* Refuse to create overly large keys.
1626 * Note that this doesn't trigger on import if the attributes don't
1627 * explicitly specify a size (so psa_get_key_bits returns 0), so
1628 * psa_import_key() needs its own checks. */
1629 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1630 return( PSA_ERROR_NOT_SUPPORTED );
1631
Gilles Peskine91e8c332019-08-02 19:19:39 +02001632 /* Reject invalid flags. These should not be reachable through the API. */
1633 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1634 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1635 return( PSA_ERROR_INVALID_ARGUMENT );
1636
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001637 return( PSA_SUCCESS );
1638}
1639
Gilles Peskine4747d192019-04-17 15:05:45 +02001640/** Prepare a key slot to receive key material.
1641 *
1642 * This function allocates a key slot and sets its metadata.
1643 *
1644 * If this function fails, call psa_fail_key_creation().
1645 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001646 * This function is intended to be used as follows:
1647 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001648 * it with the specified attributes, and in case of a volatile key assign it
1649 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001650 * -# Populate the slot with the key material.
1651 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1652 * In case of failure at any step, stop the sequence and call
1653 * psa_fail_key_creation().
1654 *
Ronald Cron5c522922020-11-14 16:35:34 +01001655 * On success, the key slot is locked. It is the responsibility of the caller
1656 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001657 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001658 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001659 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001660 * \param[out] p_slot On success, a pointer to the prepared slot.
1661 * \param[out] p_drv On any return, the driver for the key, if any.
1662 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001663 *
1664 * \retval #PSA_SUCCESS
1665 * The key slot is ready to receive key material.
1666 * \return If this function fails, the key slot is an invalid state.
1667 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001668 */
1669static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001670 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001671 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001672 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001673 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001674{
1675 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001676 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001677 psa_key_slot_t *slot;
1678
Gilles Peskinedf179142019-07-15 22:02:14 +02001679 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001680 *p_drv = NULL;
1681
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001682 status = psa_validate_key_attributes( attributes, p_drv );
1683 if( status != PSA_SUCCESS )
1684 return( status );
1685
Ronald Cronc4d1b512020-07-31 11:26:37 +02001686 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001687 if( status != PSA_SUCCESS )
1688 return( status );
1689 slot = *p_slot;
1690
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001691 /* We're storing the declared bit-size of the key. It's up to each
1692 * creation mechanism to verify that this information is correct.
1693 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001694 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001695 * is optional (import, copy). In case of a volatile key, assign it the
1696 * volatile key identifier associated to the slot returned to contain its
1697 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001698
1699 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001700 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1701 {
1702#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1703 slot->attr.id = volatile_key_id;
1704#else
1705 slot->attr.id.key_id = volatile_key_id;
1706#endif
1707 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001708
Gilles Peskine91e8c332019-08-02 19:19:39 +02001709 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001710 * external-only flags, query `attributes`. Thanks to the check
1711 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001712 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001713 * may have set. */
1714 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001715
Gilles Peskinecbaff462019-07-12 23:46:04 +02001716#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001717 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001718 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001719 * create the key file in internal storage, create the
1720 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001721 * persistent data. This is done by starting a transaction that will
1722 * encompass these three actions.
1723 * For registering a volatile key, we just need to find an appropriate
1724 * slot number inside the SE. Since the key is designated volatile, creating
1725 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001726 /* The first thing to do is to find a slot number for the new key.
1727 * We save the slot number in persistent storage as part of the
1728 * transaction data. It will be needed to recover if the power
1729 * fails during the key creation process, to clean up on the secure
1730 * element side after restarting. Obtaining a slot number from the
1731 * secure element driver updates its persistent state, but we do not yet
1732 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001733 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001734 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001735 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001736 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001737 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001739 if( status != PSA_SUCCESS )
1740 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001741
1742 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001743 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001744 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1745 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001746 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001747 psa_crypto_transaction.key.id = slot->attr.id;
1748 status = psa_crypto_save_transaction( );
1749 if( status != PSA_SUCCESS )
1750 {
1751 (void) psa_crypto_stop_transaction( );
1752 return( status );
1753 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001754 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001755
1756 status = psa_copy_key_material_into_slot(
1757 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001758 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001759
1760 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1761 {
1762 /* Key registration only makes sense with a secure element. */
1763 return( PSA_ERROR_INVALID_ARGUMENT );
1764 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001765#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1766
Ronald Cronc4d1b512020-07-31 11:26:37 +02001767 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001768}
Gilles Peskine4747d192019-04-17 15:05:45 +02001769
1770/** Finalize the creation of a key once its key material has been set.
1771 *
1772 * This entails writing the key to persistent storage.
1773 *
1774 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001775 * See the documentation of psa_start_key_creation() for the intended use
1776 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 *
Ronald Cron5c522922020-11-14 16:35:34 +01001778 * If the finalization succeeds, the function unlocks the key slot (it was
1779 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1780 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001781 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001782 * \param[in,out] slot Pointer to the slot with key material.
1783 * \param[in] driver The secure element driver for the key,
1784 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001785 * \param[out] key On success, identifier of the key. Note that the
1786 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001787 *
1788 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001789 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001790 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1791 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1792 * \retval #PSA_ERROR_ALREADY_EXISTS
1793 * \retval #PSA_ERROR_DATA_INVALID
1794 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001795 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001796 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001797 * \return If this function fails, the key slot is an invalid state.
1798 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001799 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001800static psa_status_t psa_finish_key_creation(
1801 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001802 psa_se_drv_table_entry_t *driver,
1803 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001804{
1805 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001806 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001807 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001808
1809#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001810 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001811 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001812#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1813 if( driver != NULL )
1814 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001815 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001816 psa_key_slot_number_t slot_number =
1817 psa_key_slot_get_slot_number( slot ) ;
1818
Gilles Peskineb46bef22019-07-30 21:32:04 +02001819#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001820 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001821 sizeof( data.slot_number ),
1822 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001823#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001824 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001825 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001826 (uint8_t*) &data,
1827 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001828 }
1829 else
1830#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1831 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001832 /* Key material is saved in export representation in the slot, so
1833 * just pass the slot buffer for storage. */
1834 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001835 slot->key.data,
1836 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001837 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001838 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001839#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1840
Gilles Peskinecbaff462019-07-12 23:46:04 +02001841#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001842 /* Finish the transaction for a key creation. This does not
1843 * happen when registering an existing key. Detect this case
1844 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001845 * creation of a persistent key in a secure element requires a transaction,
1846 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001847 if( driver != NULL &&
1848 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001849 {
1850 status = psa_save_se_persistent_data( driver );
1851 if( status != PSA_SUCCESS )
1852 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001853 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001854 return( status );
1855 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001856 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001857 }
1858#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1859
Ronald Cron50972942020-11-14 11:28:25 +01001860 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001861 {
1862 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001863 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001864 if( status != PSA_SUCCESS )
1865 *key = MBEDTLS_SVC_KEY_ID_INIT;
1866 }
Ronald Cron50972942020-11-14 11:28:25 +01001867
Gilles Peskine4747d192019-04-17 15:05:45 +02001868 return( status );
1869}
1870
1871/** Abort the creation of a key.
1872 *
1873 * You may call this function after calling psa_start_key_creation(),
1874 * or after psa_finish_key_creation() fails. In other circumstances, this
1875 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001876 * See the documentation of psa_start_key_creation() for the intended use
1877 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001878 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001879 * \param[in,out] slot Pointer to the slot with key material.
1880 * \param[in] driver The secure element driver for the key,
1881 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001882 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001883static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001884 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001885{
Gilles Peskine011e4282019-06-26 18:34:38 +02001886 (void) driver;
1887
Gilles Peskine4747d192019-04-17 15:05:45 +02001888 if( slot == NULL )
1889 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001890
1891#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001892 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001893 * element, and the failure happened later (when saving metadata
1894 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001895 * element.
1896 * https://github.com/ARMmbed/mbed-crypto/issues/217
1897 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001898
Gilles Peskined7729582019-08-05 15:55:54 +02001899 /* Abort the ongoing transaction if any (there may not be one if
1900 * the creation process failed before starting one, or if the
1901 * key creation is a registration of a key in a secure element).
1902 * Earlier functions must already have done what it takes to undo any
1903 * partial creation. All that's left is to update the transaction data
1904 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001905 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001906#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1907
Gilles Peskine4747d192019-04-17 15:05:45 +02001908 psa_wipe_key_slot( slot );
1909}
1910
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001911/** Validate optional attributes during key creation.
1912 *
1913 * Some key attributes are optional during key creation. If they are
1914 * specified in the attributes structure, check that they are consistent
1915 * with the data in the slot.
1916 *
1917 * This function should be called near the end of key creation, after
1918 * the slot in memory is fully populated but before saving persistent data.
1919 */
1920static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 const psa_key_slot_t *slot,
1922 const psa_key_attributes_t *attributes )
1923{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001924 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001926 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001927 return( PSA_ERROR_INVALID_ARGUMENT );
1928 }
1929
1930 if( attributes->domain_parameters_size != 0 )
1931 {
John Durkop0e005192020-10-31 22:06:54 -07001932#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1933 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001934 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001935 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001936 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001937 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001938 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001939
Ronald Cron90857082020-11-25 14:58:33 +01001940 psa_status_t status = mbedtls_psa_rsa_load_representation(
1941 slot->attr.type,
1942 slot->key.data,
1943 slot->key.bytes,
1944 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001945 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001946 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001947
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001948 mbedtls_mpi_init( &actual );
1949 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001950 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001951 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001952 mbedtls_rsa_free( rsa );
1953 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954 if( ret != 0 )
1955 goto rsa_exit;
1956 ret = mbedtls_mpi_read_binary( &required,
1957 attributes->domain_parameters,
1958 attributes->domain_parameters_size );
1959 if( ret != 0 )
1960 goto rsa_exit;
1961 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1962 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1963 rsa_exit:
1964 mbedtls_mpi_free( &actual );
1965 mbedtls_mpi_free( &required );
1966 if( ret != 0)
1967 return( mbedtls_to_psa_error( ret ) );
1968 }
1969 else
John Durkop9814fa22020-11-04 12:28:15 -08001970#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1971 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001972 {
1973 return( PSA_ERROR_INVALID_ARGUMENT );
1974 }
1975 }
1976
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001977 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001978 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001979 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001980 return( PSA_ERROR_INVALID_ARGUMENT );
1981 }
1982
1983 return( PSA_SUCCESS );
1984}
1985
Gilles Peskine4747d192019-04-17 15:05:45 +02001986psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001987 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001988 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001989 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001990{
1991 psa_status_t status;
1992 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001993 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001994 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001995
Ronald Cron81709fc2020-11-14 12:10:32 +01001996 *key = MBEDTLS_SVC_KEY_ID_INIT;
1997
Gilles Peskine0f84d622019-09-12 19:03:13 +02001998 /* Reject zero-length symmetric keys (including raw data key objects).
1999 * This also rejects any key which might be encoded as an empty string,
2000 * which is never valid. */
2001 if( data_length == 0 )
2002 return( PSA_ERROR_INVALID_ARGUMENT );
2003
Gilles Peskinedf179142019-07-15 22:02:14 +02002004 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002005 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006 if( status != PSA_SUCCESS )
2007 goto exit;
2008
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002009 /* In the case of a transparent key or an opaque key stored in local
2010 * storage (thus not in the case of generating a key in a secure element
2011 * or cryptoprocessor with storage), we have to allocate a buffer to
2012 * hold the generated key material. */
2013 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02002014 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002015 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002016 if( status != PSA_SUCCESS )
2017 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002018 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002019
2020 bits = slot->attr.bits;
2021 status = psa_driver_wrapper_import_key( attributes,
2022 data, data_length,
2023 slot->key.data,
2024 slot->key.bytes,
2025 &slot->key.bytes, &bits );
2026 if( status != PSA_SUCCESS )
2027 goto exit;
2028
2029 if( slot->attr.bits == 0 )
2030 slot->attr.bits = (psa_key_bits_t) bits;
2031 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002032 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002033 status = PSA_ERROR_INVALID_ARGUMENT;
2034 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002035 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002036
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002037 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002038 if( status != PSA_SUCCESS )
2039 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002040
Ronald Cron81709fc2020-11-14 12:10:32 +01002041 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002042exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002043 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002044 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002045
Gilles Peskine4747d192019-04-17 15:05:45 +02002046 return( status );
2047}
2048
Gilles Peskined7729582019-08-05 15:55:54 +02002049#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2050psa_status_t mbedtls_psa_register_se_key(
2051 const psa_key_attributes_t *attributes )
2052{
2053 psa_status_t status;
2054 psa_key_slot_t *slot = NULL;
2055 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002056 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002057
2058 /* Leaving attributes unspecified is not currently supported.
2059 * It could make sense to query the key type and size from the
2060 * secure element, but not all secure elements support this
2061 * and the driver HAL doesn't currently support it. */
2062 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2063 return( PSA_ERROR_NOT_SUPPORTED );
2064 if( psa_get_key_bits( attributes ) == 0 )
2065 return( PSA_ERROR_NOT_SUPPORTED );
2066
2067 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002068 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002069 if( status != PSA_SUCCESS )
2070 goto exit;
2071
Ronald Cron81709fc2020-11-14 12:10:32 +01002072 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002073
2074exit:
2075 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002076 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002077
Gilles Peskined7729582019-08-05 15:55:54 +02002078 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002079 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002080 return( status );
2081}
2082#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2083
Gilles Peskinef603c712019-01-19 13:40:11 +01002084static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002085 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002086{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002087 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002088 source->key.data,
2089 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002090 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002091 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002092
Steven Cooreman398aee52020-10-13 14:35:45 +02002093 target->attr.type = source->attr.type;
2094 target->attr.bits = source->attr.bits;
2095
2096 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002097}
2098
Ronald Croncf56a0a2020-08-04 09:51:30 +02002099psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002100 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002101 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002102{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002104 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002105 psa_key_slot_t *source_slot = NULL;
2106 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002107 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002108 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002109
Ronald Cron81709fc2020-11-14 12:10:32 +01002110 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2111
Ronald Cron5c522922020-11-14 16:35:34 +01002112 status = psa_get_and_lock_transparent_key_slot_with_policy(
2113 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002114 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002115 goto exit;
2116
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002117 status = psa_validate_optional_attributes( source_slot,
2118 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002119 if( status != PSA_SUCCESS )
2120 goto exit;
2121
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002122 status = psa_restrict_key_policy( source_slot->attr.type,
2123 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002124 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002125 if( status != PSA_SUCCESS )
2126 goto exit;
2127
Ronald Cron81709fc2020-11-14 12:10:32 +01002128 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2129 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002130 if( status != PSA_SUCCESS )
2131 goto exit;
2132
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002133#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2134 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002135 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002136 /* Copying to a secure element is not implemented yet. */
2137 status = PSA_ERROR_NOT_SUPPORTED;
2138 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002139 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002140#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002141
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002142 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002143 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002144 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002145
Ronald Cron81709fc2020-11-14 12:10:32 +01002146 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002147exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002148 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002149 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002150
Ronald Cron5c522922020-11-14 16:35:34 +01002151 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002152
Ronald Cron5c522922020-11-14 16:35:34 +01002153 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002154}
2155
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002156
2157
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002158/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002159/* Message digests */
2160/****************************************************************/
2161
John Durkop07cc04a2020-11-16 22:08:34 -08002162#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002163 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2164 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002165 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002166static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002167{
2168 switch( alg )
2169 {
John Durkopee4e6602020-11-27 08:48:46 -08002170#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002171 case PSA_ALG_MD2:
2172 return( &mbedtls_md2_info );
2173#endif
John Durkopee4e6602020-11-27 08:48:46 -08002174#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002175 case PSA_ALG_MD4:
2176 return( &mbedtls_md4_info );
2177#endif
John Durkopee4e6602020-11-27 08:48:46 -08002178#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002179 case PSA_ALG_MD5:
2180 return( &mbedtls_md5_info );
2181#endif
John Durkopee4e6602020-11-27 08:48:46 -08002182#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002183 case PSA_ALG_RIPEMD160:
2184 return( &mbedtls_ripemd160_info );
2185#endif
John Durkopee4e6602020-11-27 08:48:46 -08002186#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002187 case PSA_ALG_SHA_1:
2188 return( &mbedtls_sha1_info );
2189#endif
John Durkopee4e6602020-11-27 08:48:46 -08002190#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002191 case PSA_ALG_SHA_224:
2192 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002193#endif
2194#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002195 case PSA_ALG_SHA_256:
2196 return( &mbedtls_sha256_info );
2197#endif
John Durkopee4e6602020-11-27 08:48:46 -08002198#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002199 case PSA_ALG_SHA_384:
2200 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002201#endif
John Durkopee4e6602020-11-27 08:48:46 -08002202#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002203 case PSA_ALG_SHA_512:
2204 return( &mbedtls_sha512_info );
2205#endif
2206 default:
2207 return( NULL );
2208 }
2209}
John Durkop07cc04a2020-11-16 22:08:34 -08002210#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002211 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2212 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2213 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002214
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002215psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2216{
2217 switch( operation->alg )
2218 {
Gilles Peskine81736312018-06-26 15:04:31 +02002219 case 0:
2220 /* The object has (apparently) been initialized but it is not
2221 * in use. It's ok to call abort on such an object, and there's
2222 * nothing to do. */
2223 break;
John Durkopee4e6602020-11-27 08:48:46 -08002224#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225 case PSA_ALG_MD2:
2226 mbedtls_md2_free( &operation->ctx.md2 );
2227 break;
2228#endif
John Durkopee4e6602020-11-27 08:48:46 -08002229#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002230 case PSA_ALG_MD4:
2231 mbedtls_md4_free( &operation->ctx.md4 );
2232 break;
2233#endif
John Durkopee4e6602020-11-27 08:48:46 -08002234#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002235 case PSA_ALG_MD5:
2236 mbedtls_md5_free( &operation->ctx.md5 );
2237 break;
2238#endif
John Durkopee4e6602020-11-27 08:48:46 -08002239#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240 case PSA_ALG_RIPEMD160:
2241 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2242 break;
2243#endif
John Durkopee4e6602020-11-27 08:48:46 -08002244#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245 case PSA_ALG_SHA_1:
2246 mbedtls_sha1_free( &operation->ctx.sha1 );
2247 break;
2248#endif
John Durkop6ca23272020-12-03 06:01:32 -08002249#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002251 mbedtls_sha256_free( &operation->ctx.sha256 );
2252 break;
2253#endif
2254#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255 case PSA_ALG_SHA_256:
2256 mbedtls_sha256_free( &operation->ctx.sha256 );
2257 break;
2258#endif
John Durkop6ca23272020-12-03 06:01:32 -08002259#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002260 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002261 mbedtls_sha512_free( &operation->ctx.sha512 );
2262 break;
2263#endif
2264#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265 case PSA_ALG_SHA_512:
2266 mbedtls_sha512_free( &operation->ctx.sha512 );
2267 break;
2268#endif
2269 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002270 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002271 }
2272 operation->alg = 0;
2273 return( PSA_SUCCESS );
2274}
2275
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002276psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002277 psa_algorithm_t alg )
2278{
Janos Follath24eed8d2019-11-22 13:21:35 +00002279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002280
2281 /* A context must be freshly initialized before it can be set up. */
2282 if( operation->alg != 0 )
2283 {
2284 return( PSA_ERROR_BAD_STATE );
2285 }
2286
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002287 switch( alg )
2288 {
John Durkopee4e6602020-11-27 08:48:46 -08002289#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290 case PSA_ALG_MD2:
2291 mbedtls_md2_init( &operation->ctx.md2 );
2292 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2293 break;
2294#endif
John Durkopee4e6602020-11-27 08:48:46 -08002295#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002296 case PSA_ALG_MD4:
2297 mbedtls_md4_init( &operation->ctx.md4 );
2298 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2299 break;
2300#endif
John Durkopee4e6602020-11-27 08:48:46 -08002301#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002302 case PSA_ALG_MD5:
2303 mbedtls_md5_init( &operation->ctx.md5 );
2304 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2305 break;
2306#endif
John Durkopee4e6602020-11-27 08:48:46 -08002307#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002308 case PSA_ALG_RIPEMD160:
2309 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2310 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2311 break;
2312#endif
John Durkopee4e6602020-11-27 08:48:46 -08002313#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002314 case PSA_ALG_SHA_1:
2315 mbedtls_sha1_init( &operation->ctx.sha1 );
2316 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2317 break;
2318#endif
John Durkopee4e6602020-11-27 08:48:46 -08002319#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320 case PSA_ALG_SHA_224:
2321 mbedtls_sha256_init( &operation->ctx.sha256 );
2322 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2323 break;
John Durkopee4e6602020-11-27 08:48:46 -08002324#endif
2325#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326 case PSA_ALG_SHA_256:
2327 mbedtls_sha256_init( &operation->ctx.sha256 );
2328 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2329 break;
2330#endif
John Durkopee4e6602020-11-27 08:48:46 -08002331#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002332 case PSA_ALG_SHA_384:
2333 mbedtls_sha512_init( &operation->ctx.sha512 );
2334 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2335 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002336#endif
John Durkopee4e6602020-11-27 08:48:46 -08002337#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002338 case PSA_ALG_SHA_512:
2339 mbedtls_sha512_init( &operation->ctx.sha512 );
2340 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2341 break;
2342#endif
2343 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002344 return( PSA_ALG_IS_HASH( alg ) ?
2345 PSA_ERROR_NOT_SUPPORTED :
2346 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002347 }
2348 if( ret == 0 )
2349 operation->alg = alg;
2350 else
2351 psa_hash_abort( operation );
2352 return( mbedtls_to_psa_error( ret ) );
2353}
2354
2355psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2356 const uint8_t *input,
2357 size_t input_length )
2358{
Janos Follath24eed8d2019-11-22 13:21:35 +00002359 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002360
2361 /* Don't require hash implementations to behave correctly on a
2362 * zero-length input, which may have an invalid pointer. */
2363 if( input_length == 0 )
2364 return( PSA_SUCCESS );
2365
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002366 switch( operation->alg )
2367 {
John Durkopee4e6602020-11-27 08:48:46 -08002368#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002369 case PSA_ALG_MD2:
2370 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2371 input, input_length );
2372 break;
2373#endif
John Durkopee4e6602020-11-27 08:48:46 -08002374#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002375 case PSA_ALG_MD4:
2376 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2377 input, input_length );
2378 break;
2379#endif
John Durkopee4e6602020-11-27 08:48:46 -08002380#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002381 case PSA_ALG_MD5:
2382 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2383 input, input_length );
2384 break;
2385#endif
John Durkopee4e6602020-11-27 08:48:46 -08002386#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002387 case PSA_ALG_RIPEMD160:
2388 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2389 input, input_length );
2390 break;
2391#endif
John Durkopee4e6602020-11-27 08:48:46 -08002392#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393 case PSA_ALG_SHA_1:
2394 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2395 input, input_length );
2396 break;
2397#endif
John Durkop6ca23272020-12-03 06:01:32 -08002398#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002400 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2401 input, input_length );
2402 break;
2403#endif
2404#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002405 case PSA_ALG_SHA_256:
2406 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2407 input, input_length );
2408 break;
2409#endif
John Durkop6ca23272020-12-03 06:01:32 -08002410#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002412 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2413 input, input_length );
2414 break;
2415#endif
2416#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002417 case PSA_ALG_SHA_512:
2418 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2419 input, input_length );
2420 break;
2421#endif
2422 default:
John Durkopee4e6602020-11-27 08:48:46 -08002423 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002424 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002426
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002427 if( ret != 0 )
2428 psa_hash_abort( operation );
2429 return( mbedtls_to_psa_error( ret ) );
2430}
2431
2432psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2433 uint8_t *hash,
2434 size_t hash_size,
2435 size_t *hash_length )
2436{
itayzafrir40835d42018-08-02 13:14:17 +03002437 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002438 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002439 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002440
2441 /* Fill the output buffer with something that isn't a valid hash
2442 * (barring an attack on the hash and deliberately-crafted input),
2443 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002444 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002445 /* If hash_size is 0 then hash may be NULL and then the
2446 * call to memset would have undefined behavior. */
2447 if( hash_size != 0 )
2448 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002449
2450 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002451 {
2452 status = PSA_ERROR_BUFFER_TOO_SMALL;
2453 goto exit;
2454 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002455
2456 switch( operation->alg )
2457 {
John Durkopee4e6602020-11-27 08:48:46 -08002458#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002459 case PSA_ALG_MD2:
2460 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2461 break;
2462#endif
John Durkopee4e6602020-11-27 08:48:46 -08002463#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002464 case PSA_ALG_MD4:
2465 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2466 break;
2467#endif
John Durkopee4e6602020-11-27 08:48:46 -08002468#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002469 case PSA_ALG_MD5:
2470 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2471 break;
2472#endif
John Durkopee4e6602020-11-27 08:48:46 -08002473#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002474 case PSA_ALG_RIPEMD160:
2475 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2476 break;
2477#endif
John Durkopee4e6602020-11-27 08:48:46 -08002478#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002479 case PSA_ALG_SHA_1:
2480 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2481 break;
2482#endif
John Durkop6ca23272020-12-03 06:01:32 -08002483#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002484 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002485 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2486 break;
2487#endif
2488#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002489 case PSA_ALG_SHA_256:
2490 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2491 break;
2492#endif
John Durkop6ca23272020-12-03 06:01:32 -08002493#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002494 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002495 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2496 break;
2497#endif
2498#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002499 case PSA_ALG_SHA_512:
2500 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2501 break;
2502#endif
2503 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002504 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505 }
itayzafrir40835d42018-08-02 13:14:17 +03002506 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002507
itayzafrir40835d42018-08-02 13:14:17 +03002508exit:
2509 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002510 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002511 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002512 return( psa_hash_abort( operation ) );
2513 }
2514 else
2515 {
2516 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002517 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002518 }
2519}
2520
Gilles Peskine2d277862018-06-18 15:41:12 +02002521psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2522 const uint8_t *hash,
2523 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002524{
2525 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2526 size_t actual_hash_length;
2527 psa_status_t status = psa_hash_finish( operation,
2528 actual_hash, sizeof( actual_hash ),
2529 &actual_hash_length );
2530 if( status != PSA_SUCCESS )
2531 return( status );
2532 if( actual_hash_length != hash_length )
2533 return( PSA_ERROR_INVALID_SIGNATURE );
2534 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2535 return( PSA_ERROR_INVALID_SIGNATURE );
2536 return( PSA_SUCCESS );
2537}
2538
Gilles Peskine0a749c82019-11-28 19:33:58 +01002539psa_status_t psa_hash_compute( psa_algorithm_t alg,
2540 const uint8_t *input, size_t input_length,
2541 uint8_t *hash, size_t hash_size,
2542 size_t *hash_length )
2543{
2544 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2545 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2546
2547 *hash_length = hash_size;
2548 status = psa_hash_setup( &operation, alg );
2549 if( status != PSA_SUCCESS )
2550 goto exit;
2551 status = psa_hash_update( &operation, input, input_length );
2552 if( status != PSA_SUCCESS )
2553 goto exit;
2554 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2555 if( status != PSA_SUCCESS )
2556 goto exit;
2557
2558exit:
2559 if( status == PSA_SUCCESS )
2560 status = psa_hash_abort( &operation );
2561 else
2562 psa_hash_abort( &operation );
2563 return( status );
2564}
2565
2566psa_status_t psa_hash_compare( psa_algorithm_t alg,
2567 const uint8_t *input, size_t input_length,
2568 const uint8_t *hash, size_t hash_length )
2569{
2570 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2571 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2572
2573 status = psa_hash_setup( &operation, alg );
2574 if( status != PSA_SUCCESS )
2575 goto exit;
2576 status = psa_hash_update( &operation, input, input_length );
2577 if( status != PSA_SUCCESS )
2578 goto exit;
2579 status = psa_hash_verify( &operation, hash, hash_length );
2580 if( status != PSA_SUCCESS )
2581 goto exit;
2582
2583exit:
2584 if( status == PSA_SUCCESS )
2585 status = psa_hash_abort( &operation );
2586 else
2587 psa_hash_abort( &operation );
2588 return( status );
2589}
2590
Gilles Peskineeb35d782019-01-22 17:56:16 +01002591psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2592 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002593{
2594 if( target_operation->alg != 0 )
2595 return( PSA_ERROR_BAD_STATE );
2596
2597 switch( source_operation->alg )
2598 {
2599 case 0:
2600 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002601#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002602 case PSA_ALG_MD2:
2603 mbedtls_md2_clone( &target_operation->ctx.md2,
2604 &source_operation->ctx.md2 );
2605 break;
2606#endif
John Durkopee4e6602020-11-27 08:48:46 -08002607#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002608 case PSA_ALG_MD4:
2609 mbedtls_md4_clone( &target_operation->ctx.md4,
2610 &source_operation->ctx.md4 );
2611 break;
2612#endif
John Durkopee4e6602020-11-27 08:48:46 -08002613#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002614 case PSA_ALG_MD5:
2615 mbedtls_md5_clone( &target_operation->ctx.md5,
2616 &source_operation->ctx.md5 );
2617 break;
2618#endif
John Durkopee4e6602020-11-27 08:48:46 -08002619#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002620 case PSA_ALG_RIPEMD160:
2621 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2622 &source_operation->ctx.ripemd160 );
2623 break;
2624#endif
John Durkopee4e6602020-11-27 08:48:46 -08002625#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002626 case PSA_ALG_SHA_1:
2627 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2628 &source_operation->ctx.sha1 );
2629 break;
2630#endif
John Durkop6ca23272020-12-03 06:01:32 -08002631#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002632 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002633 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2634 &source_operation->ctx.sha256 );
2635 break;
2636#endif
2637#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002638 case PSA_ALG_SHA_256:
2639 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2640 &source_operation->ctx.sha256 );
2641 break;
2642#endif
John Durkop6ca23272020-12-03 06:01:32 -08002643#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002644 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002645 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2646 &source_operation->ctx.sha512 );
2647 break;
2648#endif
2649#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002650 case PSA_ALG_SHA_512:
2651 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2652 &source_operation->ctx.sha512 );
2653 break;
2654#endif
2655 default:
2656 return( PSA_ERROR_NOT_SUPPORTED );
2657 }
2658
2659 target_operation->alg = source_operation->alg;
2660 return( PSA_SUCCESS );
2661}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002662
2663
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002664/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665/* MAC */
2666/****************************************************************/
2667
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002668static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002669 psa_algorithm_t alg,
2670 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002671 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002672 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002673{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002674 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002675 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002676
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002677 if( PSA_ALG_IS_AEAD( alg ) )
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002678 alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002679
Gilles Peskine8c9def32018-02-08 10:02:12 +01002680 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2681 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002682 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002684 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002685 mode = MBEDTLS_MODE_STREAM;
2686 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002687 case PSA_ALG_CTR:
2688 mode = MBEDTLS_MODE_CTR;
2689 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002690 case PSA_ALG_CFB:
2691 mode = MBEDTLS_MODE_CFB;
2692 break;
2693 case PSA_ALG_OFB:
2694 mode = MBEDTLS_MODE_OFB;
2695 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002696 case PSA_ALG_ECB_NO_PADDING:
2697 mode = MBEDTLS_MODE_ECB;
2698 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002699 case PSA_ALG_CBC_NO_PADDING:
2700 mode = MBEDTLS_MODE_CBC;
2701 break;
2702 case PSA_ALG_CBC_PKCS7:
2703 mode = MBEDTLS_MODE_CBC;
2704 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002705 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002706 mode = MBEDTLS_MODE_CCM;
2707 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002708 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002709 mode = MBEDTLS_MODE_GCM;
2710 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002711 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02002712 mode = MBEDTLS_MODE_CHACHAPOLY;
2713 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002714 default:
2715 return( NULL );
2716 }
2717 }
2718 else if( alg == PSA_ALG_CMAC )
2719 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002720 else
2721 return( NULL );
2722
2723 switch( key_type )
2724 {
2725 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002726 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727 break;
2728 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002729 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2730 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002731 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002732 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002734 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002735 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2736 * but two-key Triple-DES is functionally three-key Triple-DES
2737 * with K1=K3, so that's how we present it to mbedtls. */
2738 if( key_bits == 128 )
2739 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740 break;
2741 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002742 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743 break;
2744 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002745 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002746 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002747 case PSA_KEY_TYPE_CHACHA20:
2748 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2749 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002750 default:
2751 return( NULL );
2752 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002753 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002754 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002755
Jaeden Amero23bbb752018-06-26 14:16:54 +01002756 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2757 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002758}
2759
John Durkop6ba40d12020-11-10 08:50:04 -08002760#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002761static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002762{
Gilles Peskine2d277862018-06-18 15:41:12 +02002763 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002764 {
2765 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002766 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002767 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002768 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002769 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002770 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002771 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002772 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002773 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002774 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002775 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002776 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002777 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002778 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002779 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002780 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002781 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002782 return( 128 );
2783 default:
2784 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002785 }
2786}
John Durkop07cc04a2020-11-16 22:08:34 -08002787#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002788
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002789/* Initialize the MAC operation structure. Once this function has been
2790 * called, psa_mac_abort can run and will do the right thing. */
2791static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2792 psa_algorithm_t alg )
2793{
2794 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2795
Steven Cooreman15472f82021-03-02 16:16:22 +01002796 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002797 operation->key_set = 0;
2798 operation->iv_set = 0;
2799 operation->iv_required = 0;
2800 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002801 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002802
2803#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002804 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002805 {
2806 operation->iv_required = 0;
2807 mbedtls_cipher_init( &operation->ctx.cmac );
2808 status = PSA_SUCCESS;
2809 }
2810 else
2811#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002812#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002813 if( PSA_ALG_IS_HMAC( operation->alg ) )
2814 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002815 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2816 operation->ctx.hmac.hash_ctx.alg = 0;
2817 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002818 }
2819 else
John Durkopd0321952020-10-29 21:37:36 -07002820#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002821 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002822 if( ! PSA_ALG_IS_MAC( alg ) )
2823 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002824 }
2825
2826 if( status != PSA_SUCCESS )
2827 memset( operation, 0, sizeof( *operation ) );
2828 return( status );
2829}
2830
John Durkop6ba40d12020-11-10 08:50:04 -08002831#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002832static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2833{
Gilles Peskine3f108122018-12-07 18:14:53 +01002834 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002835 return( psa_hash_abort( &hmac->hash_ctx ) );
2836}
John Durkop6ba40d12020-11-10 08:50:04 -08002837#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002838
Gilles Peskine8c9def32018-02-08 10:02:12 +01002839psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2840{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002841 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002842 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002843 /* The object has (apparently) been initialized but it is not
2844 * in use. It's ok to call abort on such an object, and there's
2845 * nothing to do. */
2846 return( PSA_SUCCESS );
2847 }
2848 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002849#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002850 if( operation->alg == PSA_ALG_CMAC )
2851 {
2852 mbedtls_cipher_free( &operation->ctx.cmac );
2853 }
2854 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002855#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002856#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002857 if( PSA_ALG_IS_HMAC( operation->alg ) )
2858 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002859 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002860 }
2861 else
John Durkopd0321952020-10-29 21:37:36 -07002862#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002863 {
2864 /* Sanity check (shouldn't happen: operation->alg should
2865 * always have been initialized to a valid value). */
2866 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002867 }
Moran Peker41deec42018-04-04 15:43:05 +03002868
Gilles Peskine8c9def32018-02-08 10:02:12 +01002869 operation->alg = 0;
2870 operation->key_set = 0;
2871 operation->iv_set = 0;
2872 operation->iv_required = 0;
2873 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002874 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002875
Gilles Peskine8c9def32018-02-08 10:02:12 +01002876 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002877
2878bad_state:
2879 /* If abort is called on an uninitialized object, we can't trust
2880 * anything. Wipe the object in case it contains confidential data.
2881 * This may result in a memory leak if a pointer gets overwritten,
2882 * but it's too late to do anything about this. */
2883 memset( operation, 0, sizeof( *operation ) );
2884 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002885}
2886
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002887#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002888static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2889 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002890{
Janos Follath24eed8d2019-11-22 13:21:35 +00002891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002892 const mbedtls_cipher_info_t *cipher_info =
2893 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2894 slot->attr.type, slot->attr.bits,
2895 NULL );
2896 if( cipher_info == NULL )
2897 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002898
2899 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2900 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002901 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002902
2903 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002904 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002905 slot->attr.bits );
2906exit:
2907 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002908}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002909#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002910
John Durkop6ba40d12020-11-10 08:50:04 -08002911#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002912static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2913 const uint8_t *key,
2914 size_t key_length,
2915 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002916{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002917 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002918 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002919 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002920 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002921 psa_status_t status;
2922
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002923 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2924 * overflow below. This should never trigger if the hash algorithm
2925 * is implemented correctly. */
2926 /* The size checks against the ipad and opad buffers cannot be written
2927 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2928 * because that triggers -Wlogical-op on GCC 7.3. */
2929 if( block_size > sizeof( ipad ) )
2930 return( PSA_ERROR_NOT_SUPPORTED );
2931 if( block_size > sizeof( hmac->opad ) )
2932 return( PSA_ERROR_NOT_SUPPORTED );
2933 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002934 return( PSA_ERROR_NOT_SUPPORTED );
2935
Gilles Peskined223b522018-06-11 18:12:58 +02002936 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002937 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002938 status = psa_hash_compute( hash_alg, key, key_length,
2939 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002940 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002941 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002942 }
Gilles Peskine96889972018-07-12 17:07:03 +02002943 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2944 * but it is permitted. It is common when HMAC is used in HKDF, for
2945 * example. Don't call `memcpy` in the 0-length because `key` could be
2946 * an invalid pointer which would make the behavior undefined. */
2947 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002948 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002949
Gilles Peskined223b522018-06-11 18:12:58 +02002950 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2951 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002952 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002953 ipad[i] ^= 0x36;
2954 memset( ipad + key_length, 0x36, block_size - key_length );
2955
2956 /* Copy the key material from ipad to opad, flipping the requisite bits,
2957 * and filling the rest of opad with the requisite constant. */
2958 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002959 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2960 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002961
Gilles Peskine01126fa2018-07-12 17:04:55 +02002962 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002963 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002964 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002965
Gilles Peskine01126fa2018-07-12 17:04:55 +02002966 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002967
2968cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002969 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002970
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002971 return( status );
2972}
John Durkop6ba40d12020-11-10 08:50:04 -08002973#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002974
Gilles Peskine89167cb2018-07-08 20:12:23 +02002975static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002976 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002977 psa_algorithm_t alg,
2978 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002979{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002980 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002981 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002982 psa_key_slot_t *slot;
Steven Cooreman15472f82021-03-02 16:16:22 +01002983 size_t output_length = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002984 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002985 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002986
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002987 /* A context must be freshly initialized before it can be set up. */
2988 if( operation->alg != 0 )
2989 {
2990 return( PSA_ERROR_BAD_STATE );
2991 }
2992
Steven Cooreman15472f82021-03-02 16:16:22 +01002993 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002994 if( status != PSA_SUCCESS )
2995 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002996 if( is_sign )
2997 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002998
Ronald Cron5c522922020-11-14 16:35:34 +01002999 status = psa_get_and_lock_transparent_key_slot_with_policy(
3000 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003001 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003002 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01003003
3004 status = psa_get_mac_output_length( alg, slot->attr.type,
3005 &output_length );
3006 if( status != PSA_SUCCESS )
3007 goto exit;
3008
3009 operation->mac_size = (uint8_t) output_length;
3010
3011 if( operation->mac_size < 4 )
3012 {
3013 /* A very short MAC is too short for security since it can be
3014 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3015 * so we make this our minimum, even though 32 bits is still
3016 * too small for security. */
3017 status = PSA_ERROR_NOT_SUPPORTED;
3018 goto exit;
3019 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003020
Gilles Peskine8c9def32018-02-08 10:02:12 +01003021#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01003022 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003023 {
Steven Cooreman15472f82021-03-02 16:16:22 +01003024 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003025 }
3026 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003027#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003028#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01003029 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003030 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003031 /* Sanity check. This shouldn't fail on a valid configuration. */
3032 if( operation->mac_size == 0 ||
3033 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3034 {
3035 status = PSA_ERROR_NOT_SUPPORTED;
3036 goto exit;
3037 }
3038
Gilles Peskine8e338702019-07-30 20:06:31 +02003039 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003040 {
3041 status = PSA_ERROR_INVALID_ARGUMENT;
3042 goto exit;
3043 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003044
Gilles Peskine01126fa2018-07-12 17:04:55 +02003045 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003046 slot->key.data,
3047 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01003048 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003049 }
3050 else
John Durkopd0321952020-10-29 21:37:36 -07003051#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003052 {
3053 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003054 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003055
Gilles Peskinefbfac682018-07-08 20:51:54 +02003056exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003057 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003058 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003059 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003060 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003061 else
3062 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003063 operation->key_set = 1;
3064 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003065
Ronald Cron5c522922020-11-14 16:35:34 +01003066 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003067
Ronald Cron5c522922020-11-14 16:35:34 +01003068 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003069}
3070
Gilles Peskine89167cb2018-07-08 20:12:23 +02003071psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003072 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003073 psa_algorithm_t alg )
3074{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003075 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003076}
3077
3078psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003079 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003080 psa_algorithm_t alg )
3081{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003082 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003083}
3084
Gilles Peskine8c9def32018-02-08 10:02:12 +01003085psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3086 const uint8_t *input,
3087 size_t input_length )
3088{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003089 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003090 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003091 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003092 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003093 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003094 operation->has_input = 1;
3095
Gilles Peskine8c9def32018-02-08 10:02:12 +01003096#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003097 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003098 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003099 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3100 input, input_length );
3101 status = mbedtls_to_psa_error( ret );
3102 }
3103 else
3104#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003105#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003106 if( PSA_ALG_IS_HMAC( operation->alg ) )
3107 {
3108 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3109 input_length );
3110 }
3111 else
John Durkopd0321952020-10-29 21:37:36 -07003112#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003113 {
3114 /* This shouldn't happen if `operation` was initialized by
3115 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003116 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003117 }
3118
Gilles Peskinefbfac682018-07-08 20:51:54 +02003119 if( status != PSA_SUCCESS )
3120 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003121 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003122}
3123
John Durkop6ba40d12020-11-10 08:50:04 -08003124#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003125static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3126 uint8_t *mac,
3127 size_t mac_size )
3128{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003129 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003130 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3131 size_t hash_size = 0;
3132 size_t block_size = psa_get_hash_block_size( hash_alg );
3133 psa_status_t status;
3134
Gilles Peskine01126fa2018-07-12 17:04:55 +02003135 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3136 if( status != PSA_SUCCESS )
3137 return( status );
3138 /* From here on, tmp needs to be wiped. */
3139
3140 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3141 if( status != PSA_SUCCESS )
3142 goto exit;
3143
3144 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3145 if( status != PSA_SUCCESS )
3146 goto exit;
3147
3148 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3149 if( status != PSA_SUCCESS )
3150 goto exit;
3151
Gilles Peskined911eb72018-08-14 15:18:45 +02003152 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3153 if( status != PSA_SUCCESS )
3154 goto exit;
3155
3156 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003157
3158exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003159 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003160 return( status );
3161}
John Durkop6ba40d12020-11-10 08:50:04 -08003162#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003163
mohammad16036df908f2018-04-02 08:34:15 -07003164static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003165 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003166 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003167{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003168 if( ! operation->key_set )
3169 return( PSA_ERROR_BAD_STATE );
3170 if( operation->iv_required && ! operation->iv_set )
3171 return( PSA_ERROR_BAD_STATE );
3172
Gilles Peskine8c9def32018-02-08 10:02:12 +01003173 if( mac_size < operation->mac_size )
3174 return( PSA_ERROR_BUFFER_TOO_SMALL );
3175
Gilles Peskine8c9def32018-02-08 10:02:12 +01003176#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003177 if( operation->alg == PSA_ALG_CMAC )
3178 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003179 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003180 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3181 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003182 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003183 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003184 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003185 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003186 else
3187#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003188#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003189 if( PSA_ALG_IS_HMAC( operation->alg ) )
3190 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003191 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003192 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003193 }
3194 else
John Durkopd0321952020-10-29 21:37:36 -07003195#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003196 {
3197 /* This shouldn't happen if `operation` was initialized by
3198 * a setup function. */
3199 return( PSA_ERROR_BAD_STATE );
3200 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003201}
3202
Gilles Peskineacd4be32018-07-08 19:56:25 +02003203psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3204 uint8_t *mac,
3205 size_t mac_size,
3206 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003207{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003208 psa_status_t status;
3209
Jaeden Amero252ef282019-02-15 14:05:35 +00003210 if( operation->alg == 0 )
3211 {
3212 return( PSA_ERROR_BAD_STATE );
3213 }
3214
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003215 /* Fill the output buffer with something that isn't a valid mac
3216 * (barring an attack on the mac and deliberately-crafted input),
3217 * in case the caller doesn't check the return status properly. */
3218 *mac_length = mac_size;
3219 /* If mac_size is 0 then mac may be NULL and then the
3220 * call to memset would have undefined behavior. */
3221 if( mac_size != 0 )
3222 memset( mac, '!', mac_size );
3223
Gilles Peskine89167cb2018-07-08 20:12:23 +02003224 if( ! operation->is_sign )
3225 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003226 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003227 }
mohammad16036df908f2018-04-02 08:34:15 -07003228
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003229 status = psa_mac_finish_internal( operation, mac, mac_size );
3230
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003231 if( status == PSA_SUCCESS )
3232 {
3233 status = psa_mac_abort( operation );
3234 if( status == PSA_SUCCESS )
3235 *mac_length = operation->mac_size;
3236 else
3237 memset( mac, '!', mac_size );
3238 }
3239 else
3240 psa_mac_abort( operation );
3241 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003242}
3243
Gilles Peskineacd4be32018-07-08 19:56:25 +02003244psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3245 const uint8_t *mac,
3246 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003247{
Gilles Peskine828ed142018-06-18 23:25:51 +02003248 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003249 psa_status_t status;
3250
Jaeden Amero252ef282019-02-15 14:05:35 +00003251 if( operation->alg == 0 )
3252 {
3253 return( PSA_ERROR_BAD_STATE );
3254 }
3255
Gilles Peskine89167cb2018-07-08 20:12:23 +02003256 if( operation->is_sign )
3257 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003258 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003259 }
3260 if( operation->mac_size != mac_length )
3261 {
3262 status = PSA_ERROR_INVALID_SIGNATURE;
3263 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003264 }
mohammad16036df908f2018-04-02 08:34:15 -07003265
3266 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003267 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003268 if( status != PSA_SUCCESS )
3269 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003270
3271 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3272 status = PSA_ERROR_INVALID_SIGNATURE;
3273
3274cleanup:
3275 if( status == PSA_SUCCESS )
3276 status = psa_mac_abort( operation );
3277 else
3278 psa_mac_abort( operation );
3279
Gilles Peskine3f108122018-12-07 18:14:53 +01003280 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003281
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003282 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003283}
3284
3285
Gilles Peskine20035e32018-02-03 22:44:14 +01003286
Gilles Peskine20035e32018-02-03 22:44:14 +01003287/****************************************************************/
3288/* Asymmetric cryptography */
3289/****************************************************************/
3290
John Durkop6ba40d12020-11-10 08:50:04 -08003291#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3292 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003293/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003294 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003295static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3296 size_t hash_length,
3297 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003298{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003299 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003300 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003301 *md_alg = mbedtls_md_get_type( md_info );
3302
3303 /* The Mbed TLS RSA module uses an unsigned int for hash length
3304 * parameters. Validate that it fits so that we don't risk an
3305 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003306#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003307 if( hash_length > UINT_MAX )
3308 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003309#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003310
John Durkop0e005192020-10-31 22:06:54 -07003311#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003312 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3313 * must be correct. */
3314 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3315 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003316 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003317 if( md_info == NULL )
3318 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003319 if( mbedtls_md_get_size( md_info ) != hash_length )
3320 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003321 }
John Durkop0e005192020-10-31 22:06:54 -07003322#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003323
John Durkop0e005192020-10-31 22:06:54 -07003324#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003325 /* PSS requires a hash internally. */
3326 if( PSA_ALG_IS_RSA_PSS( alg ) )
3327 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003328 if( md_info == NULL )
3329 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003330 }
John Durkop0e005192020-10-31 22:06:54 -07003331#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003332
Gilles Peskine61b91d42018-06-08 16:09:36 +02003333 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003334}
3335
Gilles Peskine2b450e32018-06-27 15:42:46 +02003336static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3337 psa_algorithm_t alg,
3338 const uint8_t *hash,
3339 size_t hash_length,
3340 uint8_t *signature,
3341 size_t signature_size,
3342 size_t *signature_length )
3343{
3344 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003345 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003346 mbedtls_md_type_t md_alg;
3347
3348 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3349 if( status != PSA_SUCCESS )
3350 return( status );
3351
Gilles Peskine630a18a2018-06-29 17:49:35 +02003352 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003353 return( PSA_ERROR_BUFFER_TOO_SMALL );
3354
John Durkop0e005192020-10-31 22:06:54 -07003355#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003356 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3357 {
3358 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3359 MBEDTLS_MD_NONE );
3360 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003361 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003362 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003363 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003364 md_alg,
3365 (unsigned int) hash_length,
3366 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003367 signature );
3368 }
3369 else
John Durkop0e005192020-10-31 22:06:54 -07003370#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3371#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003372 if( PSA_ALG_IS_RSA_PSS( alg ) )
3373 {
3374 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3375 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003376 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003377 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003378 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003379 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003380 (unsigned int) hash_length,
3381 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003382 signature );
3383 }
3384 else
John Durkop0e005192020-10-31 22:06:54 -07003385#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003386 {
3387 return( PSA_ERROR_INVALID_ARGUMENT );
3388 }
3389
3390 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003391 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003392 return( mbedtls_to_psa_error( ret ) );
3393}
3394
3395static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3396 psa_algorithm_t alg,
3397 const uint8_t *hash,
3398 size_t hash_length,
3399 const uint8_t *signature,
3400 size_t signature_length )
3401{
3402 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003403 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003404 mbedtls_md_type_t md_alg;
3405
3406 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3407 if( status != PSA_SUCCESS )
3408 return( status );
3409
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003410 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3411 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003412
John Durkop0e005192020-10-31 22:06:54 -07003413#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003414 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3415 {
3416 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3417 MBEDTLS_MD_NONE );
3418 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003419 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003420 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003421 MBEDTLS_RSA_PUBLIC,
3422 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003423 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003424 hash,
3425 signature );
3426 }
3427 else
John Durkop0e005192020-10-31 22:06:54 -07003428#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3429#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003430 if( PSA_ALG_IS_RSA_PSS( alg ) )
3431 {
3432 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3433 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003434 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003435 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003436 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003437 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003438 (unsigned int) hash_length,
3439 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003440 signature );
3441 }
3442 else
John Durkop0e005192020-10-31 22:06:54 -07003443#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003444 {
3445 return( PSA_ERROR_INVALID_ARGUMENT );
3446 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003447
3448 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3449 * the rest of the signature is invalid". This has little use in
3450 * practice and PSA doesn't report this distinction. */
3451 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3452 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003453 return( mbedtls_to_psa_error( ret ) );
3454}
John Durkop6ba40d12020-11-10 08:50:04 -08003455#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3456 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003457
John Durkop6ba40d12020-11-10 08:50:04 -08003458#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3459 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003460/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3461 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3462 * (even though these functions don't modify it). */
3463static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3464 psa_algorithm_t alg,
3465 const uint8_t *hash,
3466 size_t hash_length,
3467 uint8_t *signature,
3468 size_t signature_size,
3469 size_t *signature_length )
3470{
Janos Follath24eed8d2019-11-22 13:21:35 +00003471 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003472 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003473 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003474 mbedtls_mpi_init( &r );
3475 mbedtls_mpi_init( &s );
3476
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003477 if( signature_size < 2 * curve_bytes )
3478 {
3479 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3480 goto cleanup;
3481 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003482
John Durkop0ea39e02020-10-13 19:58:20 -07003483#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003484 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3485 {
3486 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3487 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3488 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003489 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3490 &ecp->d, hash,
3491 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003492 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003493 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003494 }
3495 else
John Durkop0ea39e02020-10-13 19:58:20 -07003496#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003497 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003498 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003499 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3500 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003501 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003502 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003503 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003504
3505 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3506 signature,
3507 curve_bytes ) );
3508 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3509 signature + curve_bytes,
3510 curve_bytes ) );
3511
3512cleanup:
3513 mbedtls_mpi_free( &r );
3514 mbedtls_mpi_free( &s );
3515 if( ret == 0 )
3516 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003517 return( mbedtls_to_psa_error( ret ) );
3518}
3519
3520static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3521 const uint8_t *hash,
3522 size_t hash_length,
3523 const uint8_t *signature,
3524 size_t signature_length )
3525{
Janos Follath24eed8d2019-11-22 13:21:35 +00003526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003527 mbedtls_mpi r, s;
3528 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3529 mbedtls_mpi_init( &r );
3530 mbedtls_mpi_init( &s );
3531
3532 if( signature_length != 2 * curve_bytes )
3533 return( PSA_ERROR_INVALID_SIGNATURE );
3534
3535 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3536 signature,
3537 curve_bytes ) );
3538 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3539 signature + curve_bytes,
3540 curve_bytes ) );
3541
Steven Cooremanacda8342020-07-24 23:09:52 +02003542 /* Check whether the public part is loaded. If not, load it. */
3543 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3544 {
3545 MBEDTLS_MPI_CHK(
3546 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003547 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003548 }
3549
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003550 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3551 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003552
3553cleanup:
3554 mbedtls_mpi_free( &r );
3555 mbedtls_mpi_free( &s );
3556 return( mbedtls_to_psa_error( ret ) );
3557}
John Durkop6ba40d12020-11-10 08:50:04 -08003558#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3559 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003560
Ronald Croncf56a0a2020-08-04 09:51:30 +02003561psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003562 psa_algorithm_t alg,
3563 const uint8_t *hash,
3564 size_t hash_length,
3565 uint8_t *signature,
3566 size_t signature_size,
3567 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003568{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003569 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003570 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003571 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003572
3573 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003574 /* Immediately reject a zero-length signature buffer. This guarantees
3575 * that signature must be a valid pointer. (On the other hand, the hash
3576 * buffer can in principle be empty since it doesn't actually have
3577 * to be a hash.) */
3578 if( signature_size == 0 )
3579 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003580
Ronald Cron5c522922020-11-14 16:35:34 +01003581 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3582 PSA_KEY_USAGE_SIGN_HASH,
3583 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003584 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003585 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003586 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003587 {
3588 status = PSA_ERROR_INVALID_ARGUMENT;
3589 goto exit;
3590 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003591
Steven Cooremancd84cb42020-07-16 20:28:36 +02003592 /* Try any of the available accelerators first */
3593 status = psa_driver_wrapper_sign_hash( slot,
3594 alg,
3595 hash,
3596 hash_length,
3597 signature,
3598 signature_size,
3599 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003600 if( status != PSA_ERROR_NOT_SUPPORTED ||
3601 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003602 goto exit;
3603
Steven Cooreman7a250572020-07-17 16:43:05 +02003604 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003605#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3606 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003607 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003608 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003609 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003610
Ronald Cron90857082020-11-25 14:58:33 +01003611 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3612 slot->key.data,
3613 slot->key.bytes,
3614 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003615 if( status != PSA_SUCCESS )
3616 goto exit;
3617
Steven Cooremana2371e52020-07-28 14:30:39 +02003618 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003619 alg,
3620 hash, hash_length,
3621 signature, signature_size,
3622 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003623
Steven Cooremana2371e52020-07-28 14:30:39 +02003624 mbedtls_rsa_free( rsa );
3625 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003626 }
3627 else
John Durkop6ba40d12020-11-10 08:50:04 -08003628#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3629 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003630 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003631 {
John Durkop9814fa22020-11-04 12:28:15 -08003632#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3633 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003634 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003635#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003636 PSA_ALG_IS_ECDSA( alg )
3637#else
3638 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3639#endif
3640 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003641 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003642 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003643 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01003644 slot->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01003645 slot->key.data,
3646 slot->key.bytes,
3647 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003648 if( status != PSA_SUCCESS )
3649 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003650 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003651 alg,
3652 hash, hash_length,
3653 signature, signature_size,
3654 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003655 mbedtls_ecp_keypair_free( ecp );
3656 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003657 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003658 else
John Durkop9814fa22020-11-04 12:28:15 -08003659#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3660 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003661 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003662 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003663 }
itayzafrir5c753392018-05-08 11:18:38 +03003664 }
3665 else
itayzafrir5c753392018-05-08 11:18:38 +03003666 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003667 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003668 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003669
3670exit:
3671 /* Fill the unused part of the output buffer (the whole buffer on error,
3672 * the trailing part on success) with something that isn't a valid mac
3673 * (barring an attack on the mac and deliberately-crafted input),
3674 * in case the caller doesn't check the return status properly. */
3675 if( status == PSA_SUCCESS )
3676 memset( signature + *signature_length, '!',
3677 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003678 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003679 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003680 /* If signature_size is 0 then we have nothing to do. We must not call
3681 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003682
Ronald Cron5c522922020-11-14 16:35:34 +01003683 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003684
Ronald Cron5c522922020-11-14 16:35:34 +01003685 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003686}
3687
Ronald Croncf56a0a2020-08-04 09:51:30 +02003688psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003689 psa_algorithm_t alg,
3690 const uint8_t *hash,
3691 size_t hash_length,
3692 const uint8_t *signature,
3693 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003694{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003696 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003697 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003698
Ronald Cron5c522922020-11-14 16:35:34 +01003699 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3700 PSA_KEY_USAGE_VERIFY_HASH,
3701 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003702 if( status != PSA_SUCCESS )
3703 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003704
Steven Cooreman55ae2172020-07-17 19:46:15 +02003705 /* Try any of the available accelerators first */
3706 status = psa_driver_wrapper_verify_hash( slot,
3707 alg,
3708 hash,
3709 hash_length,
3710 signature,
3711 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003712 if( status != PSA_ERROR_NOT_SUPPORTED ||
3713 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003714 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003715
John Durkop6ba40d12020-11-10 08:50:04 -08003716#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3717 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003718 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003719 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003720 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003721
Ronald Cron90857082020-11-25 14:58:33 +01003722 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3723 slot->key.data,
3724 slot->key.bytes,
3725 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003726 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003727 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003728
Steven Cooremana2371e52020-07-28 14:30:39 +02003729 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003730 alg,
3731 hash, hash_length,
3732 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003733 mbedtls_rsa_free( rsa );
3734 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003735 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003736 }
3737 else
John Durkop6ba40d12020-11-10 08:50:04 -08003738#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3739 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003740 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003741 {
John Durkop9814fa22020-11-04 12:28:15 -08003742#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3743 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003744 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003745 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003746 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003747 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01003748 slot->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01003749 slot->key.data,
3750 slot->key.bytes,
3751 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003752 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003753 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003754 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003755 hash, hash_length,
3756 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003757 mbedtls_ecp_keypair_free( ecp );
3758 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003759 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003760 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003761 else
John Durkop9814fa22020-11-04 12:28:15 -08003762#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3763 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003764 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003765 status = PSA_ERROR_INVALID_ARGUMENT;
3766 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003767 }
itayzafrir5c753392018-05-08 11:18:38 +03003768 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003769 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003770 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003771 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003772 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003773
3774exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003775 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003776
Ronald Cron5c522922020-11-14 16:35:34 +01003777 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003778}
3779
John Durkop0e005192020-10-31 22:06:54 -07003780#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003781static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3782 mbedtls_rsa_context *rsa )
3783{
3784 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3785 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3786 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3787 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3788}
John Durkop0e005192020-10-31 22:06:54 -07003789#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003790
Ronald Croncf56a0a2020-08-04 09:51:30 +02003791psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003792 psa_algorithm_t alg,
3793 const uint8_t *input,
3794 size_t input_length,
3795 const uint8_t *salt,
3796 size_t salt_length,
3797 uint8_t *output,
3798 size_t output_size,
3799 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003800{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003801 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003802 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003803 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003804
Darryl Green5cc689a2018-07-24 15:34:10 +01003805 (void) input;
3806 (void) input_length;
3807 (void) salt;
3808 (void) output;
3809 (void) output_size;
3810
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003811 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003812
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003813 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3814 return( PSA_ERROR_INVALID_ARGUMENT );
3815
Ronald Cron5c522922020-11-14 16:35:34 +01003816 status = psa_get_and_lock_transparent_key_slot_with_policy(
3817 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003818 if( status != PSA_SUCCESS )
3819 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003820 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3821 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003822 {
3823 status = PSA_ERROR_INVALID_ARGUMENT;
3824 goto exit;
3825 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003826
John Durkop6ba40d12020-11-10 08:50:04 -08003827#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3828 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003829 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003830 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003831 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003832 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3833 slot->key.data,
3834 slot->key.bytes,
3835 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003836 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003837 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003838
3839 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003840 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003841 status = PSA_ERROR_BUFFER_TOO_SMALL;
3842 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003843 }
John Durkop0e005192020-10-31 22:06:54 -07003844#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003845 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003846 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003847 status = mbedtls_to_psa_error(
3848 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003849 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003850 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003851 MBEDTLS_RSA_PUBLIC,
3852 input_length,
3853 input,
3854 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003855 }
3856 else
John Durkop0e005192020-10-31 22:06:54 -07003857#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3858#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003859 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003860 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003861 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003862 status = mbedtls_to_psa_error(
3863 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003864 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003865 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003866 MBEDTLS_RSA_PUBLIC,
3867 salt, salt_length,
3868 input_length,
3869 input,
3870 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003871 }
3872 else
John Durkop0e005192020-10-31 22:06:54 -07003873#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003874 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003875 status = PSA_ERROR_INVALID_ARGUMENT;
3876 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003877 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003878rsa_exit:
3879 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003880 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003881
Steven Cooremana2371e52020-07-28 14:30:39 +02003882 mbedtls_rsa_free( rsa );
3883 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003884 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003885 else
John Durkop9814fa22020-11-04 12:28:15 -08003886#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003887 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003888 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003889 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003890 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003891
3892exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003893 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003894
Ronald Cron5c522922020-11-14 16:35:34 +01003895 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003896}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003897
Ronald Croncf56a0a2020-08-04 09:51:30 +02003898psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003899 psa_algorithm_t alg,
3900 const uint8_t *input,
3901 size_t input_length,
3902 const uint8_t *salt,
3903 size_t salt_length,
3904 uint8_t *output,
3905 size_t output_size,
3906 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003907{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003908 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003909 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003910 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003911
Darryl Green5cc689a2018-07-24 15:34:10 +01003912 (void) input;
3913 (void) input_length;
3914 (void) salt;
3915 (void) output;
3916 (void) output_size;
3917
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003918 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003919
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003920 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3921 return( PSA_ERROR_INVALID_ARGUMENT );
3922
Ronald Cron5c522922020-11-14 16:35:34 +01003923 status = psa_get_and_lock_transparent_key_slot_with_policy(
3924 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003925 if( status != PSA_SUCCESS )
3926 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003927 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003928 {
3929 status = PSA_ERROR_INVALID_ARGUMENT;
3930 goto exit;
3931 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003932
John Durkop6ba40d12020-11-10 08:50:04 -08003933#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3934 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003935 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003936 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003937 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003938 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3939 slot->key.data,
3940 slot->key.bytes,
3941 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003942 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003943 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003944
Steven Cooremana2371e52020-07-28 14:30:39 +02003945 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003946 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003947 status = PSA_ERROR_INVALID_ARGUMENT;
3948 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003949 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003950
John Durkop0e005192020-10-31 22:06:54 -07003951#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003952 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003953 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003954 status = mbedtls_to_psa_error(
3955 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003956 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003957 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003958 MBEDTLS_RSA_PRIVATE,
3959 output_length,
3960 input,
3961 output,
3962 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003963 }
3964 else
John Durkop0e005192020-10-31 22:06:54 -07003965#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3966#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003967 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003968 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003969 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003970 status = mbedtls_to_psa_error(
3971 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003972 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003973 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003974 MBEDTLS_RSA_PRIVATE,
3975 salt, salt_length,
3976 output_length,
3977 input,
3978 output,
3979 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003980 }
3981 else
John Durkop0e005192020-10-31 22:06:54 -07003982#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003983 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003984 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003985 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003986
Steven Cooreman4fed4552020-08-03 14:46:03 +02003987rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003988 mbedtls_rsa_free( rsa );
3989 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003990 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003991 else
John Durkop6ba40d12020-11-10 08:50:04 -08003992#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3993 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003994 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003995 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003996 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003997
3998exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003999 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004000
Ronald Cron5c522922020-11-14 16:35:34 +01004001 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004002}
Gilles Peskine20035e32018-02-03 22:44:14 +01004003
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004004
4005
mohammad1603503973b2018-03-12 15:59:30 +02004006/****************************************************************/
4007/* Symmetric cryptography */
4008/****************************************************************/
4009
Gilles Peskinee553c652018-06-04 16:22:46 +02004010static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004011 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004012 psa_algorithm_t alg,
4013 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004014{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004016 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004017 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004018 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004019 size_t key_bits;
4020 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004021 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4022 PSA_KEY_USAGE_ENCRYPT :
4023 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004024
Steven Cooremand3feccd2020-09-01 15:56:14 +02004025 /* A context must be freshly initialized before it can be set up. */
4026 if( operation->alg != 0 )
4027 return( PSA_ERROR_BAD_STATE );
4028
Steven Cooremana07b9972020-09-10 14:54:14 +02004029 /* The requested algorithm must be one that can be processed by cipher. */
4030 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004031 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004032
Steven Cooremanef8575e2020-09-11 11:44:50 +02004033 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004034 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004035 if( status != PSA_SUCCESS )
4036 goto exit;
4037
4038 /* Initialize the operation struct members, except for alg. The alg member
4039 * is used to indicate to psa_cipher_abort that there are resources to free,
4040 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004041 operation->key_set = 0;
4042 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004043 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004044 operation->iv_size = 0;
4045 operation->block_size = 0;
4046 if( alg == PSA_ALG_ECB_NO_PADDING )
4047 operation->iv_required = 0;
4048 else
4049 operation->iv_required = 1;
4050
Steven Cooremana07b9972020-09-10 14:54:14 +02004051 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004052 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004053 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004054 slot,
4055 alg );
4056 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004057 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004058 slot,
4059 alg );
4060
Steven Cooremanef8575e2020-09-11 11:44:50 +02004061 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004062 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004063 /* Once the driver context is initialised, it needs to be freed using
4064 * psa_cipher_abort. Indicate this through setting alg. */
4065 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004066 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004067
Steven Cooremand3feccd2020-09-01 15:56:14 +02004068 if( status != PSA_ERROR_NOT_SUPPORTED ||
4069 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4070 goto exit;
4071
Steven Cooremana07b9972020-09-10 14:54:14 +02004072 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004073 * available for the given algorithm & key. */
4074 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004075
Steven Cooremana07b9972020-09-10 14:54:14 +02004076 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004077 * psa_cipher_abort. Indicate there is something to be freed through setting
4078 * alg, and indicate the operation is being done using mbedtls crypto through
4079 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004080 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004081 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004082
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004083 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004084 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004085 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004086 {
4087 status = PSA_ERROR_NOT_SUPPORTED;
4088 goto exit;
4089 }
mohammad1603503973b2018-03-12 15:59:30 +02004090
mohammad1603503973b2018-03-12 15:59:30 +02004091 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004092 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004093 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004094
David Brown12ca5032021-02-11 11:02:00 -07004095#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004096 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004097 {
4098 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004099 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004100 memcpy( keys, slot->key.data, 16 );
4101 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004102 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4103 keys,
4104 192, cipher_operation );
4105 }
4106 else
4107#endif
4108 {
4109 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004110 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004111 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004112 }
Moran Peker41deec42018-04-04 15:43:05 +03004113 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004114 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004115
David Brown63ca2602021-01-26 11:51:12 -07004116#if defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
4117 defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004118 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004119 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004120 case PSA_ALG_CBC_NO_PADDING:
4121 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4122 MBEDTLS_PADDING_NONE );
4123 break;
4124 case PSA_ALG_CBC_PKCS7:
4125 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4126 MBEDTLS_PADDING_PKCS7 );
4127 break;
4128 default:
4129 /* The algorithm doesn't involve padding. */
4130 ret = 0;
4131 break;
4132 }
4133 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004134 goto exit;
David Brown288a96e2021-02-09 16:27:55 -07004135#endif /* MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING || MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7 */
mohammad16038481e742018-03-18 13:57:31 +02004136
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004137 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004138 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004139 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4140 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004141 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004142 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004143 }
David Brown1bfe4d72021-02-16 12:54:35 -07004144#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +02004145 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004146 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004147 operation->iv_size = 12;
4148#endif
mohammad1603503973b2018-03-12 15:59:30 +02004149
Steven Cooreman7df02922020-09-09 15:28:49 +02004150 status = PSA_SUCCESS;
4151
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004152exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004153 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004154 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004155 if( status == PSA_SUCCESS )
4156 {
4157 /* Update operation flags for both driver and software implementations */
4158 operation->key_set = 1;
4159 }
4160 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004161 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004162
Ronald Cron5c522922020-11-14 16:35:34 +01004163 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004164
Ronald Cron5c522922020-11-14 16:35:34 +01004165 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004166}
4167
Gilles Peskinefe119512018-07-08 21:39:34 +02004168psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004169 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004170 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004171{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004172 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004173}
4174
Gilles Peskinefe119512018-07-08 21:39:34 +02004175psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004176 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004177 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004178{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004179 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004180}
4181
Gilles Peskinefe119512018-07-08 21:39:34 +02004182psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004183 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004184 size_t iv_size,
4185 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004186{
itayzafrir534bd7c2018-08-02 13:56:32 +03004187 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004189 if( operation->iv_set || ! operation->iv_required )
4190 {
4191 return( PSA_ERROR_BAD_STATE );
4192 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004193
Steven Cooremanef8575e2020-09-11 11:44:50 +02004194 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004195 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004196 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004197 iv,
4198 iv_size,
4199 iv_length );
4200 goto exit;
4201 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004202
Moran Peker41deec42018-04-04 15:43:05 +03004203 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004204 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004205 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004206 goto exit;
4207 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004208 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004209 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004210 if( ret != 0 )
4211 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004212 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004213 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004214 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004215
mohammad16038481e742018-03-18 13:57:31 +02004216 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004217 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004218
Moran Peker395db872018-05-31 14:07:14 +03004219exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004220 if( status == PSA_SUCCESS )
4221 operation->iv_set = 1;
4222 else
Moran Peker395db872018-05-31 14:07:14 +03004223 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004224 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004225}
4226
Gilles Peskinefe119512018-07-08 21:39:34 +02004227psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004228 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004229 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004230{
itayzafrir534bd7c2018-08-02 13:56:32 +03004231 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004232 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004233 if( operation->iv_set || ! operation->iv_required )
4234 {
4235 return( PSA_ERROR_BAD_STATE );
4236 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004237
Steven Cooremanef8575e2020-09-11 11:44:50 +02004238 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004239 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004240 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004241 iv,
4242 iv_length );
4243 goto exit;
4244 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004245
Moran Pekera28258c2018-05-29 16:25:04 +03004246 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004247 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004248 status = PSA_ERROR_INVALID_ARGUMENT;
4249 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004250 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004251 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4252 status = mbedtls_to_psa_error( ret );
4253exit:
4254 if( status == PSA_SUCCESS )
4255 operation->iv_set = 1;
4256 else
mohammad1603503973b2018-03-12 15:59:30 +02004257 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004258 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004259}
4260
Steven Cooreman177deba2020-09-07 17:14:14 +02004261/* Process input for which the algorithm is set to ECB mode. This requires
4262 * manual processing, since the PSA API is defined as being able to process
4263 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4264 * underlying mbedtls_cipher_update only takes full blocks. */
4265static psa_status_t psa_cipher_update_ecb_internal(
4266 mbedtls_cipher_context_t *ctx,
4267 const uint8_t *input,
4268 size_t input_length,
4269 uint8_t *output,
4270 size_t output_size,
4271 size_t *output_length )
4272{
4273 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4274 size_t block_size = ctx->cipher_info->block_size;
4275 size_t internal_output_length = 0;
4276 *output_length = 0;
4277
4278 if( input_length == 0 )
4279 {
4280 status = PSA_SUCCESS;
4281 goto exit;
4282 }
4283
4284 if( ctx->unprocessed_len > 0 )
4285 {
4286 /* Fill up to block size, and run the block if there's a full one. */
4287 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4288
4289 if( input_length < bytes_to_copy )
4290 bytes_to_copy = input_length;
4291
4292 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4293 input, bytes_to_copy );
4294 input_length -= bytes_to_copy;
4295 input += bytes_to_copy;
4296 ctx->unprocessed_len += bytes_to_copy;
4297
4298 if( ctx->unprocessed_len == block_size )
4299 {
4300 status = mbedtls_to_psa_error(
4301 mbedtls_cipher_update( ctx,
4302 ctx->unprocessed_data,
4303 block_size,
4304 output, &internal_output_length ) );
4305
4306 if( status != PSA_SUCCESS )
4307 goto exit;
4308
4309 output += internal_output_length;
4310 output_size -= internal_output_length;
4311 *output_length += internal_output_length;
4312 ctx->unprocessed_len = 0;
4313 }
4314 }
4315
4316 while( input_length >= block_size )
4317 {
4318 /* Run all full blocks we have, one by one */
4319 status = mbedtls_to_psa_error(
4320 mbedtls_cipher_update( ctx, input,
4321 block_size,
4322 output, &internal_output_length ) );
4323
4324 if( status != PSA_SUCCESS )
4325 goto exit;
4326
4327 input_length -= block_size;
4328 input += block_size;
4329
4330 output += internal_output_length;
4331 output_size -= internal_output_length;
4332 *output_length += internal_output_length;
4333 }
4334
4335 if( input_length > 0 )
4336 {
4337 /* Save unprocessed bytes for later processing */
4338 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4339 input, input_length );
4340 ctx->unprocessed_len += input_length;
4341 }
4342
4343 status = PSA_SUCCESS;
4344
4345exit:
4346 return( status );
4347}
4348
Gilles Peskinee553c652018-06-04 16:22:46 +02004349psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4350 const uint8_t *input,
4351 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004352 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004353 size_t output_size,
4354 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004355{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004356 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004357 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004358 if( operation->alg == 0 )
4359 {
4360 return( PSA_ERROR_BAD_STATE );
4361 }
4362 if( operation->iv_required && ! operation->iv_set )
4363 {
4364 return( PSA_ERROR_BAD_STATE );
4365 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004366
Steven Cooremanef8575e2020-09-11 11:44:50 +02004367 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004368 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004369 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004370 input,
4371 input_length,
4372 output,
4373 output_size,
4374 output_length );
4375 goto exit;
4376 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004377
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004378 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004379 {
4380 /* Take the unprocessed partial block left over from previous
4381 * update calls, if any, plus the input to this call. Remove
4382 * the last partial block, if any. You get the data that will be
4383 * output in this call. */
4384 expected_output_size =
4385 ( operation->ctx.cipher.unprocessed_len + input_length )
4386 / operation->block_size * operation->block_size;
4387 }
4388 else
4389 {
4390 expected_output_size = input_length;
4391 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004392
Gilles Peskine89d789c2018-06-04 17:17:16 +02004393 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004394 {
4395 status = PSA_ERROR_BUFFER_TOO_SMALL;
4396 goto exit;
4397 }
mohammad160382759612018-03-12 18:16:40 +02004398
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004399 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4400 {
4401 /* mbedtls_cipher_update has an API inconsistency: it will only
4402 * process a single block at a time in ECB mode. Abstract away that
4403 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004404 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4405 input,
4406 input_length,
4407 output,
4408 output_size,
4409 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004410 }
4411 else
4412 {
4413 status = mbedtls_to_psa_error(
4414 mbedtls_cipher_update( &operation->ctx.cipher, input,
4415 input_length, output, output_length ) );
4416 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004417exit:
4418 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004419 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004420 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004421}
4422
Gilles Peskinee553c652018-06-04 16:22:46 +02004423psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4424 uint8_t *output,
4425 size_t output_size,
4426 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004427{
David Saadab4ecc272019-02-14 13:48:10 +02004428 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004429 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004430 if( operation->alg == 0 )
4431 {
4432 return( PSA_ERROR_BAD_STATE );
4433 }
4434 if( operation->iv_required && ! operation->iv_set )
4435 {
4436 return( PSA_ERROR_BAD_STATE );
4437 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004438
Steven Cooremanef8575e2020-09-11 11:44:50 +02004439 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004440 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004441 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004442 output,
4443 output_size,
4444 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004445 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004446 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004447
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004448 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004449 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004450 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004451 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004452 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004453 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004454 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004455 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004456 }
4457
Steven Cooremanef8575e2020-09-11 11:44:50 +02004458 status = mbedtls_to_psa_error(
4459 mbedtls_cipher_finish( &operation->ctx.cipher,
4460 temp_output_buffer,
4461 output_length ) );
4462 if( status != PSA_SUCCESS )
4463 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004464
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004465 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004466 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004467 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004468 memcpy( output, temp_output_buffer, *output_length );
4469 else
Janos Follath315b51c2018-07-09 16:04:51 +01004470 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004471
Steven Cooremanef8575e2020-09-11 11:44:50 +02004472exit:
4473 if( operation->mbedtls_in_use == 1 )
4474 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004475
Steven Cooremanef8575e2020-09-11 11:44:50 +02004476 if( status == PSA_SUCCESS )
4477 return( psa_cipher_abort( operation ) );
4478 else
4479 {
4480 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004481 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004482
Steven Cooremanef8575e2020-09-11 11:44:50 +02004483 return( status );
4484 }
mohammad1603503973b2018-03-12 15:59:30 +02004485}
4486
Gilles Peskinee553c652018-06-04 16:22:46 +02004487psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4488{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004489 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004490 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004491 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004492 * in use. It's ok to call abort on such an object, and there's
4493 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004494 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004495 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004496
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004497 /* Sanity check (shouldn't happen: operation->alg should
4498 * always have been initialized to a valid value). */
4499 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4500 return( PSA_ERROR_BAD_STATE );
4501
Steven Cooremanef8575e2020-09-11 11:44:50 +02004502 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004503 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004504 else
4505 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004506
Moran Peker41deec42018-04-04 15:43:05 +03004507 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004508 operation->key_set = 0;
4509 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004510 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004511 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004512 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004513 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004514
Moran Peker395db872018-05-31 14:07:14 +03004515 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004516}
4517
Gilles Peskinea0655c32018-04-30 17:06:50 +02004518
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004519
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004520
mohammad16035955c982018-04-26 00:53:03 +03004521/****************************************************************/
4522/* AEAD */
4523/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004524
Gilles Peskineedf9a652018-08-17 18:11:56 +02004525typedef struct
4526{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004527 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004528 const mbedtls_cipher_info_t *cipher_info;
4529 union
4530 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004531 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004532#if defined(MBEDTLS_CCM_C)
4533 mbedtls_ccm_context ccm;
4534#endif /* MBEDTLS_CCM_C */
4535#if defined(MBEDTLS_GCM_C)
4536 mbedtls_gcm_context gcm;
4537#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004538#if defined(MBEDTLS_CHACHAPOLY_C)
4539 mbedtls_chachapoly_context chachapoly;
4540#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004541 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004542 psa_algorithm_t core_alg;
4543 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004544 uint8_t tag_length;
4545} aead_operation_t;
4546
Ronald Cronf95a2b12020-10-22 15:24:49 +02004547#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4548
Gilles Peskine30a9e412019-01-14 18:36:12 +01004549static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004550{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004551 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004552 {
4553#if defined(MBEDTLS_CCM_C)
4554 case PSA_ALG_CCM:
4555 mbedtls_ccm_free( &operation->ctx.ccm );
4556 break;
4557#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004558#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004559 case PSA_ALG_GCM:
4560 mbedtls_gcm_free( &operation->ctx.gcm );
4561 break;
4562#endif /* MBEDTLS_GCM_C */
4563 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004564
Ronald Cron5c522922020-11-14 16:35:34 +01004565 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004566}
4567
4568static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004569 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004570 psa_key_usage_t usage,
4571 psa_algorithm_t alg )
4572{
4573 psa_status_t status;
4574 size_t key_bits;
4575 mbedtls_cipher_id_t cipher_id;
4576
Ronald Cron5c522922020-11-14 16:35:34 +01004577 status = psa_get_and_lock_transparent_key_slot_with_policy(
4578 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004579 if( status != PSA_SUCCESS )
4580 return( status );
4581
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004582 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004583
4584 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004585 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004586 &cipher_id );
4587 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004588 {
4589 status = PSA_ERROR_NOT_SUPPORTED;
4590 goto cleanup;
4591 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004592
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004593 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004594 {
4595#if defined(MBEDTLS_CCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004596 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004597 operation->core_alg = PSA_ALG_CCM;
4598 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004599 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4600 * The call to mbedtls_ccm_encrypt_and_tag or
4601 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004602 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004603 {
4604 status = PSA_ERROR_INVALID_ARGUMENT;
4605 goto cleanup;
4606 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004607 mbedtls_ccm_init( &operation->ctx.ccm );
4608 status = mbedtls_to_psa_error(
4609 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004610 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004611 (unsigned int) key_bits ) );
4612 if( status != 0 )
4613 goto cleanup;
4614 break;
4615#endif /* MBEDTLS_CCM_C */
4616
4617#if defined(MBEDTLS_GCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004618 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004619 operation->core_alg = PSA_ALG_GCM;
4620 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004621 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4622 * The call to mbedtls_gcm_crypt_and_tag or
4623 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004624 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004625 {
4626 status = PSA_ERROR_INVALID_ARGUMENT;
4627 goto cleanup;
4628 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004629 mbedtls_gcm_init( &operation->ctx.gcm );
4630 status = mbedtls_to_psa_error(
4631 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004632 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004633 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004634 if( status != 0 )
4635 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004636 break;
4637#endif /* MBEDTLS_GCM_C */
4638
Gilles Peskine26869f22019-05-06 15:25:00 +02004639#if defined(MBEDTLS_CHACHAPOLY_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004640 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02004641 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4642 operation->full_tag_length = 16;
4643 /* We only support the default tag length. */
4644 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004645 {
4646 status = PSA_ERROR_NOT_SUPPORTED;
4647 goto cleanup;
4648 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004649 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4650 status = mbedtls_to_psa_error(
4651 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004652 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004653 if( status != 0 )
4654 goto cleanup;
4655 break;
4656#endif /* MBEDTLS_CHACHAPOLY_C */
4657
Gilles Peskineedf9a652018-08-17 18:11:56 +02004658 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004659 status = PSA_ERROR_NOT_SUPPORTED;
4660 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004661 }
4662
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004663 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4664 {
4665 status = PSA_ERROR_INVALID_ARGUMENT;
4666 goto cleanup;
4667 }
4668 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004669
Gilles Peskineedf9a652018-08-17 18:11:56 +02004670 return( PSA_SUCCESS );
4671
4672cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004673 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004674 return( status );
4675}
4676
Ronald Croncf56a0a2020-08-04 09:51:30 +02004677psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004678 psa_algorithm_t alg,
4679 const uint8_t *nonce,
4680 size_t nonce_length,
4681 const uint8_t *additional_data,
4682 size_t additional_data_length,
4683 const uint8_t *plaintext,
4684 size_t plaintext_length,
4685 uint8_t *ciphertext,
4686 size_t ciphertext_size,
4687 size_t *ciphertext_length )
4688{
mohammad16035955c982018-04-26 00:53:03 +03004689 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004690 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004691 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004692
mohammad1603f08a5502018-06-03 15:05:47 +03004693 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004694
Ronald Croncf56a0a2020-08-04 09:51:30 +02004695 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004696 if( status != PSA_SUCCESS )
4697 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004698
Gilles Peskineedf9a652018-08-17 18:11:56 +02004699 /* For all currently supported modes, the tag is at the end of the
4700 * ciphertext. */
4701 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4702 {
4703 status = PSA_ERROR_BUFFER_TOO_SMALL;
4704 goto exit;
4705 }
4706 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004707
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004708#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004709 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004710 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004711 status = mbedtls_to_psa_error(
4712 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4713 MBEDTLS_GCM_ENCRYPT,
4714 plaintext_length,
4715 nonce, nonce_length,
4716 additional_data, additional_data_length,
4717 plaintext, ciphertext,
4718 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004719 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004720 else
4721#endif /* MBEDTLS_GCM_C */
4722#if defined(MBEDTLS_CCM_C)
4723 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004724 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004725 status = mbedtls_to_psa_error(
4726 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4727 plaintext_length,
4728 nonce, nonce_length,
4729 additional_data,
4730 additional_data_length,
4731 plaintext, ciphertext,
4732 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004733 }
mohammad16035c8845f2018-05-09 05:40:09 -07004734 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004735#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004736#if defined(MBEDTLS_CHACHAPOLY_C)
4737 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4738 {
4739 if( nonce_length != 12 || operation.tag_length != 16 )
4740 {
4741 status = PSA_ERROR_NOT_SUPPORTED;
4742 goto exit;
4743 }
4744 status = mbedtls_to_psa_error(
4745 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4746 plaintext_length,
4747 nonce,
4748 additional_data,
4749 additional_data_length,
4750 plaintext,
4751 ciphertext,
4752 tag ) );
4753 }
4754 else
4755#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004756 {
Steven Cooreman7196fef2021-02-10 17:13:28 +01004757 (void) tag;
mohammad1603554faad2018-06-03 15:07:38 +03004758 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004759 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004760
Gilles Peskineedf9a652018-08-17 18:11:56 +02004761 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4762 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004763
Gilles Peskineedf9a652018-08-17 18:11:56 +02004764exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004765 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004766 if( status == PSA_SUCCESS )
4767 *ciphertext_length = plaintext_length + operation.tag_length;
4768 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004769}
4770
Gilles Peskineee652a32018-06-01 19:23:52 +02004771/* Locate the tag in a ciphertext buffer containing the encrypted data
4772 * followed by the tag. Return the length of the part preceding the tag in
4773 * *plaintext_length. This is the size of the plaintext in modes where
4774 * the encrypted data has the same size as the plaintext, such as
4775 * CCM and GCM. */
4776static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4777 const uint8_t *ciphertext,
4778 size_t ciphertext_length,
4779 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004780 const uint8_t **p_tag )
4781{
4782 size_t payload_length;
4783 if( tag_length > ciphertext_length )
4784 return( PSA_ERROR_INVALID_ARGUMENT );
4785 payload_length = ciphertext_length - tag_length;
4786 if( payload_length > plaintext_size )
4787 return( PSA_ERROR_BUFFER_TOO_SMALL );
4788 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004789 return( PSA_SUCCESS );
4790}
4791
Ronald Croncf56a0a2020-08-04 09:51:30 +02004792psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004793 psa_algorithm_t alg,
4794 const uint8_t *nonce,
4795 size_t nonce_length,
4796 const uint8_t *additional_data,
4797 size_t additional_data_length,
4798 const uint8_t *ciphertext,
4799 size_t ciphertext_length,
4800 uint8_t *plaintext,
4801 size_t plaintext_size,
4802 size_t *plaintext_length )
4803{
mohammad16035955c982018-04-26 00:53:03 +03004804 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004805 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004806 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004807
Gilles Peskineee652a32018-06-01 19:23:52 +02004808 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004809
Ronald Croncf56a0a2020-08-04 09:51:30 +02004810 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004811 if( status != PSA_SUCCESS )
4812 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004813
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004814 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4815 ciphertext, ciphertext_length,
4816 plaintext_size, &tag );
4817 if( status != PSA_SUCCESS )
4818 goto exit;
4819
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004820#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004821 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004822 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004823 status = mbedtls_to_psa_error(
4824 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4825 ciphertext_length - operation.tag_length,
4826 nonce, nonce_length,
4827 additional_data,
4828 additional_data_length,
4829 tag, operation.tag_length,
4830 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004831 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004832 else
4833#endif /* MBEDTLS_GCM_C */
4834#if defined(MBEDTLS_CCM_C)
4835 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004836 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004837 status = mbedtls_to_psa_error(
4838 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4839 ciphertext_length - operation.tag_length,
4840 nonce, nonce_length,
4841 additional_data,
4842 additional_data_length,
4843 ciphertext, plaintext,
4844 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004845 }
mohammad160339574652018-06-01 04:39:53 -07004846 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004847#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004848#if defined(MBEDTLS_CHACHAPOLY_C)
4849 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4850 {
4851 if( nonce_length != 12 || operation.tag_length != 16 )
4852 {
4853 status = PSA_ERROR_NOT_SUPPORTED;
4854 goto exit;
4855 }
4856 status = mbedtls_to_psa_error(
4857 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4858 ciphertext_length - operation.tag_length,
4859 nonce,
4860 additional_data,
4861 additional_data_length,
4862 tag,
4863 ciphertext,
4864 plaintext ) );
4865 }
4866 else
4867#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004868 {
mohammad1603554faad2018-06-03 15:07:38 +03004869 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004870 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004871
Gilles Peskineedf9a652018-08-17 18:11:56 +02004872 if( status != PSA_SUCCESS && plaintext_size != 0 )
4873 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004874
Gilles Peskineedf9a652018-08-17 18:11:56 +02004875exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004876 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004877 if( status == PSA_SUCCESS )
4878 *plaintext_length = ciphertext_length - operation.tag_length;
4879 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004880}
4881
Gilles Peskinea0655c32018-04-30 17:06:50 +02004882
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004883
Gilles Peskine20035e32018-02-03 22:44:14 +01004884/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004885/* Generators */
4886/****************************************************************/
4887
John Durkop07cc04a2020-11-16 22:08:34 -08004888#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4889 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4890 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4891#define AT_LEAST_ONE_BUILTIN_KDF
4892#endif
4893
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004894#define HKDF_STATE_INIT 0 /* no input yet */
4895#define HKDF_STATE_STARTED 1 /* got salt */
4896#define HKDF_STATE_KEYED 2 /* got key */
4897#define HKDF_STATE_OUTPUT 3 /* output started */
4898
Gilles Peskinecbe66502019-05-16 16:59:18 +02004899static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004900 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004901{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004902 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4903 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004904 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004905 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004906}
4907
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004908psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004909{
4910 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004911 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004912 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004913 {
4914 /* The object has (apparently) been initialized but it is not
4915 * in use. It's ok to call abort on such an object, and there's
4916 * nothing to do. */
4917 }
4918 else
John Durkopd0321952020-10-29 21:37:36 -07004919#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004920 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004921 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004922 mbedtls_free( operation->ctx.hkdf.info );
4923 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004924 }
John Durkop07cc04a2020-11-16 22:08:34 -08004925 else
4926#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4927#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4928 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4929 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004930 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004931 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004932 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004933 if( operation->ctx.tls12_prf.seed != NULL )
4934 {
4935 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4936 operation->ctx.tls12_prf.seed_length );
4937 mbedtls_free( operation->ctx.tls12_prf.seed );
4938 }
4939
4940 if( operation->ctx.tls12_prf.label != NULL )
4941 {
4942 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4943 operation->ctx.tls12_prf.label_length );
4944 mbedtls_free( operation->ctx.tls12_prf.label );
4945 }
4946
4947 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4948
4949 /* We leave the fields Ai and output_block to be erased safely by the
4950 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004951 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004952 else
John Durkop07cc04a2020-11-16 22:08:34 -08004953#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4954 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004955 {
4956 status = PSA_ERROR_BAD_STATE;
4957 }
Janos Follath083036a2019-06-11 10:22:26 +01004958 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004959 return( status );
4960}
4961
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004962psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004963 size_t *capacity)
4964{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004965 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004966 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004967 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004968 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004969 }
4970
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004971 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004972 return( PSA_SUCCESS );
4973}
4974
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004975psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004976 size_t capacity )
4977{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004978 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004979 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004980 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004981 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004982 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004983 return( PSA_SUCCESS );
4984}
4985
John Durkopd0321952020-10-29 21:37:36 -07004986#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004987/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004988 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004989static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004990 psa_algorithm_t hash_alg,
4991 uint8_t *output,
4992 size_t output_length )
4993{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004994 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004995 psa_status_t status;
4996
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004997 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4998 return( PSA_ERROR_BAD_STATE );
4999 hkdf->state = HKDF_STATE_OUTPUT;
5000
Gilles Peskinebef7f142018-07-12 17:22:21 +02005001 while( output_length != 0 )
5002 {
5003 /* Copy what remains of the current block */
5004 uint8_t n = hash_length - hkdf->offset_in_block;
5005 if( n > output_length )
5006 n = (uint8_t) output_length;
5007 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5008 output += n;
5009 output_length -= n;
5010 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005011 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005012 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005013 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005014 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005015 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005016 * object was corrupted or if this function is called directly
5017 * inside the library. */
5018 if( hkdf->block_number == 0xff )
5019 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005020
5021 /* We need a new block */
5022 ++hkdf->block_number;
5023 hkdf->offset_in_block = 0;
5024 status = psa_hmac_setup_internal( &hkdf->hmac,
5025 hkdf->prk, hash_length,
5026 hash_alg );
5027 if( status != PSA_SUCCESS )
5028 return( status );
5029 if( hkdf->block_number != 1 )
5030 {
5031 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5032 hkdf->output_block,
5033 hash_length );
5034 if( status != PSA_SUCCESS )
5035 return( status );
5036 }
5037 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5038 hkdf->info,
5039 hkdf->info_length );
5040 if( status != PSA_SUCCESS )
5041 return( status );
5042 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5043 &hkdf->block_number, 1 );
5044 if( status != PSA_SUCCESS )
5045 return( status );
5046 status = psa_hmac_finish_internal( &hkdf->hmac,
5047 hkdf->output_block,
5048 sizeof( hkdf->output_block ) );
5049 if( status != PSA_SUCCESS )
5050 return( status );
5051 }
5052
5053 return( PSA_SUCCESS );
5054}
John Durkop07cc04a2020-11-16 22:08:34 -08005055#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005056
John Durkop07cc04a2020-11-16 22:08:34 -08005057#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5058 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005059static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5060 psa_tls12_prf_key_derivation_t *tls12_prf,
5061 psa_algorithm_t alg )
5062{
5063 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005064 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005065 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5066 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005067
Janos Follath7742fee2019-06-17 12:58:10 +01005068 /* We can't be wanting more output after block 0xff, otherwise
5069 * the capacity check in psa_key_derivation_output_bytes() would have
5070 * prevented this call. It could happen only if the operation
5071 * object was corrupted or if this function is called directly
5072 * inside the library. */
5073 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005074 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005075
5076 /* We need a new block */
5077 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005078 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005079
5080 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5081 *
5082 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5083 *
5084 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5085 * HMAC_hash(secret, A(2) + seed) +
5086 * HMAC_hash(secret, A(3) + seed) + ...
5087 *
5088 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005089 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005090 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005091 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005092 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005093 * is currently extracted as `output_block` and where i is
5094 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005095 */
5096
Janos Follathea29bfb2019-06-19 12:21:20 +01005097 /* Save the hash context before using it, to preserve the hash state with
5098 * only the inner padding in it. We need this, because inner padding depends
5099 * on the key (secret in the RFC's terminology). */
5100 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5101 if( status != PSA_SUCCESS )
5102 goto cleanup;
5103
5104 /* Calculate A(i) where i = tls12_prf->block_number. */
5105 if( tls12_prf->block_number == 1 )
5106 {
5107 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5108 * the variable seed and in this instance means it in the context of the
5109 * P_hash function, where seed = label + seed.) */
5110 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5111 tls12_prf->label, tls12_prf->label_length );
5112 if( status != PSA_SUCCESS )
5113 goto cleanup;
5114 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5115 tls12_prf->seed, tls12_prf->seed_length );
5116 if( status != PSA_SUCCESS )
5117 goto cleanup;
5118 }
5119 else
5120 {
5121 /* A(i) = HMAC_hash(secret, A(i-1)) */
5122 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5123 tls12_prf->Ai, hash_length );
5124 if( status != PSA_SUCCESS )
5125 goto cleanup;
5126 }
5127
5128 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5129 tls12_prf->Ai, hash_length );
5130 if( status != PSA_SUCCESS )
5131 goto cleanup;
5132 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5133 if( status != PSA_SUCCESS )
5134 goto cleanup;
5135
5136 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5137 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5138 tls12_prf->Ai, hash_length );
5139 if( status != PSA_SUCCESS )
5140 goto cleanup;
5141 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5142 tls12_prf->label, tls12_prf->label_length );
5143 if( status != PSA_SUCCESS )
5144 goto cleanup;
5145 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5146 tls12_prf->seed, tls12_prf->seed_length );
5147 if( status != PSA_SUCCESS )
5148 goto cleanup;
5149 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5150 tls12_prf->output_block, hash_length );
5151 if( status != PSA_SUCCESS )
5152 goto cleanup;
5153 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5154 if( status != PSA_SUCCESS )
5155 goto cleanup;
5156
Janos Follath7742fee2019-06-17 12:58:10 +01005157
5158cleanup:
5159
Janos Follathea29bfb2019-06-19 12:21:20 +01005160 cleanup_status = psa_hash_abort( &backup );
5161 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5162 status = cleanup_status;
5163
5164 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005165}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005166
Janos Follath844eb0e2019-06-19 12:10:49 +01005167static psa_status_t psa_key_derivation_tls12_prf_read(
5168 psa_tls12_prf_key_derivation_t *tls12_prf,
5169 psa_algorithm_t alg,
5170 uint8_t *output,
5171 size_t output_length )
5172{
5173 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005174 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005175 psa_status_t status;
5176 uint8_t offset, length;
5177
5178 while( output_length != 0 )
5179 {
5180 /* Check if we have fully processed the current block. */
5181 if( tls12_prf->left_in_block == 0 )
5182 {
5183 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5184 alg );
5185 if( status != PSA_SUCCESS )
5186 return( status );
5187
5188 continue;
5189 }
5190
5191 if( tls12_prf->left_in_block > output_length )
5192 length = (uint8_t) output_length;
5193 else
5194 length = tls12_prf->left_in_block;
5195
5196 offset = hash_length - tls12_prf->left_in_block;
5197 memcpy( output, tls12_prf->output_block + offset, length );
5198 output += length;
5199 output_length -= length;
5200 tls12_prf->left_in_block -= length;
5201 }
5202
5203 return( PSA_SUCCESS );
5204}
John Durkop07cc04a2020-11-16 22:08:34 -08005205#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5206 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005207
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005208psa_status_t psa_key_derivation_output_bytes(
5209 psa_key_derivation_operation_t *operation,
5210 uint8_t *output,
5211 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005212{
5213 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005214 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005215
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005216 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005217 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005219 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005220 }
5221
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005222 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005223 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005224 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005225 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005226 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005227 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005228 goto exit;
5229 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005230 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005231 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005232 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005233 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005234 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5235 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005236 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005237 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005238 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005239 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005240 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005241
John Durkopd0321952020-10-29 21:37:36 -07005242#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005243 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005244 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005245 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005246 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005247 output, output_length );
5248 }
Janos Follathadbec812019-06-14 11:05:39 +01005249 else
John Durkop07cc04a2020-11-16 22:08:34 -08005250#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5251#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5252 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005253 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005254 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005255 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005256 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005257 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005258 output_length );
5259 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005260 else
John Durkop07cc04a2020-11-16 22:08:34 -08005261#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5262 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005263 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005264 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005265 return( PSA_ERROR_BAD_STATE );
5266 }
5267
5268exit:
5269 if( status != PSA_SUCCESS )
5270 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005271 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005272 * This allows us to differentiate between exhausted operations and
5273 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5274 * operations. */
5275 psa_algorithm_t alg = operation->alg;
5276 psa_key_derivation_abort( operation );
5277 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005278 memset( output, '!', output_length );
5279 }
5280 return( status );
5281}
5282
David Brown7807bf72021-02-09 16:28:23 -07005283#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02005284static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5285{
5286 if( data_size >= 8 )
5287 mbedtls_des_key_set_parity( data );
5288 if( data_size >= 16 )
5289 mbedtls_des_key_set_parity( data + 8 );
5290 if( data_size >= 24 )
5291 mbedtls_des_key_set_parity( data + 16 );
5292}
David Brown7807bf72021-02-09 16:28:23 -07005293#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005294
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005295static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005296 psa_key_slot_t *slot,
5297 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005298 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005299{
5300 uint8_t *data = NULL;
5301 size_t bytes = PSA_BITS_TO_BYTES( bits );
5302 psa_status_t status;
5303
Gilles Peskine8e338702019-07-30 20:06:31 +02005304 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005305 return( PSA_ERROR_INVALID_ARGUMENT );
5306 if( bits % 8 != 0 )
5307 return( PSA_ERROR_INVALID_ARGUMENT );
5308 data = mbedtls_calloc( 1, bytes );
5309 if( data == NULL )
5310 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5311
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005312 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005313 if( status != PSA_SUCCESS )
5314 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07005315#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02005316 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005317 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07005318#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01005319
5320 status = psa_allocate_buffer_to_slot( slot, bytes );
5321 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00005322 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01005323
Ronald Cronbf33c932020-11-28 18:06:53 +01005324 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005325 psa_key_attributes_t attributes = {
5326 .core = slot->attr
5327 };
5328
Ronald Cronbf33c932020-11-28 18:06:53 +01005329 status = psa_driver_wrapper_import_key( &attributes,
5330 data, bytes,
5331 slot->key.data,
5332 slot->key.bytes,
5333 &slot->key.bytes, &bits );
5334 if( bits != slot->attr.bits )
5335 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005336
5337exit:
5338 mbedtls_free( data );
5339 return( status );
5340}
5341
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005342psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005343 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005344 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005345{
5346 psa_status_t status;
5347 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005348 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005349
Ronald Cron81709fc2020-11-14 12:10:32 +01005350 *key = MBEDTLS_SVC_KEY_ID_INIT;
5351
Gilles Peskine0f84d622019-09-12 19:03:13 +02005352 /* Reject any attempt to create a zero-length key so that we don't
5353 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5354 if( psa_get_key_bits( attributes ) == 0 )
5355 return( PSA_ERROR_INVALID_ARGUMENT );
5356
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005357 if( ! operation->can_output_key )
5358 return( PSA_ERROR_NOT_PERMITTED );
5359
Ronald Cron81709fc2020-11-14 12:10:32 +01005360 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5361 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005362#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5363 if( driver != NULL )
5364 {
5365 /* Deriving a key in a secure element is not implemented yet. */
5366 status = PSA_ERROR_NOT_SUPPORTED;
5367 }
5368#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005369 if( status == PSA_SUCCESS )
5370 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005371 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005372 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005373 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005374 }
5375 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005376 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005377 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005378 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005379
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005380 return( status );
5381}
5382
Gilles Peskineeab56e42018-07-12 17:12:33 +02005383
5384
5385/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005386/* Key derivation */
5387/****************************************************************/
5388
Steven Cooreman932ffb72021-02-15 12:14:32 +01005389#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005390static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005391 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005392 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005393{
John Durkop07cc04a2020-11-16 22:08:34 -08005394 int is_kdf_alg_supported;
5395
Janos Follath5fe19732019-06-20 15:09:30 +01005396 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5397 * initialisers for this union leave some bytes unspecified.) */
5398 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5399
Gilles Peskine969c5d62019-01-16 15:53:06 +01005400 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005401#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005402 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5403 is_kdf_alg_supported = 1;
5404 else
5405#endif
5406#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5407 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5408 is_kdf_alg_supported = 1;
5409 else
5410#endif
5411#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5412 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5413 is_kdf_alg_supported = 1;
5414 else
5415#endif
5416 is_kdf_alg_supported = 0;
5417
5418 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005419 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005420 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005421 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005422 if( hash_size == 0 )
5423 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005424 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5425 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005426 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005427 {
5428 return( PSA_ERROR_NOT_SUPPORTED );
5429 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005430 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005431 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005432 }
John Durkop07cc04a2020-11-16 22:08:34 -08005433
5434 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005435}
John Durkop07cc04a2020-11-16 22:08:34 -08005436#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005437
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005438psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005439 psa_algorithm_t alg )
5440{
5441 psa_status_t status;
5442
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005443 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005444 return( PSA_ERROR_BAD_STATE );
5445
Gilles Peskine6843c292019-01-18 16:44:49 +01005446 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5447 return( PSA_ERROR_INVALID_ARGUMENT );
5448 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005449 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005450#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005451 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005452 status = psa_key_derivation_setup_kdf( operation, kdf_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 }
5457 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5458 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005459#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005460 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005461#else
5462 return( PSA_ERROR_NOT_SUPPORTED );
5463#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005464 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005465 else
5466 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005467
5468 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005469 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005470 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005471}
5472
John Durkopd0321952020-10-29 21:37:36 -07005473#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005474static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005475 psa_algorithm_t hash_alg,
5476 psa_key_derivation_step_t step,
5477 const uint8_t *data,
5478 size_t data_length )
5479{
5480 psa_status_t status;
5481 switch( step )
5482 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005483 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005484 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005485 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005486 status = psa_hmac_setup_internal( &hkdf->hmac,
5487 data, data_length,
5488 hash_alg );
5489 if( status != PSA_SUCCESS )
5490 return( status );
5491 hkdf->state = HKDF_STATE_STARTED;
5492 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005493 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005494 /* If no salt was provided, use an empty salt. */
5495 if( hkdf->state == HKDF_STATE_INIT )
5496 {
5497 status = psa_hmac_setup_internal( &hkdf->hmac,
5498 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005499 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005500 if( status != PSA_SUCCESS )
5501 return( status );
5502 hkdf->state = HKDF_STATE_STARTED;
5503 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005504 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005505 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005506 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5507 data, data_length );
5508 if( status != PSA_SUCCESS )
5509 return( status );
5510 status = psa_hmac_finish_internal( &hkdf->hmac,
5511 hkdf->prk,
5512 sizeof( hkdf->prk ) );
5513 if( status != PSA_SUCCESS )
5514 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005515 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005516 hkdf->block_number = 0;
5517 hkdf->state = HKDF_STATE_KEYED;
5518 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005519 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005520 if( hkdf->state == HKDF_STATE_OUTPUT )
5521 return( PSA_ERROR_BAD_STATE );
5522 if( hkdf->info_set )
5523 return( PSA_ERROR_BAD_STATE );
5524 hkdf->info_length = data_length;
5525 if( data_length != 0 )
5526 {
5527 hkdf->info = mbedtls_calloc( 1, data_length );
5528 if( hkdf->info == NULL )
5529 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5530 memcpy( hkdf->info, data, data_length );
5531 }
5532 hkdf->info_set = 1;
5533 return( PSA_SUCCESS );
5534 default:
5535 return( PSA_ERROR_INVALID_ARGUMENT );
5536 }
5537}
John Durkop07cc04a2020-11-16 22:08:34 -08005538#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005539
John Durkop07cc04a2020-11-16 22:08:34 -08005540#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5541 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005542static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5543 const uint8_t *data,
5544 size_t data_length )
5545{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005546 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005547 return( PSA_ERROR_BAD_STATE );
5548
Janos Follathd6dce9f2019-07-04 09:11:38 +01005549 if( data_length != 0 )
5550 {
5551 prf->seed = mbedtls_calloc( 1, data_length );
5552 if( prf->seed == NULL )
5553 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005554
Janos Follathd6dce9f2019-07-04 09:11:38 +01005555 memcpy( prf->seed, data, data_length );
5556 prf->seed_length = data_length;
5557 }
Janos Follathf08e2652019-06-13 09:05:41 +01005558
Gilles Peskine43f958b2020-12-13 14:55:14 +01005559 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005560
5561 return( PSA_SUCCESS );
5562}
5563
Janos Follath81550542019-06-13 14:26:34 +01005564static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5565 psa_algorithm_t hash_alg,
5566 const uint8_t *data,
5567 size_t data_length )
5568{
5569 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01005570 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01005571 return( PSA_ERROR_BAD_STATE );
5572
5573 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5574 if( status != PSA_SUCCESS )
5575 return( status );
5576
Gilles Peskine43f958b2020-12-13 14:55:14 +01005577 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005578
5579 return( PSA_SUCCESS );
5580}
5581
Janos Follath63028dd2019-06-13 09:15:47 +01005582static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5583 const uint8_t *data,
5584 size_t data_length )
5585{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005586 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005587 return( PSA_ERROR_BAD_STATE );
5588
Janos Follathd6dce9f2019-07-04 09:11:38 +01005589 if( data_length != 0 )
5590 {
5591 prf->label = mbedtls_calloc( 1, data_length );
5592 if( prf->label == NULL )
5593 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005594
Janos Follathd6dce9f2019-07-04 09:11:38 +01005595 memcpy( prf->label, data, data_length );
5596 prf->label_length = data_length;
5597 }
Janos Follath63028dd2019-06-13 09:15:47 +01005598
Gilles Peskine43f958b2020-12-13 14:55:14 +01005599 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005600
5601 return( PSA_SUCCESS );
5602}
5603
Janos Follathb03233e2019-06-11 15:30:30 +01005604static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5605 psa_algorithm_t hash_alg,
5606 psa_key_derivation_step_t step,
5607 const uint8_t *data,
5608 size_t data_length )
5609{
Janos Follathb03233e2019-06-11 15:30:30 +01005610 switch( step )
5611 {
Janos Follathf08e2652019-06-13 09:05:41 +01005612 case PSA_KEY_DERIVATION_INPUT_SEED:
5613 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005614 case PSA_KEY_DERIVATION_INPUT_SECRET:
5615 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005616 case PSA_KEY_DERIVATION_INPUT_LABEL:
5617 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005618 default:
5619 return( PSA_ERROR_INVALID_ARGUMENT );
5620 }
5621}
John Durkop07cc04a2020-11-16 22:08:34 -08005622#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5623 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5624
5625#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5626static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5627 psa_tls12_prf_key_derivation_t *prf,
5628 psa_algorithm_t hash_alg,
5629 const uint8_t *data,
5630 size_t data_length )
5631{
5632 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005633 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005634 uint8_t *cur = pms;
5635
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005636 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005637 return( PSA_ERROR_INVALID_ARGUMENT );
5638
5639 /* Quoting RFC 4279, Section 2:
5640 *
5641 * The premaster secret is formed as follows: if the PSK is N octets
5642 * long, concatenate a uint16 with the value N, N zero octets, a second
5643 * uint16 with the value N, and the PSK itself.
5644 */
5645
5646 *cur++ = ( data_length >> 8 ) & 0xff;
5647 *cur++ = ( data_length >> 0 ) & 0xff;
5648 memset( cur, 0, data_length );
5649 cur += data_length;
5650 *cur++ = pms[0];
5651 *cur++ = pms[1];
5652 memcpy( cur, data, data_length );
5653 cur += data_length;
5654
5655 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5656
5657 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5658 return( status );
5659}
Janos Follath6660f0e2019-06-17 08:44:03 +01005660
5661static psa_status_t psa_tls12_prf_psk_to_ms_input(
5662 psa_tls12_prf_key_derivation_t *prf,
5663 psa_algorithm_t hash_alg,
5664 psa_key_derivation_step_t step,
5665 const uint8_t *data,
5666 size_t data_length )
5667{
5668 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005669 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005670 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5671 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005672 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005673
5674 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5675}
John Durkop07cc04a2020-11-16 22:08:34 -08005676#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005677
Gilles Peskineb8965192019-09-24 16:21:10 +02005678/** Check whether the given key type is acceptable for the given
5679 * input step of a key derivation.
5680 *
5681 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5682 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5683 * Both secret and non-secret inputs can alternatively have the type
5684 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5685 * that the input was passed as a buffer rather than via a key object.
5686 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005687static int psa_key_derivation_check_input_type(
5688 psa_key_derivation_step_t step,
5689 psa_key_type_t key_type )
5690{
5691 switch( step )
5692 {
5693 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005694 if( key_type == PSA_KEY_TYPE_DERIVE )
5695 return( PSA_SUCCESS );
5696 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005697 return( PSA_SUCCESS );
5698 break;
5699 case PSA_KEY_DERIVATION_INPUT_LABEL:
5700 case PSA_KEY_DERIVATION_INPUT_SALT:
5701 case PSA_KEY_DERIVATION_INPUT_INFO:
5702 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005703 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5704 return( PSA_SUCCESS );
5705 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005706 return( PSA_SUCCESS );
5707 break;
5708 }
5709 return( PSA_ERROR_INVALID_ARGUMENT );
5710}
5711
Janos Follathb80a94e2019-06-12 15:54:46 +01005712static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005713 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005714 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005715 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005716 const uint8_t *data,
5717 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005718{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005719 psa_status_t status;
5720 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5721
5722 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005723 if( status != PSA_SUCCESS )
5724 goto exit;
5725
John Durkopd0321952020-10-29 21:37:36 -07005726#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005727 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005728 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005729 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005730 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005731 step, data, data_length );
5732 }
John Durkop07cc04a2020-11-16 22:08:34 -08005733 else
5734#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5735#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5736 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005737 {
Janos Follathb03233e2019-06-11 15:30:30 +01005738 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5739 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5740 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005741 }
John Durkop07cc04a2020-11-16 22:08:34 -08005742 else
5743#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5744#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5745 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005746 {
5747 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5748 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5749 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005750 }
5751 else
John Durkop07cc04a2020-11-16 22:08:34 -08005752#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005753 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005754 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005755 (void) data;
5756 (void) data_length;
5757 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005758 return( PSA_ERROR_BAD_STATE );
5759 }
5760
Gilles Peskine224b0d62019-09-23 18:13:17 +02005761exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005762 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005763 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005764 return( status );
5765}
5766
Janos Follath51f4a0f2019-06-14 11:35:55 +01005767psa_status_t psa_key_derivation_input_bytes(
5768 psa_key_derivation_operation_t *operation,
5769 psa_key_derivation_step_t step,
5770 const uint8_t *data,
5771 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005772{
Gilles Peskineb8965192019-09-24 16:21:10 +02005773 return( psa_key_derivation_input_internal( operation, step,
5774 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005775 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005776}
5777
Janos Follath51f4a0f2019-06-14 11:35:55 +01005778psa_status_t psa_key_derivation_input_key(
5779 psa_key_derivation_operation_t *operation,
5780 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005781 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005782{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005783 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005784 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005785 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005786
Ronald Cron5c522922020-11-14 16:35:34 +01005787 status = psa_get_and_lock_transparent_key_slot_with_policy(
5788 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005789 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005790 {
5791 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005792 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005793 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005794
5795 /* Passing a key object as a SECRET input unlocks the permission
5796 * to output to a key object. */
5797 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5798 operation->can_output_key = 1;
5799
Ronald Cronf95a2b12020-10-22 15:24:49 +02005800 status = psa_key_derivation_input_internal( operation,
5801 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005802 slot->key.data,
5803 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005804
Ronald Cron5c522922020-11-14 16:35:34 +01005805 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005806
Ronald Cron5c522922020-11-14 16:35:34 +01005807 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005808}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005809
5810
5811
5812/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005813/* Key agreement */
5814/****************************************************************/
5815
John Durkop6ba40d12020-11-10 08:50:04 -08005816#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005817static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5818 size_t peer_key_length,
5819 const mbedtls_ecp_keypair *our_key,
5820 uint8_t *shared_secret,
5821 size_t shared_secret_size,
5822 size_t *shared_secret_length )
5823{
Steven Cooremand4867872020-08-05 16:31:39 +02005824 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005825 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005826 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005827 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005828 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005829 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005830
Ronald Cron90857082020-11-25 14:58:33 +01005831 status = mbedtls_psa_ecp_load_representation(
5832 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005833 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005834 peer_key,
5835 peer_key_length,
5836 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005837 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005838 goto exit;
5839
Jaeden Amero97271b32019-01-10 19:38:51 +00005840 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005841 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005842 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005843 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005844 status = mbedtls_to_psa_error(
5845 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5846 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005847 goto exit;
5848
Jaeden Amero97271b32019-01-10 19:38:51 +00005849 status = mbedtls_to_psa_error(
5850 mbedtls_ecdh_calc_secret( &ecdh,
5851 shared_secret_length,
5852 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005853 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005854 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005855 if( status != PSA_SUCCESS )
5856 goto exit;
5857 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5858 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005859
5860exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005861 if( status != PSA_SUCCESS )
5862 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005863 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005864 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005865 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005866
Jaeden Amero97271b32019-01-10 19:38:51 +00005867 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005868}
John Durkop6ba40d12020-11-10 08:50:04 -08005869#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005870
Gilles Peskine01d718c2018-09-18 12:01:02 +02005871#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5872
Gilles Peskine0216fe12019-04-11 21:23:21 +02005873static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5874 psa_key_slot_t *private_key,
5875 const uint8_t *peer_key,
5876 size_t peer_key_length,
5877 uint8_t *shared_secret,
5878 size_t shared_secret_size,
5879 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005880{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005881 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005882 {
John Durkop6ba40d12020-11-10 08:50:04 -08005883#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005884 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005885 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005886 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005887 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005888 psa_status_t status = mbedtls_psa_ecp_load_representation(
5889 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005890 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005891 private_key->key.data,
5892 private_key->key.bytes,
5893 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005894 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005895 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005896 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005897 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005898 shared_secret, shared_secret_size,
5899 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005900 mbedtls_ecp_keypair_free( ecp );
5901 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005902 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005903#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005904 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005905 (void) private_key;
5906 (void) peer_key;
5907 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005908 (void) shared_secret;
5909 (void) shared_secret_size;
5910 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005911 return( PSA_ERROR_NOT_SUPPORTED );
5912 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005913}
5914
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005915/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005916 * to potentially free embedded data structures and wipe confidential data.
5917 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005918static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005919 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005920 psa_key_slot_t *private_key,
5921 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005922 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005923{
5924 psa_status_t status;
5925 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5926 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005927 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005928
5929 /* Step 1: run the secret agreement algorithm to generate the shared
5930 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005931 status = psa_key_agreement_raw_internal( ka_alg,
5932 private_key,
5933 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005934 shared_secret,
5935 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005936 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005937 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005938 goto exit;
5939
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005940 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005941 * the shared secret. A shared secret is permitted wherever a key
5942 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005943 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005944 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005945 shared_secret,
5946 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005947exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005948 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005949 return( status );
5950}
5951
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005952psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005953 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005954 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005955 const uint8_t *peer_key,
5956 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005957{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005958 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005959 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005960 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005961
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005962 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005963 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005964 status = psa_get_and_lock_transparent_key_slot_with_policy(
5965 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005966 if( status != PSA_SUCCESS )
5967 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005968 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005969 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005970 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005971 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005972 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005973 else
5974 {
5975 /* If a private key has been added as SECRET, we allow the derived
5976 * key material to be used as a key in PSA Crypto. */
5977 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5978 operation->can_output_key = 1;
5979 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005980
Ronald Cron5c522922020-11-14 16:35:34 +01005981 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005982
Ronald Cron5c522922020-11-14 16:35:34 +01005983 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005984}
5985
Gilles Peskinebe697d82019-05-16 18:00:41 +02005986psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005987 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005988 const uint8_t *peer_key,
5989 size_t peer_key_length,
5990 uint8_t *output,
5991 size_t output_size,
5992 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005993{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005994 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005995 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005996 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005997
5998 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5999 {
6000 status = PSA_ERROR_INVALID_ARGUMENT;
6001 goto exit;
6002 }
Ronald Cron5c522922020-11-14 16:35:34 +01006003 status = psa_get_and_lock_transparent_key_slot_with_policy(
6004 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006005 if( status != PSA_SUCCESS )
6006 goto exit;
6007
6008 status = psa_key_agreement_raw_internal( alg, slot,
6009 peer_key, peer_key_length,
6010 output, output_size,
6011 output_length );
6012
6013exit:
6014 if( status != PSA_SUCCESS )
6015 {
6016 /* If an error happens and is not handled properly, the output
6017 * may be used as a key to protect sensitive data. Arrange for such
6018 * a key to be random, which is likely to result in decryption or
6019 * verification errors. This is better than filling the buffer with
6020 * some constant data such as zeros, which would result in the data
6021 * being protected with a reproducible, easily knowable key.
6022 */
6023 psa_generate_random( output, output_size );
6024 *output_length = output_size;
6025 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006026
Ronald Cron5c522922020-11-14 16:35:34 +01006027 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006028
Ronald Cron5c522922020-11-14 16:35:34 +01006029 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006030}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006031
6032
Gilles Peskine30524eb2020-11-13 17:02:26 +01006033
Gilles Peskine86a440b2018-11-12 18:39:40 +01006034/****************************************************************/
6035/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006036/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006037
Gilles Peskine30524eb2020-11-13 17:02:26 +01006038/** Initialize the PSA random generator.
6039 */
6040static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
6041{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006042#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6043 memset( rng, 0, sizeof( *rng ) );
6044#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6045
Gilles Peskine30524eb2020-11-13 17:02:26 +01006046 /* Set default configuration if
6047 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6048 if( rng->entropy_init == NULL )
6049 rng->entropy_init = mbedtls_entropy_init;
6050 if( rng->entropy_free == NULL )
6051 rng->entropy_free = mbedtls_entropy_free;
6052
6053 rng->entropy_init( &rng->entropy );
6054#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6055 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6056 /* The PSA entropy injection feature depends on using NV seed as an entropy
6057 * source. Add NV seed as an entropy source for PSA entropy injection. */
6058 mbedtls_entropy_add_source( &rng->entropy,
6059 mbedtls_nv_seed_poll, NULL,
6060 MBEDTLS_ENTROPY_BLOCK_SIZE,
6061 MBEDTLS_ENTROPY_SOURCE_STRONG );
6062#endif
6063
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006064 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006065#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006066}
6067
6068/** Deinitialize the PSA random generator.
6069 */
6070static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6071{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006072#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6073 memset( rng, 0, sizeof( *rng ) );
6074#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006075 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006076 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006077#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006078}
6079
6080/** Seed the PSA random generator.
6081 */
6082static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6083{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006084#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6085 /* Do nothing: the external RNG seeds itself. */
6086 (void) rng;
6087 return( PSA_SUCCESS );
6088#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006089 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006090 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
6091 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006092 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006093#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006094}
6095
Gilles Peskinee59236f2018-01-27 23:32:46 +01006096psa_status_t psa_generate_random( uint8_t *output,
6097 size_t output_size )
6098{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006099 GUARD_MODULE_INITIALIZED;
6100
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006101#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6102
6103 size_t output_length = 0;
6104 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6105 output, output_size,
6106 &output_length );
6107 if( status != PSA_SUCCESS )
6108 return( status );
6109 /* Breaking up a request into smaller chunks is currently not supported
6110 * for the extrernal RNG interface. */
6111 if( output_length != output_size )
6112 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6113 return( PSA_SUCCESS );
6114
6115#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6116
Gilles Peskine71ddab92021-01-04 21:01:07 +01006117 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006118 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006119 size_t request_size =
6120 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6121 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6122 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006123 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6124 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006125 if( ret != 0 )
6126 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006127 output_size -= request_size;
6128 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006129 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006130 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006131#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006132}
6133
Gilles Peskine8814fc42020-12-14 15:33:44 +01006134/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006135 *
6136 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6137 * `psa_generate_random(...)`. The state parameter is ignored since the
6138 * PSA API doesn't support passing an explicit state.
6139 *
6140 * In the non-external case, psa_generate_random() calls an
6141 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6142 * and semantics as mbedtls_psa_get_random(). As an optimization,
6143 * instead of doing this back-and-forth between the PSA API and the
6144 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6145 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006146 */
6147#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6148int mbedtls_psa_get_random( void *p_rng,
6149 unsigned char *output,
6150 size_t output_size )
6151{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006152 /* This function takes a pointer to the RNG state because that's what
6153 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6154 * its own state internally and doesn't let the caller access that state.
6155 * So we just ignore the state parameter, and in practice we'll pass
6156 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006157 (void) p_rng;
6158 psa_status_t status = psa_generate_random( output, output_size );
6159 if( status == PSA_SUCCESS )
6160 return( 0 );
6161 else
6162 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6163}
6164#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6165
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006166#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6167#include "mbedtls/entropy_poll.h"
6168
Gilles Peskine7228da22019-07-15 11:06:15 +02006169psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006170 size_t seed_size )
6171{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006172 if( global_data.initialized )
6173 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006174
6175 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6176 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6177 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6178 return( PSA_ERROR_INVALID_ARGUMENT );
6179
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006180 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006181}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006182#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006183
Ronald Cron3772afe2021-02-08 16:10:05 +01006184/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02006185 *
Ronald Cron3772afe2021-02-08 16:10:05 +01006186 * \param type The key type
6187 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02006188 *
6189 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01006190 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02006191 * \retval #PSA_ERROR_INVALID_ARGUMENT
6192 * The size in bits of the key is not valid.
6193 * \retval #PSA_ERROR_NOT_SUPPORTED
6194 * The type and/or the size in bits of the key or the combination of
6195 * the two is not supported.
6196 */
Ronald Cron3772afe2021-02-08 16:10:05 +01006197static psa_status_t psa_validate_key_type_and_size_for_key_generation(
6198 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006199{
Ronald Cronf3bb7612020-10-02 20:11:59 +02006200 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006201
Gilles Peskinee59236f2018-01-27 23:32:46 +01006202 if( key_type_is_raw_bytes( type ) )
6203 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02006204 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006205 if( status != PSA_SUCCESS )
6206 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006207 }
6208 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006209#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006210 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6211 {
6212 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6213 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006214
Ronald Cron01b2aba2020-10-05 09:42:02 +02006215 /* Accept only byte-aligned keys, for the same reasons as
6216 * in psa_import_rsa_key(). */
6217 if( bits % 8 != 0 )
6218 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006219 }
6220 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006221#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006222
Ronald Cron5c4d3862020-12-07 11:07:24 +01006223#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006224 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6225 {
Ronald Crond81ab562021-02-16 09:01:16 +01006226 /* To avoid empty block, return successfully here. */
6227 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006228 }
6229 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006230#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006231 {
6232 return( PSA_ERROR_NOT_SUPPORTED );
6233 }
6234
6235 return( PSA_SUCCESS );
6236}
6237
Ronald Cron55ed0592020-10-05 10:30:40 +02006238psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006239 const psa_key_attributes_t *attributes,
6240 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006241{
6242 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006243 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006244
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006245 if( ( attributes->domain_parameters == NULL ) &&
6246 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006247 return( PSA_ERROR_INVALID_ARGUMENT );
6248
Ronald Cron01b2aba2020-10-05 09:42:02 +02006249 if( key_type_is_raw_bytes( type ) )
6250 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006251 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006252 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006253 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006254
David Brown12ca5032021-02-11 11:02:00 -07006255#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006256 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006257 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07006258#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006259 }
6260 else
6261
John Durkop07cc04a2020-11-16 22:08:34 -08006262#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006263 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006264 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01006265 return( mbedtls_psa_rsa_generate_key( attributes,
6266 key_buffer,
6267 key_buffer_size,
6268 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006269 }
6270 else
John Durkop07cc04a2020-11-16 22:08:34 -08006271#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006272
John Durkop9814fa22020-11-04 12:28:15 -08006273#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006274 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006275 {
Ronald Cron7023db52020-11-20 18:17:42 +01006276 return( mbedtls_psa_ecp_generate_key( attributes,
6277 key_buffer,
6278 key_buffer_size,
6279 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006280 }
6281 else
John Durkop9814fa22020-11-04 12:28:15 -08006282#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006283 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006284 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006285 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006286 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006287
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006288 return( PSA_SUCCESS );
6289}
Darryl Green0c6575a2018-11-07 16:05:30 +00006290
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006291psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006292 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006293{
6294 psa_status_t status;
6295 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006296 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02006297 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02006298
Ronald Cron81709fc2020-11-14 12:10:32 +01006299 *key = MBEDTLS_SVC_KEY_ID_INIT;
6300
Gilles Peskine0f84d622019-09-12 19:03:13 +02006301 /* Reject any attempt to create a zero-length key so that we don't
6302 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6303 if( psa_get_key_bits( attributes ) == 0 )
6304 return( PSA_ERROR_INVALID_ARGUMENT );
6305
Ronald Cron81709fc2020-11-14 12:10:32 +01006306 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6307 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006308 if( status != PSA_SUCCESS )
6309 goto exit;
6310
Ronald Cron977c2472020-10-13 08:32:21 +02006311 /* In the case of a transparent key or an opaque key stored in local
6312 * storage (thus not in the case of generating a key in a secure element
6313 * or cryptoprocessor with storage), we have to allocate a buffer to
6314 * hold the generated key material. */
6315 if( slot->key.data == NULL )
6316 {
6317 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
6318 PSA_KEY_LOCATION_LOCAL_STORAGE )
6319 {
Ronald Cron3772afe2021-02-08 16:10:05 +01006320 status = psa_validate_key_type_and_size_for_key_generation(
6321 attributes->core.type, attributes->core.bits );
6322 if( status != PSA_SUCCESS )
6323 goto exit;
6324
6325 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
6326 attributes->core.type,
6327 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02006328 }
6329 else
6330 {
6331 status = psa_driver_wrapper_get_key_buffer_size(
6332 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01006333 if( status != PSA_SUCCESS )
6334 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02006335 }
Ronald Cron977c2472020-10-13 08:32:21 +02006336
6337 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
6338 if( status != PSA_SUCCESS )
6339 goto exit;
6340 }
6341
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006342 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02006343 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02006344
Ronald Cron2b56bc82020-10-05 10:02:26 +02006345 if( status != PSA_SUCCESS )
6346 psa_remove_key_data_from_memory( slot );
6347
Gilles Peskine11792082019-08-06 18:36:36 +02006348exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006349 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006350 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006351 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006352 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006353
Darryl Green0c6575a2018-11-07 16:05:30 +00006354 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006355}
6356
Gilles Peskinee59236f2018-01-27 23:32:46 +01006357/****************************************************************/
6358/* Module setup */
6359/****************************************************************/
6360
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006361#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006362psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6363 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6364 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6365{
6366 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6367 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006368 global_data.rng.entropy_init = entropy_init;
6369 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006370 return( PSA_SUCCESS );
6371}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006372#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006373
Gilles Peskinee59236f2018-01-27 23:32:46 +01006374void mbedtls_psa_crypto_free( void )
6375{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006376 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006377 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6378 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006379 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006380 }
6381 /* Wipe all remaining data, including configuration.
6382 * In particular, this sets all state indicator to the value
6383 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006384 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006385#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006386 /* Unregister all secure element drivers, so that we restart from
6387 * a pristine state. */
6388 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006389#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006390}
6391
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006392#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6393/** Recover a transaction that was interrupted by a power failure.
6394 *
6395 * This function is called during initialization, before psa_crypto_init()
6396 * returns. If this function returns a failure status, the initialization
6397 * fails.
6398 */
6399static psa_status_t psa_crypto_recover_transaction(
6400 const psa_crypto_transaction_t *transaction )
6401{
6402 switch( transaction->unknown.type )
6403 {
6404 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6405 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006406 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006407 * is implemented.
6408 * https://github.com/ARMmbed/mbed-crypto/issues/218
6409 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006410 default:
6411 /* We found an unsupported transaction in the storage.
6412 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006413 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006414 }
6415}
6416#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6417
Gilles Peskinee59236f2018-01-27 23:32:46 +01006418psa_status_t psa_crypto_init( void )
6419{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006420 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006421
Gilles Peskinec6b69072018-11-20 21:42:52 +01006422 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006423 if( global_data.initialized != 0 )
6424 return( PSA_SUCCESS );
6425
Gilles Peskine30524eb2020-11-13 17:02:26 +01006426 /* Initialize and seed the random generator. */
6427 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006428 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006429 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006430 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006431 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006432 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006433
Gilles Peskine66fb1262018-12-10 16:29:04 +01006434 status = psa_initialize_key_slots( );
6435 if( status != PSA_SUCCESS )
6436 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006437
Gilles Peskined9348f22019-10-01 15:22:29 +02006438#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6439 status = psa_init_all_se_drivers( );
6440 if( status != PSA_SUCCESS )
6441 goto exit;
6442#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6443
Gilles Peskine4b734222019-07-24 15:56:31 +02006444#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006445 status = psa_crypto_load_transaction( );
6446 if( status == PSA_SUCCESS )
6447 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006448 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6449 if( status != PSA_SUCCESS )
6450 goto exit;
6451 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006452 }
6453 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6454 {
6455 /* There's no transaction to complete. It's all good. */
6456 status = PSA_SUCCESS;
6457 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006458#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006459
Gilles Peskinec6b69072018-11-20 21:42:52 +01006460 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006461 global_data.initialized = 1;
6462
6463exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006464 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006465 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006466 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006467}
6468
6469#endif /* MBEDTLS_PSA_CRYPTO_C */