blob: 2d237a6e9d6e18ae575a8f443bf980c12d0bea9c [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;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498#if defined(MBEDTLS_AES_C)
499 case PSA_KEY_TYPE_AES:
500 if( bits != 128 && bits != 192 && bits != 256 )
501 return( PSA_ERROR_INVALID_ARGUMENT );
502 break;
503#endif
504#if defined(MBEDTLS_CAMELLIA_C)
505 case PSA_KEY_TYPE_CAMELLIA:
506 if( bits != 128 && bits != 192 && bits != 256 )
507 return( PSA_ERROR_INVALID_ARGUMENT );
508 break;
509#endif
510#if defined(MBEDTLS_DES_C)
511 case PSA_KEY_TYPE_DES:
512 if( bits != 64 && bits != 128 && bits != 192 )
513 return( PSA_ERROR_INVALID_ARGUMENT );
514 break;
515#endif
516#if defined(MBEDTLS_ARC4_C)
517 case PSA_KEY_TYPE_ARC4:
518 if( bits < 8 || bits > 2048 )
519 return( PSA_ERROR_INVALID_ARGUMENT );
520 break;
521#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200522#if defined(MBEDTLS_CHACHA20_C)
523 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 Cooreman75b74362020-07-28 14:30:13 +0200548/** Try to allocate a buffer to an empty key slot.
549 *
550 * \param[in,out] slot Key slot to attach buffer to.
551 * \param[in] buffer_length Requested size of the buffer.
552 *
553 * \retval #PSA_SUCCESS
554 * The buffer has been successfully allocated.
555 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
556 * Not enough memory was available for allocation.
557 * \retval #PSA_ERROR_ALREADY_EXISTS
558 * Trying to allocate a buffer to a non-empty key slot.
559 */
560static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
561 size_t buffer_length )
562{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100563 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200564 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200565
Ronald Cronea0f8a62020-11-25 17:52:23 +0100566 slot->key.data = mbedtls_calloc( 1, buffer_length );
567 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200568 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200569
Ronald Cronea0f8a62020-11-25 17:52:23 +0100570 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200571 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200572}
573
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200574psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
575 const uint8_t* data,
576 size_t data_length )
577{
578 psa_status_t status = psa_allocate_buffer_to_slot( slot,
579 data_length );
580 if( status != PSA_SUCCESS )
581 return( status );
582
Ronald Cronea0f8a62020-11-25 17:52:23 +0100583 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200584 return( PSA_SUCCESS );
585}
586
Ronald Crona0fe59f2020-11-29 11:14:53 +0100587psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100588 const psa_key_attributes_t *attributes,
589 const uint8_t *data, size_t data_length,
590 uint8_t *key_buffer, size_t key_buffer_size,
591 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100592{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
594 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100595
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200596 /* zero-length keys are never supported. */
597 if( data_length == 0 )
598 return( PSA_ERROR_NOT_SUPPORTED );
599
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100600 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100601 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100602 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200603
Steven Cooreman75b74362020-07-28 14:30:13 +0200604 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
605 if( data_length > SIZE_MAX / 8 )
606 return( PSA_ERROR_NOT_SUPPORTED );
607
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200608 /* Enforce a size limit, and in particular ensure that the bit
609 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100610 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200611 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200612
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100613 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200614 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200615 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200616
Ronald Crondd04d422020-11-28 15:14:42 +0100617 /* Copy the key material. */
618 memcpy( key_buffer, data, data_length );
619 *key_buffer_length = data_length;
620 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200621
Steven Cooreman40120f62020-10-29 11:42:22 +0100622 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100623 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100624 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200625 {
John Durkop9814fa22020-11-04 12:28:15 -0800626#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
627 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100628 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200629 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100630 return( mbedtls_psa_ecp_import_key( attributes,
631 data, data_length,
632 key_buffer, key_buffer_size,
633 key_buffer_length,
634 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100635 }
John Durkop9814fa22020-11-04 12:28:15 -0800636#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
637 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700638#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
639 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100640 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200641 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100642 return( mbedtls_psa_rsa_import_key( attributes,
643 data, data_length,
644 key_buffer, key_buffer_size,
645 key_buffer_length,
646 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200647 }
John Durkop9814fa22020-11-04 12:28:15 -0800648#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
649 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100650 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100651
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100652 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100653}
654
Gilles Peskinef603c712019-01-19 13:40:11 +0100655/** Calculate the intersection of two algorithm usage policies.
656 *
657 * Return 0 (which allows no operation) on incompatibility.
658 */
659static psa_algorithm_t psa_key_policy_algorithm_intersection(
660 psa_algorithm_t alg1,
661 psa_algorithm_t alg2 )
662{
Gilles Peskine549ea862019-05-22 11:45:59 +0200663 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100664 if( alg1 == alg2 )
665 return( alg1 );
666 /* If the policies are from the same hash-and-sign family, check
667 * if one is a wildcard. If so the other has the specific algorithm. */
668 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
669 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
670 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
671 {
672 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
673 return( alg2 );
674 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
675 return( alg1 );
676 }
677 /* If the policies are incompatible, allow nothing. */
678 return( 0 );
679}
680
Gilles Peskined6f371b2019-05-10 19:33:38 +0200681static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
682 psa_algorithm_t requested_alg )
683{
Gilles Peskine549ea862019-05-22 11:45:59 +0200684 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200685 if( requested_alg == policy_alg )
686 return( 1 );
687 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200688 * and requested_alg is the same hash-and-sign family with any hash,
689 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200690 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
691 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
692 {
693 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
694 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
695 }
Steven Cooremance48e852020-10-05 16:02:45 +0200696 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200697 * a key derivation with that key agreement should also be allowed. This
698 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200699 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
700 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
701 {
702 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
703 policy_alg );
704 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200705 /* If it isn't permitted, it's forbidden. */
706 return( 0 );
707}
708
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100709/** Test whether a policy permits an algorithm.
710 *
711 * The caller must test usage flags separately.
712 */
713static int psa_key_policy_permits( const psa_key_policy_t *policy,
714 psa_algorithm_t alg )
715{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200716 return( psa_key_algorithm_permits( policy->alg, alg ) ||
717 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100718}
719
Gilles Peskinef603c712019-01-19 13:40:11 +0100720/** Restrict a key policy based on a constraint.
721 *
722 * \param[in,out] policy The policy to restrict.
723 * \param[in] constraint The policy constraint to apply.
724 *
725 * \retval #PSA_SUCCESS
726 * \c *policy contains the intersection of the original value of
727 * \c *policy and \c *constraint.
728 * \retval #PSA_ERROR_INVALID_ARGUMENT
729 * \c *policy and \c *constraint are incompatible.
730 * \c *policy is unchanged.
731 */
732static psa_status_t psa_restrict_key_policy(
733 psa_key_policy_t *policy,
734 const psa_key_policy_t *constraint )
735{
736 psa_algorithm_t intersection_alg =
737 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200738 psa_algorithm_t intersection_alg2 =
739 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100740 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
741 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200742 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
743 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100744 policy->usage &= constraint->usage;
745 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200746 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100747 return( PSA_SUCCESS );
748}
749
Ronald Cron5c522922020-11-14 16:35:34 +0100750/** Get the description of a key given its identifier and policy constraints
751 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200752 *
Ronald Cron5c522922020-11-14 16:35:34 +0100753 * The key must have allow all the usage flags set in \p usage. If \p alg is
754 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +0100755 *
Ronald Cron5c522922020-11-14 16:35:34 +0100756 * In case of a persistent key, the function loads the description of the key
757 * into a key slot if not already done.
758 *
759 * On success, the returned key slot is locked. It is the responsibility of
760 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200761 */
Ronald Cron5c522922020-11-14 16:35:34 +0100762static psa_status_t psa_get_and_lock_key_slot_with_policy(
763 mbedtls_svc_key_id_t key,
764 psa_key_slot_t **p_slot,
765 psa_key_usage_t usage,
766 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100767{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200768 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
769 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100770
Ronald Cron5c522922020-11-14 16:35:34 +0100771 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100772 if( status != PSA_SUCCESS )
773 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200774 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100775
776 /* Enforce that usage policy for the key slot contains all the flags
777 * required by the usage parameter. There is one exception: public
778 * keys can always be exported, so we treat public key objects as
779 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200780 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100781 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200782
783 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +0200784 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200785 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100786
787 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200788 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200789 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +0100790
Darryl Green06fd18d2018-07-16 11:21:11 +0100791 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200792
793error:
794 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100795 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200796
797 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100798}
Darryl Green940d72c2018-07-13 13:18:51 +0100799
Ronald Cron5c522922020-11-14 16:35:34 +0100800/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200801 *
802 * A transparent key is a key for which the key material is directly
803 * available, as opposed to a key in a secure element.
804 *
Ronald Cron5c522922020-11-14 16:35:34 +0100805 * This is a temporary function to use instead of
806 * psa_get_and_lock_key_slot_with_policy() until secure element support is
807 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200808 *
Ronald Cron5c522922020-11-14 16:35:34 +0100809 * On success, the returned key slot is locked. It is the responsibility of the
810 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200811 */
812#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100813static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
814 mbedtls_svc_key_id_t key,
815 psa_key_slot_t **p_slot,
816 psa_key_usage_t usage,
817 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200818{
Ronald Cron5c522922020-11-14 16:35:34 +0100819 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
820 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200821 if( status != PSA_SUCCESS )
822 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200823
Gilles Peskineadad8132019-07-25 11:31:23 +0200824 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200825 {
Ronald Cron5c522922020-11-14 16:35:34 +0100826 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200827 *p_slot = NULL;
828 return( PSA_ERROR_NOT_SUPPORTED );
829 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200830
Gilles Peskine28f8f302019-07-24 13:30:31 +0200831 return( PSA_SUCCESS );
832}
833#else /* MBEDTLS_PSA_CRYPTO_SE_C */
834/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100835#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
836 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200837#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
838
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100839/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100840static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000841{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100842 /* Data pointer will always be either a valid pointer or NULL in an
843 * initialized slot, so we can just free it. */
844 if( slot->key.data != NULL )
845 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
846
847 mbedtls_free( slot->key.data );
848 slot->key.data = NULL;
849 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000850
851 return( PSA_SUCCESS );
852}
853
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100854/** Completely wipe a slot in memory, including its policy.
855 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100856psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100857{
858 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100859
860 /*
861 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +0100862 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +0100863 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
864 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +0100865 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +0100866 */
Ronald Cron5c522922020-11-14 16:35:34 +0100867 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100868 {
869#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +0100870 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100871#endif
Ronald Cronddd3d052020-10-30 14:07:07 +0100872 status = PSA_ERROR_CORRUPTION_DETECTED;
873 }
874
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200875 /* Multipart operations may still be using the key. This is safe
876 * because all multipart operation objects are independent from
877 * the key slot: if they need to access the key after the setup
878 * phase, they have a copy of the key. Note that this means that
879 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100880 /* At this point, key material and other type-specific content has
881 * been wiped. Clear remaining metadata. We can call memset and not
882 * zeroize because the metadata is not particularly sensitive. */
883 memset( slot, 0, sizeof( *slot ) );
884 return( status );
885}
886
Ronald Croncf56a0a2020-08-04 09:51:30 +0200887psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100888{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100889 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200890 psa_status_t status; /* status of the last operation */
891 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +0200892#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
893 psa_se_drv_table_entry_t *driver;
894#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100895
Ronald Croncf56a0a2020-08-04 09:51:30 +0200896 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +0200897 return( PSA_SUCCESS );
898
Ronald Cronf2911112020-10-29 17:51:10 +0100899 /*
Ronald Cron19daca92020-11-10 18:08:03 +0100900 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +0100901 * key, this will load the key description from persistent memory if not
902 * done yet. We cannot avoid this loading as without it we don't know if
903 * the key is operated by an SE or not and this information is needed by
904 * the current implementation.
905 */
Ronald Cron5c522922020-11-14 16:35:34 +0100906 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200907 if( status != PSA_SUCCESS )
908 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +0200909
Ronald Cronf2911112020-10-29 17:51:10 +0100910 /*
911 * If the key slot containing the key description is under access by the
912 * library (apart from the present access), the key cannot be destroyed
913 * yet. For the time being, just return in error. Eventually (to be
914 * implemented), the key should be destroyed when all accesses have
915 * stopped.
916 */
Ronald Cron5c522922020-11-14 16:35:34 +0100917 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +0100918 {
Ronald Cron5c522922020-11-14 16:35:34 +0100919 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +0100920 return( PSA_ERROR_GENERIC_ERROR );
921 }
922
Gilles Peskine354f7672019-07-12 23:46:38 +0200923#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200924 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +0200925 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +0200926 {
Gilles Peskine60450a42019-07-25 11:32:45 +0200927 /* For a key in a secure element, we need to do three things:
928 * remove the key file in internal storage, destroy the
929 * key inside the secure element, and update the driver's
930 * persistent data. Start a transaction that will encompass these
931 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +0200932 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +0200933 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +0100934 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +0200935 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +0200936 status = psa_crypto_save_transaction( );
937 if( status != PSA_SUCCESS )
938 {
Gilles Peskine66be51c2019-07-25 18:02:52 +0200939 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200940 /* We should still try to destroy the key in the secure
941 * element and the key metadata in storage. This is especially
942 * important if the error is that the storage is full.
943 * But how to do it exactly without risking an inconsistent
944 * state after a reset?
945 * https://github.com/ARMmbed/mbed-crypto/issues/215
946 */
947 overall_status = status;
948 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +0200949 }
950
Ronald Cronea0f8a62020-11-25 17:52:23 +0100951 status = psa_destroy_se_key( driver,
952 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200953 if( overall_status == PSA_SUCCESS )
954 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +0200955 }
Gilles Peskine354f7672019-07-12 23:46:38 +0200956#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
957
Darryl Greend49a4992018-06-18 17:27:26 +0100958#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +0200959 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +0100960 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200961 status = psa_destroy_persistent_key( slot->attr.id );
962 if( overall_status == PSA_SUCCESS )
963 overall_status = status;
964
Gilles Peskine9ce31c42019-08-13 15:14:20 +0200965 /* TODO: other slots may have a copy of the same key. We should
966 * invalidate them.
967 * https://github.com/ARMmbed/mbed-crypto/issues/214
968 */
Darryl Greend49a4992018-06-18 17:27:26 +0100969 }
970#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +0200971
Gilles Peskinefc762652019-07-22 19:30:34 +0200972#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
973 if( driver != NULL )
974 {
Gilles Peskine725f22a2019-07-25 11:31:48 +0200975 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200976 if( overall_status == PSA_SUCCESS )
977 overall_status = status;
978 status = psa_crypto_stop_transaction( );
979 if( overall_status == PSA_SUCCESS )
980 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +0200981 }
982#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
983
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200984#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
985exit:
986#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100987 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200988 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
989 if( overall_status == PSA_SUCCESS )
990 overall_status = status;
991 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100992}
993
John Durkop07cc04a2020-11-16 22:08:34 -0800994#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -0700995 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +0200996static psa_status_t psa_get_rsa_public_exponent(
997 const mbedtls_rsa_context *rsa,
998 psa_key_attributes_t *attributes )
999{
1000 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001002 uint8_t *buffer = NULL;
1003 size_t buflen;
1004 mbedtls_mpi_init( &mpi );
1005
1006 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1007 if( ret != 0 )
1008 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001009 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1010 {
1011 /* It's the default value, which is reported as an empty string,
1012 * so there's nothing to do. */
1013 goto exit;
1014 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001015
1016 buflen = mbedtls_mpi_size( &mpi );
1017 buffer = mbedtls_calloc( 1, buflen );
1018 if( buffer == NULL )
1019 {
1020 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1021 goto exit;
1022 }
1023 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1024 if( ret != 0 )
1025 goto exit;
1026 attributes->domain_parameters = buffer;
1027 attributes->domain_parameters_size = buflen;
1028
1029exit:
1030 mbedtls_mpi_free( &mpi );
1031 if( ret != 0 )
1032 mbedtls_free( buffer );
1033 return( mbedtls_to_psa_error( ret ) );
1034}
John Durkop07cc04a2020-11-16 22:08:34 -08001035#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001036 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001037
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001038/** Retrieve all the publicly-accessible attributes of a key.
1039 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001040psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001041 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001042{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001043 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001044 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001045 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001046
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001047 psa_reset_key_attributes( attributes );
1048
Ronald Cron5c522922020-11-14 16:35:34 +01001049 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001050 if( status != PSA_SUCCESS )
1051 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001052
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001053 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001054 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1055 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1056
1057#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1058 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001059 psa_set_key_slot_number( attributes,
1060 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001061#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001062
Gilles Peskine8e338702019-07-30 20:06:31 +02001063 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001064 {
John Durkop07cc04a2020-11-16 22:08:34 -08001065#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001066 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001067 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001068 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001069#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001070 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001071 * is not yet implemented.
1072 * https://github.com/ARMmbed/mbed-crypto/issues/216
1073 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001074 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001075 break;
1076#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001077 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001078 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001079
Ronald Cron90857082020-11-25 14:58:33 +01001080 status = mbedtls_psa_rsa_load_representation(
1081 slot->attr.type,
1082 slot->key.data,
1083 slot->key.bytes,
1084 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001085 if( status != PSA_SUCCESS )
1086 break;
1087
Steven Cooremana2371e52020-07-28 14:30:39 +02001088 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001089 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001090 mbedtls_rsa_free( rsa );
1091 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001092 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001093 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001094#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001095 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001096 default:
1097 /* Nothing else to do. */
1098 break;
1099 }
1100
1101 if( status != PSA_SUCCESS )
1102 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001103
Ronald Cron5c522922020-11-14 16:35:34 +01001104 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001105
Ronald Cron5c522922020-11-14 16:35:34 +01001106 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001107}
1108
Gilles Peskinec8000c02019-08-02 20:15:51 +02001109#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1110psa_status_t psa_get_key_slot_number(
1111 const psa_key_attributes_t *attributes,
1112 psa_key_slot_number_t *slot_number )
1113{
1114 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1115 {
1116 *slot_number = attributes->slot_number;
1117 return( PSA_SUCCESS );
1118 }
1119 else
1120 return( PSA_ERROR_INVALID_ARGUMENT );
1121}
1122#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1123
Ronald Crond18b5f82020-11-25 16:46:05 +01001124static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1125 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001126 uint8_t *data,
1127 size_t data_size,
1128 size_t *data_length )
1129{
Ronald Crond18b5f82020-11-25 16:46:05 +01001130 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001131 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001132 memcpy( data, key_buffer, key_buffer_size );
1133 memset( data + key_buffer_size, 0,
1134 data_size - key_buffer_size );
1135 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001136 return( PSA_SUCCESS );
1137}
1138
Ronald Cron7285cda2020-11-26 14:46:37 +01001139psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001140 const psa_key_attributes_t *attributes,
1141 const uint8_t *key_buffer, size_t key_buffer_size,
1142 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001143{
Ronald Crond18b5f82020-11-25 16:46:05 +01001144 psa_key_type_t type = attributes->core.type;
1145
Ronald Crond18b5f82020-11-25 16:46:05 +01001146 if( key_type_is_raw_bytes( type ) ||
1147 PSA_KEY_TYPE_IS_RSA( type ) ||
1148 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001149 {
1150 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001151 key_buffer, key_buffer_size,
1152 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001153 }
1154 else
1155 {
1156 /* This shouldn't happen in the reference implementation, but
1157 it is valid for a special-purpose implementation to omit
1158 support for exporting certain key types. */
1159 return( PSA_ERROR_NOT_SUPPORTED );
1160 }
1161}
1162
1163psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1164 uint8_t *data,
1165 size_t data_size,
1166 size_t *data_length )
1167{
1168 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1169 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1170 psa_key_slot_t *slot;
1171
Ronald Crone907e552021-01-18 13:22:38 +01001172 /* Reject a zero-length output buffer now, since this can never be a
1173 * valid key representation. This way we know that data must be a valid
1174 * pointer and we can do things like memset(data, ..., data_size). */
1175 if( data_size == 0 )
1176 return( PSA_ERROR_BUFFER_TOO_SMALL );
1177
Ronald Cron9486f9d2020-11-26 13:36:23 +01001178 /* Set the key to empty now, so that even when there are errors, we always
1179 * set data_length to a value between 0 and data_size. On error, setting
1180 * the key to empty is a good choice because an empty key representation is
1181 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001182 *data_length = 0;
1183
Ronald Cron9486f9d2020-11-26 13:36:23 +01001184 /* Export requires the EXPORT flag. There is an exception for public keys,
1185 * which don't require any flag, but
1186 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1187 */
1188 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1189 PSA_KEY_USAGE_EXPORT, 0 );
1190 if( status != PSA_SUCCESS )
1191 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001192
Ronald Crond18b5f82020-11-25 16:46:05 +01001193 psa_key_attributes_t attributes = {
1194 .core = slot->attr
1195 };
Ronald Cron67227982020-11-26 15:16:05 +01001196 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001197 slot->key.data, slot->key.bytes,
1198 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001199
Ronald Cron9486f9d2020-11-26 13:36:23 +01001200 unlock_status = psa_unlock_key_slot( slot );
1201
1202 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1203}
1204
Ronald Cron7285cda2020-11-26 14:46:37 +01001205psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001206 const psa_key_attributes_t *attributes,
1207 const uint8_t *key_buffer,
1208 size_t key_buffer_size,
1209 uint8_t *data,
1210 size_t data_size,
1211 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001212{
Ronald Crond18b5f82020-11-25 16:46:05 +01001213 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001214
Ronald Crond18b5f82020-11-25 16:46:05 +01001215 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001216 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001217 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001218 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001219 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001220 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001221 key_buffer, key_buffer_size,
1222 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001223 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001224
Ronald Crond18b5f82020-11-25 16:46:05 +01001225 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001226 {
John Durkop0e005192020-10-31 22:06:54 -07001227#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1228 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001229 return( mbedtls_psa_rsa_export_public_key( attributes,
1230 key_buffer,
1231 key_buffer_size,
1232 data,
1233 data_size,
1234 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001235#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001236 /* We don't know how to convert a private RSA key to public. */
1237 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001238#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1239 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001240 }
1241 else
Moran Pekera998bc62018-04-16 18:16:20 +03001242 {
John Durkop6ba40d12020-11-10 08:50:04 -08001243#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1244 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001245 return( mbedtls_psa_ecp_export_public_key( attributes,
1246 key_buffer,
1247 key_buffer_size,
1248 data,
1249 data_size,
1250 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001251#else
1252 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001253 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001254#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1255 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001256 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001258 else
1259 {
1260 /* This shouldn't happen in the reference implementation, but
1261 it is valid for a special-purpose implementation to omit
1262 support for exporting certain key types. */
1263 return( PSA_ERROR_NOT_SUPPORTED );
1264 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001265}
Ronald Crond18b5f82020-11-25 16:46:05 +01001266
Ronald Croncf56a0a2020-08-04 09:51:30 +02001267psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001268 uint8_t *data,
1269 size_t data_size,
1270 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001271{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001272 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001273 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001274 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001275
Ronald Crone907e552021-01-18 13:22:38 +01001276 /* Reject a zero-length output buffer now, since this can never be a
1277 * valid key representation. This way we know that data must be a valid
1278 * pointer and we can do things like memset(data, ..., data_size). */
1279 if( data_size == 0 )
1280 return( PSA_ERROR_BUFFER_TOO_SMALL );
1281
Darryl Greendd8fb772018-11-07 16:00:44 +00001282 /* Set the key to empty now, so that even when there are errors, we always
1283 * set data_length to a value between 0 and data_size. On error, setting
1284 * the key to empty is a good choice because an empty key representation is
1285 * unlikely to be accepted anywhere. */
1286 *data_length = 0;
1287
1288 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001289 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001290 if( status != PSA_SUCCESS )
1291 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001292
Ronald Cron9486f9d2020-11-26 13:36:23 +01001293 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1294 {
1295 status = PSA_ERROR_INVALID_ARGUMENT;
1296 goto exit;
1297 }
1298
Ronald Crond18b5f82020-11-25 16:46:05 +01001299 psa_key_attributes_t attributes = {
1300 .core = slot->attr
1301 };
Ronald Cron67227982020-11-26 15:16:05 +01001302 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001303 &attributes, slot->key.data, slot->key.bytes,
1304 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001305
1306exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001307 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001308
Ronald Cron5c522922020-11-14 16:35:34 +01001309 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001310}
1311
Gilles Peskine91e8c332019-08-02 19:19:39 +02001312#if defined(static_assert)
1313static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1314 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001315static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001316 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001317static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001318 "One or more key attribute flag is listed as both internal-only and external-only" );
1319#endif
1320
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001321/** Validate that a key policy is internally well-formed.
1322 *
1323 * This function only rejects invalid policies. It does not validate the
1324 * consistency of the policy with respect to other attributes of the key
1325 * such as the key type.
1326 */
1327static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001328{
1329 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001330 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001331 PSA_KEY_USAGE_ENCRYPT |
1332 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001333 PSA_KEY_USAGE_SIGN_HASH |
1334 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001335 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1336 return( PSA_ERROR_INVALID_ARGUMENT );
1337
Gilles Peskine4747d192019-04-17 15:05:45 +02001338 return( PSA_SUCCESS );
1339}
1340
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001341/** Validate the internal consistency of key attributes.
1342 *
1343 * This function only rejects invalid attribute values. If does not
1344 * validate the consistency of the attributes with any key data that may
1345 * be involved in the creation of the key.
1346 *
1347 * Call this function early in the key creation process.
1348 *
1349 * \param[in] attributes Key attributes for the new key.
1350 * \param[out] p_drv On any return, the driver for the key, if any.
1351 * NULL for a transparent key.
1352 *
1353 */
1354static psa_status_t psa_validate_key_attributes(
1355 const psa_key_attributes_t *attributes,
1356 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001357{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001358 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001359 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001360 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001361
Ronald Cron54b90082020-10-29 15:26:43 +01001362 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001363 if( status != PSA_SUCCESS )
1364 return( status );
1365
Ronald Crond2ed4812020-07-17 16:11:30 +02001366 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001367 if( status != PSA_SUCCESS )
1368 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001369
Ronald Cron65f38a32020-10-23 17:11:13 +02001370 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1371 {
1372 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1373 return( PSA_ERROR_INVALID_ARGUMENT );
1374 }
1375 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001376 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001377 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001378 if( status != PSA_SUCCESS )
1379 return( status );
1380 }
1381
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001382 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001383 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001384 return( status );
1385
1386 /* Refuse to create overly large keys.
1387 * Note that this doesn't trigger on import if the attributes don't
1388 * explicitly specify a size (so psa_get_key_bits returns 0), so
1389 * psa_import_key() needs its own checks. */
1390 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1391 return( PSA_ERROR_NOT_SUPPORTED );
1392
Gilles Peskine91e8c332019-08-02 19:19:39 +02001393 /* Reject invalid flags. These should not be reachable through the API. */
1394 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1395 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1396 return( PSA_ERROR_INVALID_ARGUMENT );
1397
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001398 return( PSA_SUCCESS );
1399}
1400
Gilles Peskine4747d192019-04-17 15:05:45 +02001401/** Prepare a key slot to receive key material.
1402 *
1403 * This function allocates a key slot and sets its metadata.
1404 *
1405 * If this function fails, call psa_fail_key_creation().
1406 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001407 * This function is intended to be used as follows:
1408 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001409 * it with the specified attributes, and in case of a volatile key assign it
1410 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001411 * -# Populate the slot with the key material.
1412 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1413 * In case of failure at any step, stop the sequence and call
1414 * psa_fail_key_creation().
1415 *
Ronald Cron5c522922020-11-14 16:35:34 +01001416 * On success, the key slot is locked. It is the responsibility of the caller
1417 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001418 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001419 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001420 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001421 * \param[out] p_slot On success, a pointer to the prepared slot.
1422 * \param[out] p_drv On any return, the driver for the key, if any.
1423 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001424 *
1425 * \retval #PSA_SUCCESS
1426 * The key slot is ready to receive key material.
1427 * \return If this function fails, the key slot is an invalid state.
1428 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001429 */
1430static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001431 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001432 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001433 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001434 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001435{
1436 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001437 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001438 psa_key_slot_t *slot;
1439
Gilles Peskinedf179142019-07-15 22:02:14 +02001440 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001441 *p_drv = NULL;
1442
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001443 status = psa_validate_key_attributes( attributes, p_drv );
1444 if( status != PSA_SUCCESS )
1445 return( status );
1446
Ronald Cronc4d1b512020-07-31 11:26:37 +02001447 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001448 if( status != PSA_SUCCESS )
1449 return( status );
1450 slot = *p_slot;
1451
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001452 /* We're storing the declared bit-size of the key. It's up to each
1453 * creation mechanism to verify that this information is correct.
1454 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001455 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001456 * is optional (import, copy). In case of a volatile key, assign it the
1457 * volatile key identifier associated to the slot returned to contain its
1458 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001459
1460 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001461 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1462 {
1463#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1464 slot->attr.id = volatile_key_id;
1465#else
1466 slot->attr.id.key_id = volatile_key_id;
1467#endif
1468 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001469
Gilles Peskine91e8c332019-08-02 19:19:39 +02001470 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001471 * external-only flags, query `attributes`. Thanks to the check
1472 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001473 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001474 * may have set. */
1475 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001476
Gilles Peskinecbaff462019-07-12 23:46:04 +02001477#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001478 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001479 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001480 * create the key file in internal storage, create the
1481 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001482 * persistent data. This is done by starting a transaction that will
1483 * encompass these three actions.
1484 * For registering a volatile key, we just need to find an appropriate
1485 * slot number inside the SE. Since the key is designated volatile, creating
1486 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001487 /* The first thing to do is to find a slot number for the new key.
1488 * We save the slot number in persistent storage as part of the
1489 * transaction data. It will be needed to recover if the power
1490 * fails during the key creation process, to clean up on the secure
1491 * element side after restarting. Obtaining a slot number from the
1492 * secure element driver updates its persistent state, but we do not yet
1493 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001494 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001495 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001496 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001497 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001498 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001499 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001500 if( status != PSA_SUCCESS )
1501 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001502
1503 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001504 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001505 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1506 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001507 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001508 psa_crypto_transaction.key.id = slot->attr.id;
1509 status = psa_crypto_save_transaction( );
1510 if( status != PSA_SUCCESS )
1511 {
1512 (void) psa_crypto_stop_transaction( );
1513 return( status );
1514 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001515 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001516
1517 status = psa_copy_key_material_into_slot(
1518 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001519 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001520
1521 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1522 {
1523 /* Key registration only makes sense with a secure element. */
1524 return( PSA_ERROR_INVALID_ARGUMENT );
1525 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001526#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1527
Ronald Cronc4d1b512020-07-31 11:26:37 +02001528 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001529}
Gilles Peskine4747d192019-04-17 15:05:45 +02001530
1531/** Finalize the creation of a key once its key material has been set.
1532 *
1533 * This entails writing the key to persistent storage.
1534 *
1535 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001536 * See the documentation of psa_start_key_creation() for the intended use
1537 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001538 *
Ronald Cron5c522922020-11-14 16:35:34 +01001539 * If the finalization succeeds, the function unlocks the key slot (it was
1540 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1541 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001542 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001543 * \param[in,out] slot Pointer to the slot with key material.
1544 * \param[in] driver The secure element driver for the key,
1545 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001546 * \param[out] key On success, identifier of the key. Note that the
1547 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001548 *
1549 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001550 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001551 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1552 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1553 * \retval #PSA_ERROR_ALREADY_EXISTS
1554 * \retval #PSA_ERROR_DATA_INVALID
1555 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001556 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001557 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001558 * \return If this function fails, the key slot is an invalid state.
1559 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001560 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001561static psa_status_t psa_finish_key_creation(
1562 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001563 psa_se_drv_table_entry_t *driver,
1564 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001565{
1566 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001567 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001568 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001569
1570#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001571 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001572 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001573#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1574 if( driver != NULL )
1575 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001576 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001577 psa_key_slot_number_t slot_number =
1578 psa_key_slot_get_slot_number( slot ) ;
1579
Gilles Peskineb46bef22019-07-30 21:32:04 +02001580#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001581 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001582 sizeof( data.slot_number ),
1583 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001584#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001585 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001586 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001587 (uint8_t*) &data,
1588 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001589 }
1590 else
1591#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1592 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001593 /* Key material is saved in export representation in the slot, so
1594 * just pass the slot buffer for storage. */
1595 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001596 slot->key.data,
1597 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001598 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001599 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001600#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1601
Gilles Peskinecbaff462019-07-12 23:46:04 +02001602#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001603 /* Finish the transaction for a key creation. This does not
1604 * happen when registering an existing key. Detect this case
1605 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001606 * creation of a persistent key in a secure element requires a transaction,
1607 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001608 if( driver != NULL &&
1609 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001610 {
1611 status = psa_save_se_persistent_data( driver );
1612 if( status != PSA_SUCCESS )
1613 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001614 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001615 return( status );
1616 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001617 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001618 }
1619#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1620
Ronald Cron50972942020-11-14 11:28:25 +01001621 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001622 {
1623 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001624 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001625 if( status != PSA_SUCCESS )
1626 *key = MBEDTLS_SVC_KEY_ID_INIT;
1627 }
Ronald Cron50972942020-11-14 11:28:25 +01001628
Gilles Peskine4747d192019-04-17 15:05:45 +02001629 return( status );
1630}
1631
1632/** Abort the creation of a key.
1633 *
1634 * You may call this function after calling psa_start_key_creation(),
1635 * or after psa_finish_key_creation() fails. In other circumstances, this
1636 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001637 * See the documentation of psa_start_key_creation() for the intended use
1638 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001639 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001640 * \param[in,out] slot Pointer to the slot with key material.
1641 * \param[in] driver The secure element driver for the key,
1642 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001643 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001644static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001645 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001646{
Gilles Peskine011e4282019-06-26 18:34:38 +02001647 (void) driver;
1648
Gilles Peskine4747d192019-04-17 15:05:45 +02001649 if( slot == NULL )
1650 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001651
1652#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001653 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 * element, and the failure happened later (when saving metadata
1655 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001656 * element.
1657 * https://github.com/ARMmbed/mbed-crypto/issues/217
1658 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001659
Gilles Peskined7729582019-08-05 15:55:54 +02001660 /* Abort the ongoing transaction if any (there may not be one if
1661 * the creation process failed before starting one, or if the
1662 * key creation is a registration of a key in a secure element).
1663 * Earlier functions must already have done what it takes to undo any
1664 * partial creation. All that's left is to update the transaction data
1665 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001666 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001667#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1668
Gilles Peskine4747d192019-04-17 15:05:45 +02001669 psa_wipe_key_slot( slot );
1670}
1671
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001672/** Validate optional attributes during key creation.
1673 *
1674 * Some key attributes are optional during key creation. If they are
1675 * specified in the attributes structure, check that they are consistent
1676 * with the data in the slot.
1677 *
1678 * This function should be called near the end of key creation, after
1679 * the slot in memory is fully populated but before saving persistent data.
1680 */
1681static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001682 const psa_key_slot_t *slot,
1683 const psa_key_attributes_t *attributes )
1684{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001685 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001686 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001687 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001688 return( PSA_ERROR_INVALID_ARGUMENT );
1689 }
1690
1691 if( attributes->domain_parameters_size != 0 )
1692 {
John Durkop0e005192020-10-31 22:06:54 -07001693#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1694 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001695 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001696 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001697 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001698 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001700
Ronald Cron90857082020-11-25 14:58:33 +01001701 psa_status_t status = mbedtls_psa_rsa_load_representation(
1702 slot->attr.type,
1703 slot->key.data,
1704 slot->key.bytes,
1705 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001706 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001707 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001708
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001709 mbedtls_mpi_init( &actual );
1710 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001711 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001712 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001713 mbedtls_rsa_free( rsa );
1714 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001715 if( ret != 0 )
1716 goto rsa_exit;
1717 ret = mbedtls_mpi_read_binary( &required,
1718 attributes->domain_parameters,
1719 attributes->domain_parameters_size );
1720 if( ret != 0 )
1721 goto rsa_exit;
1722 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1723 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1724 rsa_exit:
1725 mbedtls_mpi_free( &actual );
1726 mbedtls_mpi_free( &required );
1727 if( ret != 0)
1728 return( mbedtls_to_psa_error( ret ) );
1729 }
1730 else
John Durkop9814fa22020-11-04 12:28:15 -08001731#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1732 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001733 {
1734 return( PSA_ERROR_INVALID_ARGUMENT );
1735 }
1736 }
1737
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001738 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001739 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001740 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001741 return( PSA_ERROR_INVALID_ARGUMENT );
1742 }
1743
1744 return( PSA_SUCCESS );
1745}
1746
Gilles Peskine4747d192019-04-17 15:05:45 +02001747psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001748 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001749 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001750 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001751{
1752 psa_status_t status;
1753 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001754 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001755 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001756
Ronald Cron81709fc2020-11-14 12:10:32 +01001757 *key = MBEDTLS_SVC_KEY_ID_INIT;
1758
Gilles Peskine0f84d622019-09-12 19:03:13 +02001759 /* Reject zero-length symmetric keys (including raw data key objects).
1760 * This also rejects any key which might be encoded as an empty string,
1761 * which is never valid. */
1762 if( data_length == 0 )
1763 return( PSA_ERROR_INVALID_ARGUMENT );
1764
Gilles Peskinedf179142019-07-15 22:02:14 +02001765 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001766 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001767 if( status != PSA_SUCCESS )
1768 goto exit;
1769
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001770 /* In the case of a transparent key or an opaque key stored in local
1771 * storage (thus not in the case of generating a key in a secure element
1772 * or cryptoprocessor with storage), we have to allocate a buffer to
1773 * hold the generated key material. */
1774 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001775 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001776 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001777 if( status != PSA_SUCCESS )
1778 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001779 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001780
1781 bits = slot->attr.bits;
1782 status = psa_driver_wrapper_import_key( attributes,
1783 data, data_length,
1784 slot->key.data,
1785 slot->key.bytes,
1786 &slot->key.bytes, &bits );
1787 if( status != PSA_SUCCESS )
1788 goto exit;
1789
1790 if( slot->attr.bits == 0 )
1791 slot->attr.bits = (psa_key_bits_t) bits;
1792 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001793 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001794 status = PSA_ERROR_INVALID_ARGUMENT;
1795 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001796 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001797
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001798 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001799 if( status != PSA_SUCCESS )
1800 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001801
Ronald Cron81709fc2020-11-14 12:10:32 +01001802 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001803exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001804 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001805 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001806
Gilles Peskine4747d192019-04-17 15:05:45 +02001807 return( status );
1808}
1809
Gilles Peskined7729582019-08-05 15:55:54 +02001810#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1811psa_status_t mbedtls_psa_register_se_key(
1812 const psa_key_attributes_t *attributes )
1813{
1814 psa_status_t status;
1815 psa_key_slot_t *slot = NULL;
1816 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001817 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001818
1819 /* Leaving attributes unspecified is not currently supported.
1820 * It could make sense to query the key type and size from the
1821 * secure element, but not all secure elements support this
1822 * and the driver HAL doesn't currently support it. */
1823 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1824 return( PSA_ERROR_NOT_SUPPORTED );
1825 if( psa_get_key_bits( attributes ) == 0 )
1826 return( PSA_ERROR_NOT_SUPPORTED );
1827
1828 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001829 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001830 if( status != PSA_SUCCESS )
1831 goto exit;
1832
Ronald Cron81709fc2020-11-14 12:10:32 +01001833 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001834
1835exit:
1836 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001837 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001838
Gilles Peskined7729582019-08-05 15:55:54 +02001839 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001840 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001841 return( status );
1842}
1843#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1844
Gilles Peskinef603c712019-01-19 13:40:11 +01001845static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001846 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001847{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001848 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001849 source->key.data,
1850 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001851 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001852 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001853
Steven Cooreman398aee52020-10-13 14:35:45 +02001854 target->attr.type = source->attr.type;
1855 target->attr.bits = source->attr.bits;
1856
1857 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01001858}
1859
Ronald Croncf56a0a2020-08-04 09:51:30 +02001860psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001861 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001862 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01001863{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001864 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001865 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01001866 psa_key_slot_t *source_slot = NULL;
1867 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001868 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001869 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001870
Ronald Cron81709fc2020-11-14 12:10:32 +01001871 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
1872
Ronald Cron5c522922020-11-14 16:35:34 +01001873 status = psa_get_and_lock_transparent_key_slot_with_policy(
1874 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001875 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001876 goto exit;
1877
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001878 status = psa_validate_optional_attributes( source_slot,
1879 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001880 if( status != PSA_SUCCESS )
1881 goto exit;
1882
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001883 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001884 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001885 if( status != PSA_SUCCESS )
1886 goto exit;
1887
Ronald Cron81709fc2020-11-14 12:10:32 +01001888 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
1889 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001890 if( status != PSA_SUCCESS )
1891 goto exit;
1892
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001893#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1894 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01001895 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001896 /* Copying to a secure element is not implemented yet. */
1897 status = PSA_ERROR_NOT_SUPPORTED;
1898 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001899 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001900#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01001901
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001902 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01001903 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001905
Ronald Cron81709fc2020-11-14 12:10:32 +01001906 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001907exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001908 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001909 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001910
Ronald Cron5c522922020-11-14 16:35:34 +01001911 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001912
Ronald Cron5c522922020-11-14 16:35:34 +01001913 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001914}
1915
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001916
1917
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001918/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001919/* Message digests */
1920/****************************************************************/
1921
John Durkop07cc04a2020-11-16 22:08:34 -08001922#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07001923 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
1924 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08001925 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Ronald Cron36f641b2021-02-16 17:20:43 +01001926const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001927{
1928 switch( alg )
1929 {
John Durkopee4e6602020-11-27 08:48:46 -08001930#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01001931 case PSA_ALG_MD2:
1932 return( &mbedtls_md2_info );
1933#endif
John Durkopee4e6602020-11-27 08:48:46 -08001934#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01001935 case PSA_ALG_MD4:
1936 return( &mbedtls_md4_info );
1937#endif
John Durkopee4e6602020-11-27 08:48:46 -08001938#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01001939 case PSA_ALG_MD5:
1940 return( &mbedtls_md5_info );
1941#endif
John Durkopee4e6602020-11-27 08:48:46 -08001942#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01001943 case PSA_ALG_RIPEMD160:
1944 return( &mbedtls_ripemd160_info );
1945#endif
John Durkopee4e6602020-11-27 08:48:46 -08001946#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01001947 case PSA_ALG_SHA_1:
1948 return( &mbedtls_sha1_info );
1949#endif
John Durkopee4e6602020-11-27 08:48:46 -08001950#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01001951 case PSA_ALG_SHA_224:
1952 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08001953#endif
1954#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01001955 case PSA_ALG_SHA_256:
1956 return( &mbedtls_sha256_info );
1957#endif
John Durkopee4e6602020-11-27 08:48:46 -08001958#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01001959 case PSA_ALG_SHA_384:
1960 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02001961#endif
John Durkopee4e6602020-11-27 08:48:46 -08001962#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01001963 case PSA_ALG_SHA_512:
1964 return( &mbedtls_sha512_info );
1965#endif
1966 default:
1967 return( NULL );
1968 }
1969}
John Durkop07cc04a2020-11-16 22:08:34 -08001970#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08001971 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
1972 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
1973 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01001974
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001975psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
1976{
1977 switch( operation->alg )
1978 {
Gilles Peskine81736312018-06-26 15:04:31 +02001979 case 0:
1980 /* The object has (apparently) been initialized but it is not
1981 * in use. It's ok to call abort on such an object, and there's
1982 * nothing to do. */
1983 break;
John Durkopee4e6602020-11-27 08:48:46 -08001984#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001985 case PSA_ALG_MD2:
1986 mbedtls_md2_free( &operation->ctx.md2 );
1987 break;
1988#endif
John Durkopee4e6602020-11-27 08:48:46 -08001989#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001990 case PSA_ALG_MD4:
1991 mbedtls_md4_free( &operation->ctx.md4 );
1992 break;
1993#endif
John Durkopee4e6602020-11-27 08:48:46 -08001994#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01001995 case PSA_ALG_MD5:
1996 mbedtls_md5_free( &operation->ctx.md5 );
1997 break;
1998#endif
John Durkopee4e6602020-11-27 08:48:46 -08001999#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002000 case PSA_ALG_RIPEMD160:
2001 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2002 break;
2003#endif
John Durkopee4e6602020-11-27 08:48:46 -08002004#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002005 case PSA_ALG_SHA_1:
2006 mbedtls_sha1_free( &operation->ctx.sha1 );
2007 break;
2008#endif
John Durkop6ca23272020-12-03 06:01:32 -08002009#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002010 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002011 mbedtls_sha256_free( &operation->ctx.sha256 );
2012 break;
2013#endif
2014#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002015 case PSA_ALG_SHA_256:
2016 mbedtls_sha256_free( &operation->ctx.sha256 );
2017 break;
2018#endif
John Durkop6ca23272020-12-03 06:01:32 -08002019#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002020 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002021 mbedtls_sha512_free( &operation->ctx.sha512 );
2022 break;
2023#endif
2024#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002025 case PSA_ALG_SHA_512:
2026 mbedtls_sha512_free( &operation->ctx.sha512 );
2027 break;
2028#endif
2029 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002030 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002031 }
2032 operation->alg = 0;
2033 return( PSA_SUCCESS );
2034}
2035
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002036psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002037 psa_algorithm_t alg )
2038{
Janos Follath24eed8d2019-11-22 13:21:35 +00002039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002040
2041 /* A context must be freshly initialized before it can be set up. */
2042 if( operation->alg != 0 )
2043 {
2044 return( PSA_ERROR_BAD_STATE );
2045 }
2046
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002047 switch( alg )
2048 {
John Durkopee4e6602020-11-27 08:48:46 -08002049#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002050 case PSA_ALG_MD2:
2051 mbedtls_md2_init( &operation->ctx.md2 );
2052 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2053 break;
2054#endif
John Durkopee4e6602020-11-27 08:48:46 -08002055#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002056 case PSA_ALG_MD4:
2057 mbedtls_md4_init( &operation->ctx.md4 );
2058 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2059 break;
2060#endif
John Durkopee4e6602020-11-27 08:48:46 -08002061#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002062 case PSA_ALG_MD5:
2063 mbedtls_md5_init( &operation->ctx.md5 );
2064 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2065 break;
2066#endif
John Durkopee4e6602020-11-27 08:48:46 -08002067#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002068 case PSA_ALG_RIPEMD160:
2069 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2070 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2071 break;
2072#endif
John Durkopee4e6602020-11-27 08:48:46 -08002073#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002074 case PSA_ALG_SHA_1:
2075 mbedtls_sha1_init( &operation->ctx.sha1 );
2076 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2077 break;
2078#endif
John Durkopee4e6602020-11-27 08:48:46 -08002079#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002080 case PSA_ALG_SHA_224:
2081 mbedtls_sha256_init( &operation->ctx.sha256 );
2082 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2083 break;
John Durkopee4e6602020-11-27 08:48:46 -08002084#endif
2085#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002086 case PSA_ALG_SHA_256:
2087 mbedtls_sha256_init( &operation->ctx.sha256 );
2088 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2089 break;
2090#endif
John Durkopee4e6602020-11-27 08:48:46 -08002091#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002092 case PSA_ALG_SHA_384:
2093 mbedtls_sha512_init( &operation->ctx.sha512 );
2094 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2095 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002096#endif
John Durkopee4e6602020-11-27 08:48:46 -08002097#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098 case PSA_ALG_SHA_512:
2099 mbedtls_sha512_init( &operation->ctx.sha512 );
2100 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2101 break;
2102#endif
2103 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002104 return( PSA_ALG_IS_HASH( alg ) ?
2105 PSA_ERROR_NOT_SUPPORTED :
2106 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002107 }
2108 if( ret == 0 )
2109 operation->alg = alg;
2110 else
2111 psa_hash_abort( operation );
2112 return( mbedtls_to_psa_error( ret ) );
2113}
2114
2115psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2116 const uint8_t *input,
2117 size_t input_length )
2118{
Janos Follath24eed8d2019-11-22 13:21:35 +00002119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002120
2121 /* Don't require hash implementations to behave correctly on a
2122 * zero-length input, which may have an invalid pointer. */
2123 if( input_length == 0 )
2124 return( PSA_SUCCESS );
2125
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002126 switch( operation->alg )
2127 {
John Durkopee4e6602020-11-27 08:48:46 -08002128#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002129 case PSA_ALG_MD2:
2130 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2131 input, input_length );
2132 break;
2133#endif
John Durkopee4e6602020-11-27 08:48:46 -08002134#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002135 case PSA_ALG_MD4:
2136 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2137 input, input_length );
2138 break;
2139#endif
John Durkopee4e6602020-11-27 08:48:46 -08002140#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002141 case PSA_ALG_MD5:
2142 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2143 input, input_length );
2144 break;
2145#endif
John Durkopee4e6602020-11-27 08:48:46 -08002146#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147 case PSA_ALG_RIPEMD160:
2148 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2149 input, input_length );
2150 break;
2151#endif
John Durkopee4e6602020-11-27 08:48:46 -08002152#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002153 case PSA_ALG_SHA_1:
2154 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2155 input, input_length );
2156 break;
2157#endif
John Durkop6ca23272020-12-03 06:01:32 -08002158#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002159 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002160 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2161 input, input_length );
2162 break;
2163#endif
2164#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002165 case PSA_ALG_SHA_256:
2166 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2167 input, input_length );
2168 break;
2169#endif
John Durkop6ca23272020-12-03 06:01:32 -08002170#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002171 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002172 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2173 input, input_length );
2174 break;
2175#endif
2176#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 case PSA_ALG_SHA_512:
2178 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2179 input, input_length );
2180 break;
2181#endif
2182 default:
John Durkopee4e6602020-11-27 08:48:46 -08002183 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002184 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002185 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002186
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187 if( ret != 0 )
2188 psa_hash_abort( operation );
2189 return( mbedtls_to_psa_error( ret ) );
2190}
2191
2192psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2193 uint8_t *hash,
2194 size_t hash_size,
2195 size_t *hash_length )
2196{
itayzafrir40835d42018-08-02 13:14:17 +03002197 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002198 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002199 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002200
2201 /* Fill the output buffer with something that isn't a valid hash
2202 * (barring an attack on the hash and deliberately-crafted input),
2203 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002204 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002205 /* If hash_size is 0 then hash may be NULL and then the
2206 * call to memset would have undefined behavior. */
2207 if( hash_size != 0 )
2208 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002209
2210 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002211 {
2212 status = PSA_ERROR_BUFFER_TOO_SMALL;
2213 goto exit;
2214 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002215
2216 switch( operation->alg )
2217 {
John Durkopee4e6602020-11-27 08:48:46 -08002218#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219 case PSA_ALG_MD2:
2220 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2221 break;
2222#endif
John Durkopee4e6602020-11-27 08:48:46 -08002223#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002224 case PSA_ALG_MD4:
2225 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2226 break;
2227#endif
John Durkopee4e6602020-11-27 08:48:46 -08002228#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002229 case PSA_ALG_MD5:
2230 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2231 break;
2232#endif
John Durkopee4e6602020-11-27 08:48:46 -08002233#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002234 case PSA_ALG_RIPEMD160:
2235 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2236 break;
2237#endif
John Durkopee4e6602020-11-27 08:48:46 -08002238#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002239 case PSA_ALG_SHA_1:
2240 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2241 break;
2242#endif
John Durkop6ca23272020-12-03 06:01:32 -08002243#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002245 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2246 break;
2247#endif
2248#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002249 case PSA_ALG_SHA_256:
2250 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2251 break;
2252#endif
John Durkop6ca23272020-12-03 06:01:32 -08002253#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002254 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002255 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2256 break;
2257#endif
2258#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259 case PSA_ALG_SHA_512:
2260 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2261 break;
2262#endif
2263 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002264 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265 }
itayzafrir40835d42018-08-02 13:14:17 +03002266 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002267
itayzafrir40835d42018-08-02 13:14:17 +03002268exit:
2269 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002271 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002272 return( psa_hash_abort( operation ) );
2273 }
2274 else
2275 {
2276 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002277 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278 }
2279}
2280
Gilles Peskine2d277862018-06-18 15:41:12 +02002281psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2282 const uint8_t *hash,
2283 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002284{
2285 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2286 size_t actual_hash_length;
2287 psa_status_t status = psa_hash_finish( operation,
2288 actual_hash, sizeof( actual_hash ),
2289 &actual_hash_length );
2290 if( status != PSA_SUCCESS )
2291 return( status );
2292 if( actual_hash_length != hash_length )
2293 return( PSA_ERROR_INVALID_SIGNATURE );
2294 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2295 return( PSA_ERROR_INVALID_SIGNATURE );
2296 return( PSA_SUCCESS );
2297}
2298
Gilles Peskine0a749c82019-11-28 19:33:58 +01002299psa_status_t psa_hash_compute( psa_algorithm_t alg,
2300 const uint8_t *input, size_t input_length,
2301 uint8_t *hash, size_t hash_size,
2302 size_t *hash_length )
2303{
2304 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2305 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2306
2307 *hash_length = hash_size;
2308 status = psa_hash_setup( &operation, alg );
2309 if( status != PSA_SUCCESS )
2310 goto exit;
2311 status = psa_hash_update( &operation, input, input_length );
2312 if( status != PSA_SUCCESS )
2313 goto exit;
2314 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2315 if( status != PSA_SUCCESS )
2316 goto exit;
2317
2318exit:
2319 if( status == PSA_SUCCESS )
2320 status = psa_hash_abort( &operation );
2321 else
2322 psa_hash_abort( &operation );
2323 return( status );
2324}
2325
2326psa_status_t psa_hash_compare( psa_algorithm_t alg,
2327 const uint8_t *input, size_t input_length,
2328 const uint8_t *hash, size_t hash_length )
2329{
2330 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2331 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2332
2333 status = psa_hash_setup( &operation, alg );
2334 if( status != PSA_SUCCESS )
2335 goto exit;
2336 status = psa_hash_update( &operation, input, input_length );
2337 if( status != PSA_SUCCESS )
2338 goto exit;
2339 status = psa_hash_verify( &operation, hash, hash_length );
2340 if( status != PSA_SUCCESS )
2341 goto exit;
2342
2343exit:
2344 if( status == PSA_SUCCESS )
2345 status = psa_hash_abort( &operation );
2346 else
2347 psa_hash_abort( &operation );
2348 return( status );
2349}
2350
Gilles Peskineeb35d782019-01-22 17:56:16 +01002351psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2352 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002353{
2354 if( target_operation->alg != 0 )
2355 return( PSA_ERROR_BAD_STATE );
2356
2357 switch( source_operation->alg )
2358 {
2359 case 0:
2360 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002361#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002362 case PSA_ALG_MD2:
2363 mbedtls_md2_clone( &target_operation->ctx.md2,
2364 &source_operation->ctx.md2 );
2365 break;
2366#endif
John Durkopee4e6602020-11-27 08:48:46 -08002367#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002368 case PSA_ALG_MD4:
2369 mbedtls_md4_clone( &target_operation->ctx.md4,
2370 &source_operation->ctx.md4 );
2371 break;
2372#endif
John Durkopee4e6602020-11-27 08:48:46 -08002373#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002374 case PSA_ALG_MD5:
2375 mbedtls_md5_clone( &target_operation->ctx.md5,
2376 &source_operation->ctx.md5 );
2377 break;
2378#endif
John Durkopee4e6602020-11-27 08:48:46 -08002379#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002380 case PSA_ALG_RIPEMD160:
2381 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2382 &source_operation->ctx.ripemd160 );
2383 break;
2384#endif
John Durkopee4e6602020-11-27 08:48:46 -08002385#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002386 case PSA_ALG_SHA_1:
2387 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2388 &source_operation->ctx.sha1 );
2389 break;
2390#endif
John Durkop6ca23272020-12-03 06:01:32 -08002391#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002392 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002393 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2394 &source_operation->ctx.sha256 );
2395 break;
2396#endif
2397#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002398 case PSA_ALG_SHA_256:
2399 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2400 &source_operation->ctx.sha256 );
2401 break;
2402#endif
John Durkop6ca23272020-12-03 06:01:32 -08002403#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002404 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002405 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2406 &source_operation->ctx.sha512 );
2407 break;
2408#endif
2409#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002410 case PSA_ALG_SHA_512:
2411 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2412 &source_operation->ctx.sha512 );
2413 break;
2414#endif
2415 default:
2416 return( PSA_ERROR_NOT_SUPPORTED );
2417 }
2418
2419 target_operation->alg = source_operation->alg;
2420 return( PSA_SUCCESS );
2421}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002422
2423
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002424/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425/* MAC */
2426/****************************************************************/
2427
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002428static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002429 psa_algorithm_t alg,
2430 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002431 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002432 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002434 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002435 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002436
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002437 if( PSA_ALG_IS_AEAD( alg ) )
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002438 alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002439
Gilles Peskine8c9def32018-02-08 10:02:12 +01002440 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2441 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002442 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002443 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002444 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002445 mode = MBEDTLS_MODE_STREAM;
2446 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002447 case PSA_ALG_CTR:
2448 mode = MBEDTLS_MODE_CTR;
2449 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002450 case PSA_ALG_CFB:
2451 mode = MBEDTLS_MODE_CFB;
2452 break;
2453 case PSA_ALG_OFB:
2454 mode = MBEDTLS_MODE_OFB;
2455 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002456 case PSA_ALG_ECB_NO_PADDING:
2457 mode = MBEDTLS_MODE_ECB;
2458 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002459 case PSA_ALG_CBC_NO_PADDING:
2460 mode = MBEDTLS_MODE_CBC;
2461 break;
2462 case PSA_ALG_CBC_PKCS7:
2463 mode = MBEDTLS_MODE_CBC;
2464 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002465 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002466 mode = MBEDTLS_MODE_CCM;
2467 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002468 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002469 mode = MBEDTLS_MODE_GCM;
2470 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002471 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02002472 mode = MBEDTLS_MODE_CHACHAPOLY;
2473 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002474 default:
2475 return( NULL );
2476 }
2477 }
2478 else if( alg == PSA_ALG_CMAC )
2479 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002480 else
2481 return( NULL );
2482
2483 switch( key_type )
2484 {
2485 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002486 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487 break;
2488 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002489 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2490 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002491 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002492 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002494 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002495 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2496 * but two-key Triple-DES is functionally three-key Triple-DES
2497 * with K1=K3, so that's how we present it to mbedtls. */
2498 if( key_bits == 128 )
2499 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002500 break;
2501 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002502 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002503 break;
2504 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002505 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002506 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002507 case PSA_KEY_TYPE_CHACHA20:
2508 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2509 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002510 default:
2511 return( NULL );
2512 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002513 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002514 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515
Jaeden Amero23bbb752018-06-26 14:16:54 +01002516 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2517 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002518}
2519
John Durkop6ba40d12020-11-10 08:50:04 -08002520#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002521static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002522{
Gilles Peskine2d277862018-06-18 15:41:12 +02002523 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002524 {
2525 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002526 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002527 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002528 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002529 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002530 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002531 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002532 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002533 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002534 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002535 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002536 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002537 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002538 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002539 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002540 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002541 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002542 return( 128 );
2543 default:
2544 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002545 }
2546}
John Durkop07cc04a2020-11-16 22:08:34 -08002547#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002548
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002549/* Initialize the MAC operation structure. Once this function has been
2550 * called, psa_mac_abort can run and will do the right thing. */
2551static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2552 psa_algorithm_t alg )
2553{
2554 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2555
2556 operation->alg = alg;
2557 operation->key_set = 0;
2558 operation->iv_set = 0;
2559 operation->iv_required = 0;
2560 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002561 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002562
2563#if defined(MBEDTLS_CMAC_C)
2564 if( alg == PSA_ALG_CMAC )
2565 {
2566 operation->iv_required = 0;
2567 mbedtls_cipher_init( &operation->ctx.cmac );
2568 status = PSA_SUCCESS;
2569 }
2570 else
2571#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002572#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002573 if( PSA_ALG_IS_HMAC( operation->alg ) )
2574 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002575 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2576 operation->ctx.hmac.hash_ctx.alg = 0;
2577 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002578 }
2579 else
John Durkopd0321952020-10-29 21:37:36 -07002580#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002581 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002582 if( ! PSA_ALG_IS_MAC( alg ) )
2583 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002584 }
2585
2586 if( status != PSA_SUCCESS )
2587 memset( operation, 0, sizeof( *operation ) );
2588 return( status );
2589}
2590
John Durkop6ba40d12020-11-10 08:50:04 -08002591#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002592static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2593{
Gilles Peskine3f108122018-12-07 18:14:53 +01002594 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002595 return( psa_hash_abort( &hmac->hash_ctx ) );
2596}
John Durkop6ba40d12020-11-10 08:50:04 -08002597#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002598
Gilles Peskine8c9def32018-02-08 10:02:12 +01002599psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2600{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002601 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002602 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002603 /* The object has (apparently) been initialized but it is not
2604 * in use. It's ok to call abort on such an object, and there's
2605 * nothing to do. */
2606 return( PSA_SUCCESS );
2607 }
2608 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002609#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002610 if( operation->alg == PSA_ALG_CMAC )
2611 {
2612 mbedtls_cipher_free( &operation->ctx.cmac );
2613 }
2614 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002615#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002616#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002617 if( PSA_ALG_IS_HMAC( operation->alg ) )
2618 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002619 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002620 }
2621 else
John Durkopd0321952020-10-29 21:37:36 -07002622#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002623 {
2624 /* Sanity check (shouldn't happen: operation->alg should
2625 * always have been initialized to a valid value). */
2626 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002627 }
Moran Peker41deec42018-04-04 15:43:05 +03002628
Gilles Peskine8c9def32018-02-08 10:02:12 +01002629 operation->alg = 0;
2630 operation->key_set = 0;
2631 operation->iv_set = 0;
2632 operation->iv_required = 0;
2633 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002634 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002635
Gilles Peskine8c9def32018-02-08 10:02:12 +01002636 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002637
2638bad_state:
2639 /* If abort is called on an uninitialized object, we can't trust
2640 * anything. Wipe the object in case it contains confidential data.
2641 * This may result in a memory leak if a pointer gets overwritten,
2642 * but it's too late to do anything about this. */
2643 memset( operation, 0, sizeof( *operation ) );
2644 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002645}
2646
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002647#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002648static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002649 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002650 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002651 const mbedtls_cipher_info_t *cipher_info )
2652{
Janos Follath24eed8d2019-11-22 13:21:35 +00002653 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002654
2655 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002656
2657 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2658 if( ret != 0 )
2659 return( ret );
2660
2661 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002662 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002663 key_bits );
2664 return( ret );
2665}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002666#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002667
John Durkop6ba40d12020-11-10 08:50:04 -08002668#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002669static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2670 const uint8_t *key,
2671 size_t key_length,
2672 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002673{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002674 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002675 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002676 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002677 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002678 psa_status_t status;
2679
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002680 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2681 * overflow below. This should never trigger if the hash algorithm
2682 * is implemented correctly. */
2683 /* The size checks against the ipad and opad buffers cannot be written
2684 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2685 * because that triggers -Wlogical-op on GCC 7.3. */
2686 if( block_size > sizeof( ipad ) )
2687 return( PSA_ERROR_NOT_SUPPORTED );
2688 if( block_size > sizeof( hmac->opad ) )
2689 return( PSA_ERROR_NOT_SUPPORTED );
2690 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002691 return( PSA_ERROR_NOT_SUPPORTED );
2692
Gilles Peskined223b522018-06-11 18:12:58 +02002693 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002694 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002695 status = psa_hash_compute( hash_alg, key, key_length,
2696 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002697 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002698 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002699 }
Gilles Peskine96889972018-07-12 17:07:03 +02002700 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2701 * but it is permitted. It is common when HMAC is used in HKDF, for
2702 * example. Don't call `memcpy` in the 0-length because `key` could be
2703 * an invalid pointer which would make the behavior undefined. */
2704 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002705 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002706
Gilles Peskined223b522018-06-11 18:12:58 +02002707 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2708 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002709 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002710 ipad[i] ^= 0x36;
2711 memset( ipad + key_length, 0x36, block_size - key_length );
2712
2713 /* Copy the key material from ipad to opad, flipping the requisite bits,
2714 * and filling the rest of opad with the requisite constant. */
2715 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002716 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2717 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002718
Gilles Peskine01126fa2018-07-12 17:04:55 +02002719 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002720 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002721 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002722
Gilles Peskine01126fa2018-07-12 17:04:55 +02002723 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002724
2725cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002726 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002727
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002728 return( status );
2729}
John Durkop6ba40d12020-11-10 08:50:04 -08002730#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002731
Gilles Peskine89167cb2018-07-08 20:12:23 +02002732static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002733 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002734 psa_algorithm_t alg,
2735 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002736{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002737 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002738 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002739 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002741 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002742 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002743 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002744 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002745
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002746 /* A context must be freshly initialized before it can be set up. */
2747 if( operation->alg != 0 )
2748 {
2749 return( PSA_ERROR_BAD_STATE );
2750 }
2751
Gilles Peskined911eb72018-08-14 15:18:45 +02002752 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002753 if( status != PSA_SUCCESS )
2754 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002755 if( is_sign )
2756 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002757
Ronald Cron5c522922020-11-14 16:35:34 +01002758 status = psa_get_and_lock_transparent_key_slot_with_policy(
2759 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002760 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002761 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002762 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002763
Gilles Peskine8c9def32018-02-08 10:02:12 +01002764#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002765 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002766 {
2767 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002768 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002769 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002770 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002771 if( cipher_info == NULL )
2772 {
2773 status = PSA_ERROR_NOT_SUPPORTED;
2774 goto exit;
2775 }
2776 operation->mac_size = cipher_info->block_size;
2777 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2778 status = mbedtls_to_psa_error( ret );
2779 }
2780 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002781#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002782#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02002783 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002784 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002785 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002786 if( hash_alg == 0 )
2787 {
2788 status = PSA_ERROR_NOT_SUPPORTED;
2789 goto exit;
2790 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002791
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002792 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002793 /* Sanity check. This shouldn't fail on a valid configuration. */
2794 if( operation->mac_size == 0 ||
2795 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2796 {
2797 status = PSA_ERROR_NOT_SUPPORTED;
2798 goto exit;
2799 }
2800
Gilles Peskine8e338702019-07-30 20:06:31 +02002801 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002802 {
2803 status = PSA_ERROR_INVALID_ARGUMENT;
2804 goto exit;
2805 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002806
Gilles Peskine01126fa2018-07-12 17:04:55 +02002807 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002808 slot->key.data,
2809 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02002810 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002811 }
2812 else
John Durkopd0321952020-10-29 21:37:36 -07002813#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002814 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002815 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002816 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002817 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002818
Gilles Peskined911eb72018-08-14 15:18:45 +02002819 if( truncated == 0 )
2820 {
2821 /* The "normal" case: untruncated algorithm. Nothing to do. */
2822 }
2823 else if( truncated < 4 )
2824 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002825 /* A very short MAC is too short for security since it can be
2826 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2827 * so we make this our minimum, even though 32 bits is still
2828 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002829 status = PSA_ERROR_NOT_SUPPORTED;
2830 }
2831 else if( truncated > operation->mac_size )
2832 {
2833 /* It's impossible to "truncate" to a larger length. */
2834 status = PSA_ERROR_INVALID_ARGUMENT;
2835 }
2836 else
2837 operation->mac_size = truncated;
2838
Gilles Peskinefbfac682018-07-08 20:51:54 +02002839exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002840 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002841 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002842 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002843 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002844 else
2845 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002846 operation->key_set = 1;
2847 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002848
Ronald Cron5c522922020-11-14 16:35:34 +01002849 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002850
Ronald Cron5c522922020-11-14 16:35:34 +01002851 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002852}
2853
Gilles Peskine89167cb2018-07-08 20:12:23 +02002854psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002855 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002856 psa_algorithm_t alg )
2857{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002858 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002859}
2860
2861psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002862 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002863 psa_algorithm_t alg )
2864{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002865 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002866}
2867
Gilles Peskine8c9def32018-02-08 10:02:12 +01002868psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2869 const uint8_t *input,
2870 size_t input_length )
2871{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002872 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002873 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002874 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002875 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002876 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002877 operation->has_input = 1;
2878
Gilles Peskine8c9def32018-02-08 10:02:12 +01002879#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002880 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002881 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002882 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2883 input, input_length );
2884 status = mbedtls_to_psa_error( ret );
2885 }
2886 else
2887#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002888#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002889 if( PSA_ALG_IS_HMAC( operation->alg ) )
2890 {
2891 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2892 input_length );
2893 }
2894 else
John Durkopd0321952020-10-29 21:37:36 -07002895#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002896 {
2897 /* This shouldn't happen if `operation` was initialized by
2898 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002899 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002900 }
2901
Gilles Peskinefbfac682018-07-08 20:51:54 +02002902 if( status != PSA_SUCCESS )
2903 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002904 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002905}
2906
John Durkop6ba40d12020-11-10 08:50:04 -08002907#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002908static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2909 uint8_t *mac,
2910 size_t mac_size )
2911{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002912 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002913 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2914 size_t hash_size = 0;
2915 size_t block_size = psa_get_hash_block_size( hash_alg );
2916 psa_status_t status;
2917
Gilles Peskine01126fa2018-07-12 17:04:55 +02002918 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2919 if( status != PSA_SUCCESS )
2920 return( status );
2921 /* From here on, tmp needs to be wiped. */
2922
2923 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2924 if( status != PSA_SUCCESS )
2925 goto exit;
2926
2927 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2928 if( status != PSA_SUCCESS )
2929 goto exit;
2930
2931 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2932 if( status != PSA_SUCCESS )
2933 goto exit;
2934
Gilles Peskined911eb72018-08-14 15:18:45 +02002935 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2936 if( status != PSA_SUCCESS )
2937 goto exit;
2938
2939 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002940
2941exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002942 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002943 return( status );
2944}
John Durkop6ba40d12020-11-10 08:50:04 -08002945#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002946
mohammad16036df908f2018-04-02 08:34:15 -07002947static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002948 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002949 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002950{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002951 if( ! operation->key_set )
2952 return( PSA_ERROR_BAD_STATE );
2953 if( operation->iv_required && ! operation->iv_set )
2954 return( PSA_ERROR_BAD_STATE );
2955
Gilles Peskine8c9def32018-02-08 10:02:12 +01002956 if( mac_size < operation->mac_size )
2957 return( PSA_ERROR_BUFFER_TOO_SMALL );
2958
Gilles Peskine8c9def32018-02-08 10:02:12 +01002959#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002960 if( operation->alg == PSA_ALG_CMAC )
2961 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002962 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002963 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2964 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002965 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002966 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002967 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002968 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002969 else
2970#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002971#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002972 if( PSA_ALG_IS_HMAC( operation->alg ) )
2973 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002974 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002975 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002976 }
2977 else
John Durkopd0321952020-10-29 21:37:36 -07002978#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002979 {
2980 /* This shouldn't happen if `operation` was initialized by
2981 * a setup function. */
2982 return( PSA_ERROR_BAD_STATE );
2983 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002984}
2985
Gilles Peskineacd4be32018-07-08 19:56:25 +02002986psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2987 uint8_t *mac,
2988 size_t mac_size,
2989 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002990{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002991 psa_status_t status;
2992
Jaeden Amero252ef282019-02-15 14:05:35 +00002993 if( operation->alg == 0 )
2994 {
2995 return( PSA_ERROR_BAD_STATE );
2996 }
2997
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002998 /* Fill the output buffer with something that isn't a valid mac
2999 * (barring an attack on the mac and deliberately-crafted input),
3000 * in case the caller doesn't check the return status properly. */
3001 *mac_length = mac_size;
3002 /* If mac_size is 0 then mac may be NULL and then the
3003 * call to memset would have undefined behavior. */
3004 if( mac_size != 0 )
3005 memset( mac, '!', mac_size );
3006
Gilles Peskine89167cb2018-07-08 20:12:23 +02003007 if( ! operation->is_sign )
3008 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003009 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003010 }
mohammad16036df908f2018-04-02 08:34:15 -07003011
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003012 status = psa_mac_finish_internal( operation, mac, mac_size );
3013
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003014 if( status == PSA_SUCCESS )
3015 {
3016 status = psa_mac_abort( operation );
3017 if( status == PSA_SUCCESS )
3018 *mac_length = operation->mac_size;
3019 else
3020 memset( mac, '!', mac_size );
3021 }
3022 else
3023 psa_mac_abort( operation );
3024 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003025}
3026
Gilles Peskineacd4be32018-07-08 19:56:25 +02003027psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3028 const uint8_t *mac,
3029 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003030{
Gilles Peskine828ed142018-06-18 23:25:51 +02003031 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003032 psa_status_t status;
3033
Jaeden Amero252ef282019-02-15 14:05:35 +00003034 if( operation->alg == 0 )
3035 {
3036 return( PSA_ERROR_BAD_STATE );
3037 }
3038
Gilles Peskine89167cb2018-07-08 20:12:23 +02003039 if( operation->is_sign )
3040 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003041 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003042 }
3043 if( operation->mac_size != mac_length )
3044 {
3045 status = PSA_ERROR_INVALID_SIGNATURE;
3046 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003047 }
mohammad16036df908f2018-04-02 08:34:15 -07003048
3049 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003050 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003051 if( status != PSA_SUCCESS )
3052 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003053
3054 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3055 status = PSA_ERROR_INVALID_SIGNATURE;
3056
3057cleanup:
3058 if( status == PSA_SUCCESS )
3059 status = psa_mac_abort( operation );
3060 else
3061 psa_mac_abort( operation );
3062
Gilles Peskine3f108122018-12-07 18:14:53 +01003063 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003064
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003065 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003066}
3067
3068
Gilles Peskine20035e32018-02-03 22:44:14 +01003069
Gilles Peskine20035e32018-02-03 22:44:14 +01003070/****************************************************************/
3071/* Asymmetric cryptography */
3072/****************************************************************/
3073
Ronald Cron67b1eb32020-12-08 17:37:27 +01003074psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01003075 const psa_key_attributes_t *attributes,
3076 const uint8_t *key_buffer, size_t key_buffer_size,
3077 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3078 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003079{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003080 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003081
John Durkop6ba40d12020-11-10 08:50:04 -08003082#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3083 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01003084 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003085 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01003086 return( mbedtls_psa_rsa_sign_hash(
3087 attributes,
3088 key_buffer, key_buffer_size,
3089 alg, hash, hash_length,
3090 signature, signature_size, signature_length ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01003091 }
3092 else
John Durkop6ba40d12020-11-10 08:50:04 -08003093#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3094 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Ronald Cron99b8ed72021-02-17 10:33:32 +01003095 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003096 {
John Durkop9814fa22020-11-04 12:28:15 -08003097#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3098 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003099 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003100#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003101 PSA_ALG_IS_ECDSA( alg )
3102#else
3103 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3104#endif
3105 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003106 {
Ronald Cron072722c2020-12-09 16:36:19 +01003107 return( mbedtls_psa_ecdsa_sign_hash(
3108 attributes,
3109 key_buffer, key_buffer_size,
3110 alg, hash, hash_length,
3111 signature, signature_size, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003112 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003113 else
John Durkop9814fa22020-11-04 12:28:15 -08003114#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3115 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003116 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003117 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003118 }
itayzafrir5c753392018-05-08 11:18:38 +03003119 }
3120 else
itayzafrir5c753392018-05-08 11:18:38 +03003121 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003122 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003123 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003124
Ronald Cron18659932020-12-08 16:32:23 +01003125 return( status );
3126}
3127
3128psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
3129 psa_algorithm_t alg,
3130 const uint8_t *hash,
3131 size_t hash_length,
3132 uint8_t *signature,
3133 size_t signature_size,
3134 size_t *signature_length )
3135{
3136 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3137 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3138 psa_key_slot_t *slot;
3139
3140 *signature_length = signature_size;
3141 /* Immediately reject a zero-length signature buffer. This guarantees
3142 * that signature must be a valid pointer. (On the other hand, the hash
3143 * buffer can in principle be empty since it doesn't actually have
3144 * to be a hash.) */
3145 if( signature_size == 0 )
3146 return( PSA_ERROR_BUFFER_TOO_SMALL );
3147
3148 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3149 PSA_KEY_USAGE_SIGN_HASH,
3150 alg );
3151 if( status != PSA_SUCCESS )
3152 goto exit;
3153 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
3154 {
3155 status = PSA_ERROR_INVALID_ARGUMENT;
3156 goto exit;
3157 }
3158
Ronald Cron9f17aa42020-12-08 17:07:25 +01003159 psa_key_attributes_t attributes = {
3160 .core = slot->attr
3161 };
3162
Ronald Cron18659932020-12-08 16:32:23 +01003163 /* Try any of the available accelerators first */
Ronald Cron9f17aa42020-12-08 17:07:25 +01003164 status = psa_driver_wrapper_sign_hash(
3165 &attributes, slot->key.data, slot->key.bytes,
3166 alg, hash, hash_length,
3167 signature, signature_size, signature_length );
3168
Ronald Cron18659932020-12-08 16:32:23 +01003169exit:
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003170 /* Fill the unused part of the output buffer (the whole buffer on error,
3171 * the trailing part on success) with something that isn't a valid mac
3172 * (barring an attack on the mac and deliberately-crafted input),
3173 * in case the caller doesn't check the return status properly. */
3174 if( status == PSA_SUCCESS )
3175 memset( signature + *signature_length, '!',
3176 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003177 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003178 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003179 /* If signature_size is 0 then we have nothing to do. We must not call
3180 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003181
Ronald Cron5c522922020-11-14 16:35:34 +01003182 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003183
Ronald Cron5c522922020-11-14 16:35:34 +01003184 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003185}
3186
Ronald Cron67b1eb32020-12-08 17:37:27 +01003187psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01003188 const psa_key_attributes_t *attributes,
3189 const uint8_t *key_buffer, size_t key_buffer_size,
3190 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3191 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003192{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron99b8ed72021-02-17 10:33:32 +01003194
John Durkop6ba40d12020-11-10 08:50:04 -08003195#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3196 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01003197 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003198 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01003199 return( mbedtls_psa_rsa_verify_hash(
3200 attributes,
3201 key_buffer, key_buffer_size,
3202 alg, hash, hash_length,
3203 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003204 }
3205 else
John Durkop6ba40d12020-11-10 08:50:04 -08003206#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3207 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Ronald Cron99b8ed72021-02-17 10:33:32 +01003208 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003209 {
John Durkop9814fa22020-11-04 12:28:15 -08003210#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3211 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003212 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003213 {
Ronald Cron072722c2020-12-09 16:36:19 +01003214 return( mbedtls_psa_ecdsa_verify_hash(
3215 attributes,
3216 key_buffer, key_buffer_size,
3217 alg, hash, hash_length,
3218 signature, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003219 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003220 else
John Durkop9814fa22020-11-04 12:28:15 -08003221#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3222 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003223 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003224 status = PSA_ERROR_INVALID_ARGUMENT;
3225 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003226 }
itayzafrir5c753392018-05-08 11:18:38 +03003227 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003228 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003229 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003230 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003231 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003232
3233exit:
Ronald Cron18659932020-12-08 16:32:23 +01003234 return( status );
3235}
3236
3237psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3238 psa_algorithm_t alg,
3239 const uint8_t *hash,
3240 size_t hash_length,
3241 const uint8_t *signature,
3242 size_t signature_length )
3243{
3244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3245 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3246 psa_key_slot_t *slot;
3247
3248 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3249 PSA_KEY_USAGE_VERIFY_HASH,
3250 alg );
3251 if( status != PSA_SUCCESS )
3252 return( status );
3253
Ronald Cron9f17aa42020-12-08 17:07:25 +01003254 psa_key_attributes_t attributes = {
3255 .core = slot->attr
3256 };
3257
Ronald Cron18659932020-12-08 16:32:23 +01003258 /* Try any of the available accelerators first */
Ronald Cron9f17aa42020-12-08 17:07:25 +01003259 status = psa_driver_wrapper_verify_hash(
3260 &attributes, slot->key.data, slot->key.bytes,
3261 alg, hash, hash_length,
3262 signature, signature_length );
3263
Ronald Cron5c522922020-11-14 16:35:34 +01003264 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003265
Ronald Cron5c522922020-11-14 16:35:34 +01003266 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003267}
3268
John Durkop0e005192020-10-31 22:06:54 -07003269#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003270static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3271 mbedtls_rsa_context *rsa )
3272{
3273 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3274 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3275 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3276 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3277}
John Durkop0e005192020-10-31 22:06:54 -07003278#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003279
Ronald Croncf56a0a2020-08-04 09:51:30 +02003280psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003281 psa_algorithm_t alg,
3282 const uint8_t *input,
3283 size_t input_length,
3284 const uint8_t *salt,
3285 size_t salt_length,
3286 uint8_t *output,
3287 size_t output_size,
3288 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003289{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003290 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003291 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003292 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003293
Darryl Green5cc689a2018-07-24 15:34:10 +01003294 (void) input;
3295 (void) input_length;
3296 (void) salt;
3297 (void) output;
3298 (void) output_size;
3299
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003300 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003301
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003302 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3303 return( PSA_ERROR_INVALID_ARGUMENT );
3304
Ronald Cron5c522922020-11-14 16:35:34 +01003305 status = psa_get_and_lock_transparent_key_slot_with_policy(
3306 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003307 if( status != PSA_SUCCESS )
3308 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003309 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3310 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003311 {
3312 status = PSA_ERROR_INVALID_ARGUMENT;
3313 goto exit;
3314 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003315
John Durkop6ba40d12020-11-10 08:50:04 -08003316#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3317 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003318 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003319 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003320 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003321 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3322 slot->key.data,
3323 slot->key.bytes,
3324 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003325 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003326 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003327
3328 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003329 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003330 status = PSA_ERROR_BUFFER_TOO_SMALL;
3331 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003332 }
John Durkop0e005192020-10-31 22:06:54 -07003333#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003334 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003335 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003336 status = mbedtls_to_psa_error(
3337 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003338 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003339 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003340 MBEDTLS_RSA_PUBLIC,
3341 input_length,
3342 input,
3343 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003344 }
3345 else
John Durkop0e005192020-10-31 22:06:54 -07003346#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3347#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003348 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003349 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003350 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003351 status = mbedtls_to_psa_error(
3352 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003353 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003354 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003355 MBEDTLS_RSA_PUBLIC,
3356 salt, salt_length,
3357 input_length,
3358 input,
3359 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003360 }
3361 else
John Durkop0e005192020-10-31 22:06:54 -07003362#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003363 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003364 status = PSA_ERROR_INVALID_ARGUMENT;
3365 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003366 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003367rsa_exit:
3368 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003369 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003370
Steven Cooremana2371e52020-07-28 14:30:39 +02003371 mbedtls_rsa_free( rsa );
3372 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003373 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003374 else
John Durkop9814fa22020-11-04 12:28:15 -08003375#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003376 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003377 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003378 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003379 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003380
3381exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003382 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003383
Ronald Cron5c522922020-11-14 16:35:34 +01003384 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003385}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003386
Ronald Croncf56a0a2020-08-04 09:51:30 +02003387psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003388 psa_algorithm_t alg,
3389 const uint8_t *input,
3390 size_t input_length,
3391 const uint8_t *salt,
3392 size_t salt_length,
3393 uint8_t *output,
3394 size_t output_size,
3395 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003396{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003397 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003398 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003399 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003400
Darryl Green5cc689a2018-07-24 15:34:10 +01003401 (void) input;
3402 (void) input_length;
3403 (void) salt;
3404 (void) output;
3405 (void) output_size;
3406
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003407 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003408
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003409 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3410 return( PSA_ERROR_INVALID_ARGUMENT );
3411
Ronald Cron5c522922020-11-14 16:35:34 +01003412 status = psa_get_and_lock_transparent_key_slot_with_policy(
3413 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003414 if( status != PSA_SUCCESS )
3415 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003416 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003417 {
3418 status = PSA_ERROR_INVALID_ARGUMENT;
3419 goto exit;
3420 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003421
John Durkop6ba40d12020-11-10 08:50:04 -08003422#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3423 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003424 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003425 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003426 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003427 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3428 slot->key.data,
3429 slot->key.bytes,
3430 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003431 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003432 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003433
Steven Cooremana2371e52020-07-28 14:30:39 +02003434 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003435 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003436 status = PSA_ERROR_INVALID_ARGUMENT;
3437 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003438 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003439
John Durkop0e005192020-10-31 22:06:54 -07003440#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003441 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003442 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003443 status = mbedtls_to_psa_error(
3444 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003445 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003446 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003447 MBEDTLS_RSA_PRIVATE,
3448 output_length,
3449 input,
3450 output,
3451 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003452 }
3453 else
John Durkop0e005192020-10-31 22:06:54 -07003454#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3455#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003456 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003457 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003458 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003459 status = mbedtls_to_psa_error(
3460 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003461 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003462 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003463 MBEDTLS_RSA_PRIVATE,
3464 salt, salt_length,
3465 output_length,
3466 input,
3467 output,
3468 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003469 }
3470 else
John Durkop0e005192020-10-31 22:06:54 -07003471#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003472 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003473 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003474 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003475
Steven Cooreman4fed4552020-08-03 14:46:03 +02003476rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003477 mbedtls_rsa_free( rsa );
3478 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003479 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003480 else
John Durkop6ba40d12020-11-10 08:50:04 -08003481#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3482 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003483 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003484 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003485 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003486
3487exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003488 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003489
Ronald Cron5c522922020-11-14 16:35:34 +01003490 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003491}
Gilles Peskine20035e32018-02-03 22:44:14 +01003492
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003493
3494
mohammad1603503973b2018-03-12 15:59:30 +02003495/****************************************************************/
3496/* Symmetric cryptography */
3497/****************************************************************/
3498
Gilles Peskinee553c652018-06-04 16:22:46 +02003499static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003500 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003501 psa_algorithm_t alg,
3502 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003503{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003504 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003505 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003506 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003507 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003508 size_t key_bits;
3509 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003510 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3511 PSA_KEY_USAGE_ENCRYPT :
3512 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003513
Steven Cooremand3feccd2020-09-01 15:56:14 +02003514 /* A context must be freshly initialized before it can be set up. */
3515 if( operation->alg != 0 )
3516 return( PSA_ERROR_BAD_STATE );
3517
Steven Cooremana07b9972020-09-10 14:54:14 +02003518 /* The requested algorithm must be one that can be processed by cipher. */
3519 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003520 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003521
Steven Cooremanef8575e2020-09-11 11:44:50 +02003522 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003523 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003524 if( status != PSA_SUCCESS )
3525 goto exit;
3526
3527 /* Initialize the operation struct members, except for alg. The alg member
3528 * is used to indicate to psa_cipher_abort that there are resources to free,
3529 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003530 operation->key_set = 0;
3531 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003532 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003533 operation->iv_size = 0;
3534 operation->block_size = 0;
3535 if( alg == PSA_ALG_ECB_NO_PADDING )
3536 operation->iv_required = 0;
3537 else
3538 operation->iv_required = 1;
3539
Steven Cooremana07b9972020-09-10 14:54:14 +02003540 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003541 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003542 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003543 slot,
3544 alg );
3545 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003546 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003547 slot,
3548 alg );
3549
Steven Cooremanef8575e2020-09-11 11:44:50 +02003550 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003551 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003552 /* Once the driver context is initialised, it needs to be freed using
3553 * psa_cipher_abort. Indicate this through setting alg. */
3554 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003555 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003556
Steven Cooremand3feccd2020-09-01 15:56:14 +02003557 if( status != PSA_ERROR_NOT_SUPPORTED ||
3558 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3559 goto exit;
3560
Steven Cooremana07b9972020-09-10 14:54:14 +02003561 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003562 * available for the given algorithm & key. */
3563 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003564
Steven Cooremana07b9972020-09-10 14:54:14 +02003565 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003566 * psa_cipher_abort. Indicate there is something to be freed through setting
3567 * alg, and indicate the operation is being done using mbedtls crypto through
3568 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003569 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003570 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02003571
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003572 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02003573 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003574 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003575 {
3576 status = PSA_ERROR_NOT_SUPPORTED;
3577 goto exit;
3578 }
mohammad1603503973b2018-03-12 15:59:30 +02003579
mohammad1603503973b2018-03-12 15:59:30 +02003580 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003581 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003582 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003583
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003584#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003585 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003586 {
3587 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003588 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01003589 memcpy( keys, slot->key.data, 16 );
3590 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003591 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3592 keys,
3593 192, cipher_operation );
3594 }
3595 else
3596#endif
3597 {
3598 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003599 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003600 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003601 }
Moran Peker41deec42018-04-04 15:43:05 +03003602 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003603 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003604
mohammad16038481e742018-03-18 13:57:31 +02003605#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003606 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003607 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003608 case PSA_ALG_CBC_NO_PADDING:
3609 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3610 MBEDTLS_PADDING_NONE );
3611 break;
3612 case PSA_ALG_CBC_PKCS7:
3613 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3614 MBEDTLS_PADDING_PKCS7 );
3615 break;
3616 default:
3617 /* The algorithm doesn't involve padding. */
3618 ret = 0;
3619 break;
3620 }
3621 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003622 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003623#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3624
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003625 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003626 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02003627 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
3628 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02003629 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003630 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003631 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003632#if defined(MBEDTLS_CHACHA20_C)
3633 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01003634 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02003635 operation->iv_size = 12;
3636#endif
mohammad1603503973b2018-03-12 15:59:30 +02003637
Steven Cooreman7df02922020-09-09 15:28:49 +02003638 status = PSA_SUCCESS;
3639
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003640exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003641 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003642 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02003643 if( status == PSA_SUCCESS )
3644 {
3645 /* Update operation flags for both driver and software implementations */
3646 operation->key_set = 1;
3647 }
3648 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003649 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003650
Ronald Cron5c522922020-11-14 16:35:34 +01003651 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003652
Ronald Cron5c522922020-11-14 16:35:34 +01003653 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003654}
3655
Gilles Peskinefe119512018-07-08 21:39:34 +02003656psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003657 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003658 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003659{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003660 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003661}
3662
Gilles Peskinefe119512018-07-08 21:39:34 +02003663psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003664 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003665 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003666{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003667 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003668}
3669
Gilles Peskinefe119512018-07-08 21:39:34 +02003670psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003671 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003672 size_t iv_size,
3673 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003674{
itayzafrir534bd7c2018-08-02 13:56:32 +03003675 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003677 if( operation->iv_set || ! operation->iv_required )
3678 {
3679 return( PSA_ERROR_BAD_STATE );
3680 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003681
Steven Cooremanef8575e2020-09-11 11:44:50 +02003682 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003683 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003684 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003685 iv,
3686 iv_size,
3687 iv_length );
3688 goto exit;
3689 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003690
Moran Peker41deec42018-04-04 15:43:05 +03003691 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003692 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003693 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003694 goto exit;
3695 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003696 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003697 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003698 if( ret != 0 )
3699 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003700 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003701 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003702 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003703
mohammad16038481e742018-03-18 13:57:31 +02003704 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003705 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003706
Moran Peker395db872018-05-31 14:07:14 +03003707exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003708 if( status == PSA_SUCCESS )
3709 operation->iv_set = 1;
3710 else
Moran Peker395db872018-05-31 14:07:14 +03003711 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003712 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003713}
3714
Gilles Peskinefe119512018-07-08 21:39:34 +02003715psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003716 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003717 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003718{
itayzafrir534bd7c2018-08-02 13:56:32 +03003719 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003721 if( operation->iv_set || ! operation->iv_required )
3722 {
3723 return( PSA_ERROR_BAD_STATE );
3724 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003725
Steven Cooremanef8575e2020-09-11 11:44:50 +02003726 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003727 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003728 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003729 iv,
3730 iv_length );
3731 goto exit;
3732 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003733
Moran Pekera28258c2018-05-29 16:25:04 +03003734 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003735 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003736 status = PSA_ERROR_INVALID_ARGUMENT;
3737 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003738 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003739 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3740 status = mbedtls_to_psa_error( ret );
3741exit:
3742 if( status == PSA_SUCCESS )
3743 operation->iv_set = 1;
3744 else
mohammad1603503973b2018-03-12 15:59:30 +02003745 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003746 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003747}
3748
Steven Cooreman177deba2020-09-07 17:14:14 +02003749/* Process input for which the algorithm is set to ECB mode. This requires
3750 * manual processing, since the PSA API is defined as being able to process
3751 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
3752 * underlying mbedtls_cipher_update only takes full blocks. */
3753static psa_status_t psa_cipher_update_ecb_internal(
3754 mbedtls_cipher_context_t *ctx,
3755 const uint8_t *input,
3756 size_t input_length,
3757 uint8_t *output,
3758 size_t output_size,
3759 size_t *output_length )
3760{
3761 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3762 size_t block_size = ctx->cipher_info->block_size;
3763 size_t internal_output_length = 0;
3764 *output_length = 0;
3765
3766 if( input_length == 0 )
3767 {
3768 status = PSA_SUCCESS;
3769 goto exit;
3770 }
3771
3772 if( ctx->unprocessed_len > 0 )
3773 {
3774 /* Fill up to block size, and run the block if there's a full one. */
3775 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
3776
3777 if( input_length < bytes_to_copy )
3778 bytes_to_copy = input_length;
3779
3780 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3781 input, bytes_to_copy );
3782 input_length -= bytes_to_copy;
3783 input += bytes_to_copy;
3784 ctx->unprocessed_len += bytes_to_copy;
3785
3786 if( ctx->unprocessed_len == block_size )
3787 {
3788 status = mbedtls_to_psa_error(
3789 mbedtls_cipher_update( ctx,
3790 ctx->unprocessed_data,
3791 block_size,
3792 output, &internal_output_length ) );
3793
3794 if( status != PSA_SUCCESS )
3795 goto exit;
3796
3797 output += internal_output_length;
3798 output_size -= internal_output_length;
3799 *output_length += internal_output_length;
3800 ctx->unprocessed_len = 0;
3801 }
3802 }
3803
3804 while( input_length >= block_size )
3805 {
3806 /* Run all full blocks we have, one by one */
3807 status = mbedtls_to_psa_error(
3808 mbedtls_cipher_update( ctx, input,
3809 block_size,
3810 output, &internal_output_length ) );
3811
3812 if( status != PSA_SUCCESS )
3813 goto exit;
3814
3815 input_length -= block_size;
3816 input += block_size;
3817
3818 output += internal_output_length;
3819 output_size -= internal_output_length;
3820 *output_length += internal_output_length;
3821 }
3822
3823 if( input_length > 0 )
3824 {
3825 /* Save unprocessed bytes for later processing */
3826 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3827 input, input_length );
3828 ctx->unprocessed_len += input_length;
3829 }
3830
3831 status = PSA_SUCCESS;
3832
3833exit:
3834 return( status );
3835}
3836
Gilles Peskinee553c652018-06-04 16:22:46 +02003837psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3838 const uint8_t *input,
3839 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003840 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003841 size_t output_size,
3842 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003843{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003844 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003845 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02003846 if( operation->alg == 0 )
3847 {
3848 return( PSA_ERROR_BAD_STATE );
3849 }
3850 if( operation->iv_required && ! operation->iv_set )
3851 {
3852 return( PSA_ERROR_BAD_STATE );
3853 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003854
Steven Cooremanef8575e2020-09-11 11:44:50 +02003855 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003856 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003857 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003858 input,
3859 input_length,
3860 output,
3861 output_size,
3862 output_length );
3863 goto exit;
3864 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003865
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003866 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003867 {
3868 /* Take the unprocessed partial block left over from previous
3869 * update calls, if any, plus the input to this call. Remove
3870 * the last partial block, if any. You get the data that will be
3871 * output in this call. */
3872 expected_output_size =
3873 ( operation->ctx.cipher.unprocessed_len + input_length )
3874 / operation->block_size * operation->block_size;
3875 }
3876 else
3877 {
3878 expected_output_size = input_length;
3879 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003880
Gilles Peskine89d789c2018-06-04 17:17:16 +02003881 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003882 {
3883 status = PSA_ERROR_BUFFER_TOO_SMALL;
3884 goto exit;
3885 }
mohammad160382759612018-03-12 18:16:40 +02003886
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003887 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
3888 {
3889 /* mbedtls_cipher_update has an API inconsistency: it will only
3890 * process a single block at a time in ECB mode. Abstract away that
3891 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02003892 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
3893 input,
3894 input_length,
3895 output,
3896 output_size,
3897 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003898 }
3899 else
3900 {
3901 status = mbedtls_to_psa_error(
3902 mbedtls_cipher_update( &operation->ctx.cipher, input,
3903 input_length, output, output_length ) );
3904 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003905exit:
3906 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003907 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003908 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003909}
3910
Gilles Peskinee553c652018-06-04 16:22:46 +02003911psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3912 uint8_t *output,
3913 size_t output_size,
3914 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003915{
David Saadab4ecc272019-02-14 13:48:10 +02003916 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02003917 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02003918 if( operation->alg == 0 )
3919 {
3920 return( PSA_ERROR_BAD_STATE );
3921 }
3922 if( operation->iv_required && ! operation->iv_set )
3923 {
3924 return( PSA_ERROR_BAD_STATE );
3925 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003926
Steven Cooremanef8575e2020-09-11 11:44:50 +02003927 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003928 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003929 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003930 output,
3931 output_size,
3932 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003933 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02003934 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003935
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003936 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003937 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003938 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02003939 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02003940 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003941 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003942 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003943 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003944 }
3945
Steven Cooremanef8575e2020-09-11 11:44:50 +02003946 status = mbedtls_to_psa_error(
3947 mbedtls_cipher_finish( &operation->ctx.cipher,
3948 temp_output_buffer,
3949 output_length ) );
3950 if( status != PSA_SUCCESS )
3951 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01003952
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003953 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003954 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003955 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003956 memcpy( output, temp_output_buffer, *output_length );
3957 else
Janos Follath315b51c2018-07-09 16:04:51 +01003958 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02003959
Steven Cooremanef8575e2020-09-11 11:44:50 +02003960exit:
3961 if( operation->mbedtls_in_use == 1 )
3962 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003963
Steven Cooremanef8575e2020-09-11 11:44:50 +02003964 if( status == PSA_SUCCESS )
3965 return( psa_cipher_abort( operation ) );
3966 else
3967 {
3968 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003969 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003970
Steven Cooremanef8575e2020-09-11 11:44:50 +02003971 return( status );
3972 }
mohammad1603503973b2018-03-12 15:59:30 +02003973}
3974
Gilles Peskinee553c652018-06-04 16:22:46 +02003975psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3976{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003977 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003978 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003979 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003980 * in use. It's ok to call abort on such an object, and there's
3981 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003982 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003983 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003984
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003985 /* Sanity check (shouldn't happen: operation->alg should
3986 * always have been initialized to a valid value). */
3987 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3988 return( PSA_ERROR_BAD_STATE );
3989
Steven Cooremanef8575e2020-09-11 11:44:50 +02003990 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003991 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003992 else
3993 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003994
Moran Peker41deec42018-04-04 15:43:05 +03003995 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003996 operation->key_set = 0;
3997 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003998 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003999 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004000 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004001 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004002
Moran Peker395db872018-05-31 14:07:14 +03004003 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004004}
4005
Gilles Peskinea0655c32018-04-30 17:06:50 +02004006
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004007
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004008
mohammad16035955c982018-04-26 00:53:03 +03004009/****************************************************************/
4010/* AEAD */
4011/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004012
Gilles Peskineedf9a652018-08-17 18:11:56 +02004013typedef struct
4014{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004015 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004016 const mbedtls_cipher_info_t *cipher_info;
4017 union
4018 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004019 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004020#if defined(MBEDTLS_CCM_C)
4021 mbedtls_ccm_context ccm;
4022#endif /* MBEDTLS_CCM_C */
4023#if defined(MBEDTLS_GCM_C)
4024 mbedtls_gcm_context gcm;
4025#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004026#if defined(MBEDTLS_CHACHAPOLY_C)
4027 mbedtls_chachapoly_context chachapoly;
4028#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004029 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004030 psa_algorithm_t core_alg;
4031 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004032 uint8_t tag_length;
4033} aead_operation_t;
4034
Ronald Cronf95a2b12020-10-22 15:24:49 +02004035#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4036
Gilles Peskine30a9e412019-01-14 18:36:12 +01004037static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004038{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004039 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004040 {
4041#if defined(MBEDTLS_CCM_C)
4042 case PSA_ALG_CCM:
4043 mbedtls_ccm_free( &operation->ctx.ccm );
4044 break;
4045#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004046#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004047 case PSA_ALG_GCM:
4048 mbedtls_gcm_free( &operation->ctx.gcm );
4049 break;
4050#endif /* MBEDTLS_GCM_C */
4051 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004052
Ronald Cron5c522922020-11-14 16:35:34 +01004053 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004054}
4055
4056static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004057 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004058 psa_key_usage_t usage,
4059 psa_algorithm_t alg )
4060{
4061 psa_status_t status;
4062 size_t key_bits;
4063 mbedtls_cipher_id_t cipher_id;
4064
Ronald Cron5c522922020-11-14 16:35:34 +01004065 status = psa_get_and_lock_transparent_key_slot_with_policy(
4066 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004067 if( status != PSA_SUCCESS )
4068 return( status );
4069
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004070 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004071
4072 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004073 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004074 &cipher_id );
4075 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004076 {
4077 status = PSA_ERROR_NOT_SUPPORTED;
4078 goto cleanup;
4079 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004080
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004081 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004082 {
4083#if defined(MBEDTLS_CCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004084 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004085 operation->core_alg = PSA_ALG_CCM;
4086 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004087 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4088 * The call to mbedtls_ccm_encrypt_and_tag or
4089 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004090 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004091 {
4092 status = PSA_ERROR_INVALID_ARGUMENT;
4093 goto cleanup;
4094 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004095 mbedtls_ccm_init( &operation->ctx.ccm );
4096 status = mbedtls_to_psa_error(
4097 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004098 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004099 (unsigned int) key_bits ) );
4100 if( status != 0 )
4101 goto cleanup;
4102 break;
4103#endif /* MBEDTLS_CCM_C */
4104
4105#if defined(MBEDTLS_GCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004106 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004107 operation->core_alg = PSA_ALG_GCM;
4108 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004109 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4110 * The call to mbedtls_gcm_crypt_and_tag or
4111 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004112 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004113 {
4114 status = PSA_ERROR_INVALID_ARGUMENT;
4115 goto cleanup;
4116 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004117 mbedtls_gcm_init( &operation->ctx.gcm );
4118 status = mbedtls_to_psa_error(
4119 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004120 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004121 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004122 if( status != 0 )
4123 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004124 break;
4125#endif /* MBEDTLS_GCM_C */
4126
Gilles Peskine26869f22019-05-06 15:25:00 +02004127#if defined(MBEDTLS_CHACHAPOLY_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004128 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02004129 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4130 operation->full_tag_length = 16;
4131 /* We only support the default tag length. */
4132 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004133 {
4134 status = PSA_ERROR_NOT_SUPPORTED;
4135 goto cleanup;
4136 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004137 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4138 status = mbedtls_to_psa_error(
4139 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004140 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004141 if( status != 0 )
4142 goto cleanup;
4143 break;
4144#endif /* MBEDTLS_CHACHAPOLY_C */
4145
Gilles Peskineedf9a652018-08-17 18:11:56 +02004146 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004147 status = PSA_ERROR_NOT_SUPPORTED;
4148 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004149 }
4150
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004151 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4152 {
4153 status = PSA_ERROR_INVALID_ARGUMENT;
4154 goto cleanup;
4155 }
4156 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004157
Gilles Peskineedf9a652018-08-17 18:11:56 +02004158 return( PSA_SUCCESS );
4159
4160cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004161 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004162 return( status );
4163}
4164
Ronald Croncf56a0a2020-08-04 09:51:30 +02004165psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004166 psa_algorithm_t alg,
4167 const uint8_t *nonce,
4168 size_t nonce_length,
4169 const uint8_t *additional_data,
4170 size_t additional_data_length,
4171 const uint8_t *plaintext,
4172 size_t plaintext_length,
4173 uint8_t *ciphertext,
4174 size_t ciphertext_size,
4175 size_t *ciphertext_length )
4176{
mohammad16035955c982018-04-26 00:53:03 +03004177 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004178 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004179 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004180
mohammad1603f08a5502018-06-03 15:05:47 +03004181 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004182
Ronald Croncf56a0a2020-08-04 09:51:30 +02004183 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004184 if( status != PSA_SUCCESS )
4185 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004186
Gilles Peskineedf9a652018-08-17 18:11:56 +02004187 /* For all currently supported modes, the tag is at the end of the
4188 * ciphertext. */
4189 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4190 {
4191 status = PSA_ERROR_BUFFER_TOO_SMALL;
4192 goto exit;
4193 }
4194 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004195
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004196#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004197 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004198 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004199 status = mbedtls_to_psa_error(
4200 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4201 MBEDTLS_GCM_ENCRYPT,
4202 plaintext_length,
4203 nonce, nonce_length,
4204 additional_data, additional_data_length,
4205 plaintext, ciphertext,
4206 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004207 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004208 else
4209#endif /* MBEDTLS_GCM_C */
4210#if defined(MBEDTLS_CCM_C)
4211 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004212 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004213 status = mbedtls_to_psa_error(
4214 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4215 plaintext_length,
4216 nonce, nonce_length,
4217 additional_data,
4218 additional_data_length,
4219 plaintext, ciphertext,
4220 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004221 }
mohammad16035c8845f2018-05-09 05:40:09 -07004222 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004223#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004224#if defined(MBEDTLS_CHACHAPOLY_C)
4225 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4226 {
4227 if( nonce_length != 12 || operation.tag_length != 16 )
4228 {
4229 status = PSA_ERROR_NOT_SUPPORTED;
4230 goto exit;
4231 }
4232 status = mbedtls_to_psa_error(
4233 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4234 plaintext_length,
4235 nonce,
4236 additional_data,
4237 additional_data_length,
4238 plaintext,
4239 ciphertext,
4240 tag ) );
4241 }
4242 else
4243#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004244 {
Steven Cooreman7196fef2021-02-10 17:13:28 +01004245 (void) tag;
mohammad1603554faad2018-06-03 15:07:38 +03004246 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004247 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004248
Gilles Peskineedf9a652018-08-17 18:11:56 +02004249 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4250 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004251
Gilles Peskineedf9a652018-08-17 18:11:56 +02004252exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004253 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004254 if( status == PSA_SUCCESS )
4255 *ciphertext_length = plaintext_length + operation.tag_length;
4256 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004257}
4258
Gilles Peskineee652a32018-06-01 19:23:52 +02004259/* Locate the tag in a ciphertext buffer containing the encrypted data
4260 * followed by the tag. Return the length of the part preceding the tag in
4261 * *plaintext_length. This is the size of the plaintext in modes where
4262 * the encrypted data has the same size as the plaintext, such as
4263 * CCM and GCM. */
4264static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4265 const uint8_t *ciphertext,
4266 size_t ciphertext_length,
4267 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004268 const uint8_t **p_tag )
4269{
4270 size_t payload_length;
4271 if( tag_length > ciphertext_length )
4272 return( PSA_ERROR_INVALID_ARGUMENT );
4273 payload_length = ciphertext_length - tag_length;
4274 if( payload_length > plaintext_size )
4275 return( PSA_ERROR_BUFFER_TOO_SMALL );
4276 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004277 return( PSA_SUCCESS );
4278}
4279
Ronald Croncf56a0a2020-08-04 09:51:30 +02004280psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004281 psa_algorithm_t alg,
4282 const uint8_t *nonce,
4283 size_t nonce_length,
4284 const uint8_t *additional_data,
4285 size_t additional_data_length,
4286 const uint8_t *ciphertext,
4287 size_t ciphertext_length,
4288 uint8_t *plaintext,
4289 size_t plaintext_size,
4290 size_t *plaintext_length )
4291{
mohammad16035955c982018-04-26 00:53:03 +03004292 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004293 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004294 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004295
Gilles Peskineee652a32018-06-01 19:23:52 +02004296 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004297
Ronald Croncf56a0a2020-08-04 09:51:30 +02004298 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004299 if( status != PSA_SUCCESS )
4300 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004301
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004302 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4303 ciphertext, ciphertext_length,
4304 plaintext_size, &tag );
4305 if( status != PSA_SUCCESS )
4306 goto exit;
4307
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004308#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004309 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004310 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004311 status = mbedtls_to_psa_error(
4312 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4313 ciphertext_length - operation.tag_length,
4314 nonce, nonce_length,
4315 additional_data,
4316 additional_data_length,
4317 tag, operation.tag_length,
4318 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004319 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004320 else
4321#endif /* MBEDTLS_GCM_C */
4322#if defined(MBEDTLS_CCM_C)
4323 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004324 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004325 status = mbedtls_to_psa_error(
4326 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4327 ciphertext_length - operation.tag_length,
4328 nonce, nonce_length,
4329 additional_data,
4330 additional_data_length,
4331 ciphertext, plaintext,
4332 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004333 }
mohammad160339574652018-06-01 04:39:53 -07004334 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004335#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004336#if defined(MBEDTLS_CHACHAPOLY_C)
4337 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4338 {
4339 if( nonce_length != 12 || operation.tag_length != 16 )
4340 {
4341 status = PSA_ERROR_NOT_SUPPORTED;
4342 goto exit;
4343 }
4344 status = mbedtls_to_psa_error(
4345 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4346 ciphertext_length - operation.tag_length,
4347 nonce,
4348 additional_data,
4349 additional_data_length,
4350 tag,
4351 ciphertext,
4352 plaintext ) );
4353 }
4354 else
4355#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004356 {
mohammad1603554faad2018-06-03 15:07:38 +03004357 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004358 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004359
Gilles Peskineedf9a652018-08-17 18:11:56 +02004360 if( status != PSA_SUCCESS && plaintext_size != 0 )
4361 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004362
Gilles Peskineedf9a652018-08-17 18:11:56 +02004363exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004364 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004365 if( status == PSA_SUCCESS )
4366 *plaintext_length = ciphertext_length - operation.tag_length;
4367 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004368}
4369
Gilles Peskinea0655c32018-04-30 17:06:50 +02004370
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004371
Gilles Peskine20035e32018-02-03 22:44:14 +01004372/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004373/* Generators */
4374/****************************************************************/
4375
John Durkop07cc04a2020-11-16 22:08:34 -08004376#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4377 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4378 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4379#define AT_LEAST_ONE_BUILTIN_KDF
4380#endif
4381
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004382#define HKDF_STATE_INIT 0 /* no input yet */
4383#define HKDF_STATE_STARTED 1 /* got salt */
4384#define HKDF_STATE_KEYED 2 /* got key */
4385#define HKDF_STATE_OUTPUT 3 /* output started */
4386
Gilles Peskinecbe66502019-05-16 16:59:18 +02004387static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004388 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004389{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004390 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4391 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004392 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004393 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004394}
4395
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004396psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004397{
4398 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004399 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004400 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004401 {
4402 /* The object has (apparently) been initialized but it is not
4403 * in use. It's ok to call abort on such an object, and there's
4404 * nothing to do. */
4405 }
4406 else
John Durkopd0321952020-10-29 21:37:36 -07004407#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004408 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004409 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004410 mbedtls_free( operation->ctx.hkdf.info );
4411 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004412 }
John Durkop07cc04a2020-11-16 22:08:34 -08004413 else
4414#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4415#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4416 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4417 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004418 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004419 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004420 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004421 if( operation->ctx.tls12_prf.seed != NULL )
4422 {
4423 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4424 operation->ctx.tls12_prf.seed_length );
4425 mbedtls_free( operation->ctx.tls12_prf.seed );
4426 }
4427
4428 if( operation->ctx.tls12_prf.label != NULL )
4429 {
4430 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4431 operation->ctx.tls12_prf.label_length );
4432 mbedtls_free( operation->ctx.tls12_prf.label );
4433 }
4434
4435 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4436
4437 /* We leave the fields Ai and output_block to be erased safely by the
4438 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004439 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004440 else
John Durkop07cc04a2020-11-16 22:08:34 -08004441#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4442 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004443 {
4444 status = PSA_ERROR_BAD_STATE;
4445 }
Janos Follath083036a2019-06-11 10:22:26 +01004446 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004447 return( status );
4448}
4449
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004450psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004451 size_t *capacity)
4452{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004453 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004454 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004455 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004456 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004457 }
4458
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004459 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004460 return( PSA_SUCCESS );
4461}
4462
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004463psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004464 size_t capacity )
4465{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004466 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004467 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004468 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004469 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004470 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004471 return( PSA_SUCCESS );
4472}
4473
John Durkopd0321952020-10-29 21:37:36 -07004474#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004475/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004476 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004477static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004478 psa_algorithm_t hash_alg,
4479 uint8_t *output,
4480 size_t output_length )
4481{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004482 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004483 psa_status_t status;
4484
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004485 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4486 return( PSA_ERROR_BAD_STATE );
4487 hkdf->state = HKDF_STATE_OUTPUT;
4488
Gilles Peskinebef7f142018-07-12 17:22:21 +02004489 while( output_length != 0 )
4490 {
4491 /* Copy what remains of the current block */
4492 uint8_t n = hash_length - hkdf->offset_in_block;
4493 if( n > output_length )
4494 n = (uint8_t) output_length;
4495 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4496 output += n;
4497 output_length -= n;
4498 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004499 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004500 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004501 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004502 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004503 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004504 * object was corrupted or if this function is called directly
4505 * inside the library. */
4506 if( hkdf->block_number == 0xff )
4507 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004508
4509 /* We need a new block */
4510 ++hkdf->block_number;
4511 hkdf->offset_in_block = 0;
4512 status = psa_hmac_setup_internal( &hkdf->hmac,
4513 hkdf->prk, hash_length,
4514 hash_alg );
4515 if( status != PSA_SUCCESS )
4516 return( status );
4517 if( hkdf->block_number != 1 )
4518 {
4519 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4520 hkdf->output_block,
4521 hash_length );
4522 if( status != PSA_SUCCESS )
4523 return( status );
4524 }
4525 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4526 hkdf->info,
4527 hkdf->info_length );
4528 if( status != PSA_SUCCESS )
4529 return( status );
4530 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4531 &hkdf->block_number, 1 );
4532 if( status != PSA_SUCCESS )
4533 return( status );
4534 status = psa_hmac_finish_internal( &hkdf->hmac,
4535 hkdf->output_block,
4536 sizeof( hkdf->output_block ) );
4537 if( status != PSA_SUCCESS )
4538 return( status );
4539 }
4540
4541 return( PSA_SUCCESS );
4542}
John Durkop07cc04a2020-11-16 22:08:34 -08004543#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004544
John Durkop07cc04a2020-11-16 22:08:34 -08004545#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4546 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004547static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4548 psa_tls12_prf_key_derivation_t *tls12_prf,
4549 psa_algorithm_t alg )
4550{
4551 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004552 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004553 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4554 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004555
Janos Follath7742fee2019-06-17 12:58:10 +01004556 /* We can't be wanting more output after block 0xff, otherwise
4557 * the capacity check in psa_key_derivation_output_bytes() would have
4558 * prevented this call. It could happen only if the operation
4559 * object was corrupted or if this function is called directly
4560 * inside the library. */
4561 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004562 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004563
4564 /* We need a new block */
4565 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004566 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004567
4568 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4569 *
4570 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4571 *
4572 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4573 * HMAC_hash(secret, A(2) + seed) +
4574 * HMAC_hash(secret, A(3) + seed) + ...
4575 *
4576 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004577 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004578 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004579 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004580 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004581 * is currently extracted as `output_block` and where i is
4582 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004583 */
4584
Janos Follathea29bfb2019-06-19 12:21:20 +01004585 /* Save the hash context before using it, to preserve the hash state with
4586 * only the inner padding in it. We need this, because inner padding depends
4587 * on the key (secret in the RFC's terminology). */
4588 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4589 if( status != PSA_SUCCESS )
4590 goto cleanup;
4591
4592 /* Calculate A(i) where i = tls12_prf->block_number. */
4593 if( tls12_prf->block_number == 1 )
4594 {
4595 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4596 * the variable seed and in this instance means it in the context of the
4597 * P_hash function, where seed = label + seed.) */
4598 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4599 tls12_prf->label, tls12_prf->label_length );
4600 if( status != PSA_SUCCESS )
4601 goto cleanup;
4602 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4603 tls12_prf->seed, tls12_prf->seed_length );
4604 if( status != PSA_SUCCESS )
4605 goto cleanup;
4606 }
4607 else
4608 {
4609 /* A(i) = HMAC_hash(secret, A(i-1)) */
4610 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4611 tls12_prf->Ai, hash_length );
4612 if( status != PSA_SUCCESS )
4613 goto cleanup;
4614 }
4615
4616 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4617 tls12_prf->Ai, hash_length );
4618 if( status != PSA_SUCCESS )
4619 goto cleanup;
4620 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4621 if( status != PSA_SUCCESS )
4622 goto cleanup;
4623
4624 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4625 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4626 tls12_prf->Ai, hash_length );
4627 if( status != PSA_SUCCESS )
4628 goto cleanup;
4629 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4630 tls12_prf->label, tls12_prf->label_length );
4631 if( status != PSA_SUCCESS )
4632 goto cleanup;
4633 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4634 tls12_prf->seed, tls12_prf->seed_length );
4635 if( status != PSA_SUCCESS )
4636 goto cleanup;
4637 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4638 tls12_prf->output_block, hash_length );
4639 if( status != PSA_SUCCESS )
4640 goto cleanup;
4641 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4642 if( status != PSA_SUCCESS )
4643 goto cleanup;
4644
Janos Follath7742fee2019-06-17 12:58:10 +01004645
4646cleanup:
4647
Janos Follathea29bfb2019-06-19 12:21:20 +01004648 cleanup_status = psa_hash_abort( &backup );
4649 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4650 status = cleanup_status;
4651
4652 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004653}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004654
Janos Follath844eb0e2019-06-19 12:10:49 +01004655static psa_status_t psa_key_derivation_tls12_prf_read(
4656 psa_tls12_prf_key_derivation_t *tls12_prf,
4657 psa_algorithm_t alg,
4658 uint8_t *output,
4659 size_t output_length )
4660{
4661 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004662 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004663 psa_status_t status;
4664 uint8_t offset, length;
4665
4666 while( output_length != 0 )
4667 {
4668 /* Check if we have fully processed the current block. */
4669 if( tls12_prf->left_in_block == 0 )
4670 {
4671 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4672 alg );
4673 if( status != PSA_SUCCESS )
4674 return( status );
4675
4676 continue;
4677 }
4678
4679 if( tls12_prf->left_in_block > output_length )
4680 length = (uint8_t) output_length;
4681 else
4682 length = tls12_prf->left_in_block;
4683
4684 offset = hash_length - tls12_prf->left_in_block;
4685 memcpy( output, tls12_prf->output_block + offset, length );
4686 output += length;
4687 output_length -= length;
4688 tls12_prf->left_in_block -= length;
4689 }
4690
4691 return( PSA_SUCCESS );
4692}
John Durkop07cc04a2020-11-16 22:08:34 -08004693#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4694 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004695
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004696psa_status_t psa_key_derivation_output_bytes(
4697 psa_key_derivation_operation_t *operation,
4698 uint8_t *output,
4699 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004700{
4701 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004702 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004703
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004704 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004705 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004706 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004707 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004708 }
4709
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004710 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004711 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004712 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004713 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004714 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004715 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004716 goto exit;
4717 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004718 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004719 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004720 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004721 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004722 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4723 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004724 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004725 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004726 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004727 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004728 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004729
John Durkopd0321952020-10-29 21:37:36 -07004730#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004731 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004732 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004733 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004734 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004735 output, output_length );
4736 }
Janos Follathadbec812019-06-14 11:05:39 +01004737 else
John Durkop07cc04a2020-11-16 22:08:34 -08004738#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4739#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4740 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004741 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004742 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004743 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004744 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004745 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004746 output_length );
4747 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004748 else
John Durkop07cc04a2020-11-16 22:08:34 -08004749#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4750 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004751 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004752 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004753 return( PSA_ERROR_BAD_STATE );
4754 }
4755
4756exit:
4757 if( status != PSA_SUCCESS )
4758 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004759 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004760 * This allows us to differentiate between exhausted operations and
4761 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4762 * operations. */
4763 psa_algorithm_t alg = operation->alg;
4764 psa_key_derivation_abort( operation );
4765 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004766 memset( output, '!', output_length );
4767 }
4768 return( status );
4769}
4770
Gilles Peskine08542d82018-07-19 17:05:42 +02004771#if defined(MBEDTLS_DES_C)
4772static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4773{
4774 if( data_size >= 8 )
4775 mbedtls_des_key_set_parity( data );
4776 if( data_size >= 16 )
4777 mbedtls_des_key_set_parity( data + 8 );
4778 if( data_size >= 24 )
4779 mbedtls_des_key_set_parity( data + 16 );
4780}
4781#endif /* MBEDTLS_DES_C */
4782
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004783static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004784 psa_key_slot_t *slot,
4785 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004787{
4788 uint8_t *data = NULL;
4789 size_t bytes = PSA_BITS_TO_BYTES( bits );
4790 psa_status_t status;
4791
Gilles Peskine8e338702019-07-30 20:06:31 +02004792 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004793 return( PSA_ERROR_INVALID_ARGUMENT );
4794 if( bits % 8 != 0 )
4795 return( PSA_ERROR_INVALID_ARGUMENT );
4796 data = mbedtls_calloc( 1, bytes );
4797 if( data == NULL )
4798 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4799
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004800 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004801 if( status != PSA_SUCCESS )
4802 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02004803#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004804 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004805 psa_des_set_key_parity( data, bytes );
4806#endif /* MBEDTLS_DES_C */
Ronald Crondd04d422020-11-28 15:14:42 +01004807
4808 status = psa_allocate_buffer_to_slot( slot, bytes );
4809 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004810 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004811
Ronald Cronbf33c932020-11-28 18:06:53 +01004812 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004813 psa_key_attributes_t attributes = {
4814 .core = slot->attr
4815 };
4816
Ronald Cronbf33c932020-11-28 18:06:53 +01004817 status = psa_driver_wrapper_import_key( &attributes,
4818 data, bytes,
4819 slot->key.data,
4820 slot->key.bytes,
4821 &slot->key.bytes, &bits );
4822 if( bits != slot->attr.bits )
4823 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004824
4825exit:
4826 mbedtls_free( data );
4827 return( status );
4828}
4829
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004830psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004831 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004832 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004833{
4834 psa_status_t status;
4835 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004836 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004837
Ronald Cron81709fc2020-11-14 12:10:32 +01004838 *key = MBEDTLS_SVC_KEY_ID_INIT;
4839
Gilles Peskine0f84d622019-09-12 19:03:13 +02004840 /* Reject any attempt to create a zero-length key so that we don't
4841 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4842 if( psa_get_key_bits( attributes ) == 0 )
4843 return( PSA_ERROR_INVALID_ARGUMENT );
4844
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004845 if( ! operation->can_output_key )
4846 return( PSA_ERROR_NOT_PERMITTED );
4847
Ronald Cron81709fc2020-11-14 12:10:32 +01004848 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4849 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004850#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4851 if( driver != NULL )
4852 {
4853 /* Deriving a key in a secure element is not implemented yet. */
4854 status = PSA_ERROR_NOT_SUPPORTED;
4855 }
4856#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004857 if( status == PSA_SUCCESS )
4858 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004859 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004860 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004861 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004862 }
4863 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004864 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004865 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004866 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004867
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004868 return( status );
4869}
4870
Gilles Peskineeab56e42018-07-12 17:12:33 +02004871
4872
4873/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004874/* Key derivation */
4875/****************************************************************/
4876
John Durkop07cc04a2020-11-16 22:08:34 -08004877#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01004878static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004879 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004880 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004881{
John Durkop07cc04a2020-11-16 22:08:34 -08004882 int is_kdf_alg_supported;
4883
Janos Follath5fe19732019-06-20 15:09:30 +01004884 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4885 * initialisers for this union leave some bytes unspecified.) */
4886 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4887
Gilles Peskine969c5d62019-01-16 15:53:06 +01004888 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004889#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004890 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4891 is_kdf_alg_supported = 1;
4892 else
4893#endif
4894#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4895 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4896 is_kdf_alg_supported = 1;
4897 else
4898#endif
4899#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4900 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4901 is_kdf_alg_supported = 1;
4902 else
4903#endif
4904 is_kdf_alg_supported = 0;
4905
4906 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004907 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004908 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004909 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004910 if( hash_size == 0 )
4911 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004912 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4913 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004914 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004915 {
4916 return( PSA_ERROR_NOT_SUPPORTED );
4917 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004918 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004919 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004920 }
John Durkop07cc04a2020-11-16 22:08:34 -08004921
4922 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004923}
John Durkop07cc04a2020-11-16 22:08:34 -08004924#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004925
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004926psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004927 psa_algorithm_t alg )
4928{
4929 psa_status_t status;
4930
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004931 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004932 return( PSA_ERROR_BAD_STATE );
4933
Gilles Peskine6843c292019-01-18 16:44:49 +01004934 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4935 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08004936#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01004937 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004938 {
4939 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004940 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004941 }
4942 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4943 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004944 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004945 }
John Durkop07cc04a2020-11-16 22:08:34 -08004946#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004947 else
4948 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004949
4950 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004951 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004952 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004953}
4954
John Durkopd0321952020-10-29 21:37:36 -07004955#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004956static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004957 psa_algorithm_t hash_alg,
4958 psa_key_derivation_step_t step,
4959 const uint8_t *data,
4960 size_t data_length )
4961{
4962 psa_status_t status;
4963 switch( step )
4964 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004965 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004966 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004967 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004968 status = psa_hmac_setup_internal( &hkdf->hmac,
4969 data, data_length,
4970 hash_alg );
4971 if( status != PSA_SUCCESS )
4972 return( status );
4973 hkdf->state = HKDF_STATE_STARTED;
4974 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004975 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004976 /* If no salt was provided, use an empty salt. */
4977 if( hkdf->state == HKDF_STATE_INIT )
4978 {
4979 status = psa_hmac_setup_internal( &hkdf->hmac,
4980 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004981 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004982 if( status != PSA_SUCCESS )
4983 return( status );
4984 hkdf->state = HKDF_STATE_STARTED;
4985 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004986 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004987 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004988 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4989 data, data_length );
4990 if( status != PSA_SUCCESS )
4991 return( status );
4992 status = psa_hmac_finish_internal( &hkdf->hmac,
4993 hkdf->prk,
4994 sizeof( hkdf->prk ) );
4995 if( status != PSA_SUCCESS )
4996 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004997 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004998 hkdf->block_number = 0;
4999 hkdf->state = HKDF_STATE_KEYED;
5000 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005001 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005002 if( hkdf->state == HKDF_STATE_OUTPUT )
5003 return( PSA_ERROR_BAD_STATE );
5004 if( hkdf->info_set )
5005 return( PSA_ERROR_BAD_STATE );
5006 hkdf->info_length = data_length;
5007 if( data_length != 0 )
5008 {
5009 hkdf->info = mbedtls_calloc( 1, data_length );
5010 if( hkdf->info == NULL )
5011 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5012 memcpy( hkdf->info, data, data_length );
5013 }
5014 hkdf->info_set = 1;
5015 return( PSA_SUCCESS );
5016 default:
5017 return( PSA_ERROR_INVALID_ARGUMENT );
5018 }
5019}
John Durkop07cc04a2020-11-16 22:08:34 -08005020#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005021
John Durkop07cc04a2020-11-16 22:08:34 -08005022#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5023 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005024static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5025 const uint8_t *data,
5026 size_t data_length )
5027{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005028 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005029 return( PSA_ERROR_BAD_STATE );
5030
Janos Follathd6dce9f2019-07-04 09:11:38 +01005031 if( data_length != 0 )
5032 {
5033 prf->seed = mbedtls_calloc( 1, data_length );
5034 if( prf->seed == NULL )
5035 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005036
Janos Follathd6dce9f2019-07-04 09:11:38 +01005037 memcpy( prf->seed, data, data_length );
5038 prf->seed_length = data_length;
5039 }
Janos Follathf08e2652019-06-13 09:05:41 +01005040
Gilles Peskine43f958b2020-12-13 14:55:14 +01005041 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005042
5043 return( PSA_SUCCESS );
5044}
5045
Janos Follath81550542019-06-13 14:26:34 +01005046static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5047 psa_algorithm_t hash_alg,
5048 const uint8_t *data,
5049 size_t data_length )
5050{
5051 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01005052 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01005053 return( PSA_ERROR_BAD_STATE );
5054
5055 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5056 if( status != PSA_SUCCESS )
5057 return( status );
5058
Gilles Peskine43f958b2020-12-13 14:55:14 +01005059 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005060
5061 return( PSA_SUCCESS );
5062}
5063
Janos Follath63028dd2019-06-13 09:15:47 +01005064static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5065 const uint8_t *data,
5066 size_t data_length )
5067{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005068 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005069 return( PSA_ERROR_BAD_STATE );
5070
Janos Follathd6dce9f2019-07-04 09:11:38 +01005071 if( data_length != 0 )
5072 {
5073 prf->label = mbedtls_calloc( 1, data_length );
5074 if( prf->label == NULL )
5075 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005076
Janos Follathd6dce9f2019-07-04 09:11:38 +01005077 memcpy( prf->label, data, data_length );
5078 prf->label_length = data_length;
5079 }
Janos Follath63028dd2019-06-13 09:15:47 +01005080
Gilles Peskine43f958b2020-12-13 14:55:14 +01005081 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005082
5083 return( PSA_SUCCESS );
5084}
5085
Janos Follathb03233e2019-06-11 15:30:30 +01005086static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5087 psa_algorithm_t hash_alg,
5088 psa_key_derivation_step_t step,
5089 const uint8_t *data,
5090 size_t data_length )
5091{
Janos Follathb03233e2019-06-11 15:30:30 +01005092 switch( step )
5093 {
Janos Follathf08e2652019-06-13 09:05:41 +01005094 case PSA_KEY_DERIVATION_INPUT_SEED:
5095 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005096 case PSA_KEY_DERIVATION_INPUT_SECRET:
5097 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005098 case PSA_KEY_DERIVATION_INPUT_LABEL:
5099 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005100 default:
5101 return( PSA_ERROR_INVALID_ARGUMENT );
5102 }
5103}
John Durkop07cc04a2020-11-16 22:08:34 -08005104#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5105 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5106
5107#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5108static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5109 psa_tls12_prf_key_derivation_t *prf,
5110 psa_algorithm_t hash_alg,
5111 const uint8_t *data,
5112 size_t data_length )
5113{
5114 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005115 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005116 uint8_t *cur = pms;
5117
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005118 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005119 return( PSA_ERROR_INVALID_ARGUMENT );
5120
5121 /* Quoting RFC 4279, Section 2:
5122 *
5123 * The premaster secret is formed as follows: if the PSK is N octets
5124 * long, concatenate a uint16 with the value N, N zero octets, a second
5125 * uint16 with the value N, and the PSK itself.
5126 */
5127
5128 *cur++ = ( data_length >> 8 ) & 0xff;
5129 *cur++ = ( data_length >> 0 ) & 0xff;
5130 memset( cur, 0, data_length );
5131 cur += data_length;
5132 *cur++ = pms[0];
5133 *cur++ = pms[1];
5134 memcpy( cur, data, data_length );
5135 cur += data_length;
5136
5137 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5138
5139 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5140 return( status );
5141}
Janos Follath6660f0e2019-06-17 08:44:03 +01005142
5143static psa_status_t psa_tls12_prf_psk_to_ms_input(
5144 psa_tls12_prf_key_derivation_t *prf,
5145 psa_algorithm_t hash_alg,
5146 psa_key_derivation_step_t step,
5147 const uint8_t *data,
5148 size_t data_length )
5149{
5150 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005151 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005152 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5153 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005154 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005155
5156 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5157}
John Durkop07cc04a2020-11-16 22:08:34 -08005158#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005159
Gilles Peskineb8965192019-09-24 16:21:10 +02005160/** Check whether the given key type is acceptable for the given
5161 * input step of a key derivation.
5162 *
5163 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5164 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5165 * Both secret and non-secret inputs can alternatively have the type
5166 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5167 * that the input was passed as a buffer rather than via a key object.
5168 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005169static int psa_key_derivation_check_input_type(
5170 psa_key_derivation_step_t step,
5171 psa_key_type_t key_type )
5172{
5173 switch( step )
5174 {
5175 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005176 if( key_type == PSA_KEY_TYPE_DERIVE )
5177 return( PSA_SUCCESS );
5178 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005179 return( PSA_SUCCESS );
5180 break;
5181 case PSA_KEY_DERIVATION_INPUT_LABEL:
5182 case PSA_KEY_DERIVATION_INPUT_SALT:
5183 case PSA_KEY_DERIVATION_INPUT_INFO:
5184 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005185 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5186 return( PSA_SUCCESS );
5187 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005188 return( PSA_SUCCESS );
5189 break;
5190 }
5191 return( PSA_ERROR_INVALID_ARGUMENT );
5192}
5193
Janos Follathb80a94e2019-06-12 15:54:46 +01005194static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005195 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005196 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005197 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005198 const uint8_t *data,
5199 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005200{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005201 psa_status_t status;
5202 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5203
5204 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005205 if( status != PSA_SUCCESS )
5206 goto exit;
5207
John Durkopd0321952020-10-29 21:37:36 -07005208#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005209 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005210 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005211 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005212 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005213 step, data, data_length );
5214 }
John Durkop07cc04a2020-11-16 22:08:34 -08005215 else
5216#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5217#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5218 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005219 {
Janos Follathb03233e2019-06-11 15:30:30 +01005220 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5221 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5222 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005223 }
John Durkop07cc04a2020-11-16 22:08:34 -08005224 else
5225#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5226#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5227 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005228 {
5229 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5230 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5231 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005232 }
5233 else
John Durkop07cc04a2020-11-16 22:08:34 -08005234#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005235 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005236 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005237 (void) data;
5238 (void) data_length;
5239 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005240 return( PSA_ERROR_BAD_STATE );
5241 }
5242
Gilles Peskine224b0d62019-09-23 18:13:17 +02005243exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005244 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005245 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005246 return( status );
5247}
5248
Janos Follath51f4a0f2019-06-14 11:35:55 +01005249psa_status_t psa_key_derivation_input_bytes(
5250 psa_key_derivation_operation_t *operation,
5251 psa_key_derivation_step_t step,
5252 const uint8_t *data,
5253 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005254{
Gilles Peskineb8965192019-09-24 16:21:10 +02005255 return( psa_key_derivation_input_internal( operation, step,
5256 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005257 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005258}
5259
Janos Follath51f4a0f2019-06-14 11:35:55 +01005260psa_status_t psa_key_derivation_input_key(
5261 psa_key_derivation_operation_t *operation,
5262 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005263 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005264{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005266 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005267 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005268
Ronald Cron5c522922020-11-14 16:35:34 +01005269 status = psa_get_and_lock_transparent_key_slot_with_policy(
5270 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005271 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005272 {
5273 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005274 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005275 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005276
5277 /* Passing a key object as a SECRET input unlocks the permission
5278 * to output to a key object. */
5279 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5280 operation->can_output_key = 1;
5281
Ronald Cronf95a2b12020-10-22 15:24:49 +02005282 status = psa_key_derivation_input_internal( operation,
5283 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005284 slot->key.data,
5285 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005286
Ronald Cron5c522922020-11-14 16:35:34 +01005287 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005288
Ronald Cron5c522922020-11-14 16:35:34 +01005289 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005290}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005291
5292
5293
5294/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005295/* Key agreement */
5296/****************************************************************/
5297
John Durkop6ba40d12020-11-10 08:50:04 -08005298#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005299static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5300 size_t peer_key_length,
5301 const mbedtls_ecp_keypair *our_key,
5302 uint8_t *shared_secret,
5303 size_t shared_secret_size,
5304 size_t *shared_secret_length )
5305{
Steven Cooremand4867872020-08-05 16:31:39 +02005306 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005307 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005308 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005309 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005310 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005311 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005312
Ronald Cron90857082020-11-25 14:58:33 +01005313 status = mbedtls_psa_ecp_load_representation(
5314 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005315 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005316 peer_key,
5317 peer_key_length,
5318 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005319 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005320 goto exit;
5321
Jaeden Amero97271b32019-01-10 19:38:51 +00005322 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005323 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005324 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005325 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005326 status = mbedtls_to_psa_error(
5327 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5328 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005329 goto exit;
5330
Jaeden Amero97271b32019-01-10 19:38:51 +00005331 status = mbedtls_to_psa_error(
5332 mbedtls_ecdh_calc_secret( &ecdh,
5333 shared_secret_length,
5334 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005335 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005336 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005337 if( status != PSA_SUCCESS )
5338 goto exit;
5339 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5340 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005341
5342exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005343 if( status != PSA_SUCCESS )
5344 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005345 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005346 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005347 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005348
Jaeden Amero97271b32019-01-10 19:38:51 +00005349 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005350}
John Durkop6ba40d12020-11-10 08:50:04 -08005351#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005352
Gilles Peskine01d718c2018-09-18 12:01:02 +02005353#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5354
Gilles Peskine0216fe12019-04-11 21:23:21 +02005355static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5356 psa_key_slot_t *private_key,
5357 const uint8_t *peer_key,
5358 size_t peer_key_length,
5359 uint8_t *shared_secret,
5360 size_t shared_secret_size,
5361 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005362{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005363 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005364 {
John Durkop6ba40d12020-11-10 08:50:04 -08005365#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005366 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005367 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005368 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005369 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005370 psa_status_t status = mbedtls_psa_ecp_load_representation(
5371 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005372 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005373 private_key->key.data,
5374 private_key->key.bytes,
5375 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005376 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005377 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005378 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005379 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005380 shared_secret, shared_secret_size,
5381 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005382 mbedtls_ecp_keypair_free( ecp );
5383 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005384 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005385#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005386 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005387 (void) private_key;
5388 (void) peer_key;
5389 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005390 (void) shared_secret;
5391 (void) shared_secret_size;
5392 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005393 return( PSA_ERROR_NOT_SUPPORTED );
5394 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005395}
5396
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005397/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005398 * to potentially free embedded data structures and wipe confidential data.
5399 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005400static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005401 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005402 psa_key_slot_t *private_key,
5403 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005404 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005405{
5406 psa_status_t status;
5407 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5408 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005409 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005410
5411 /* Step 1: run the secret agreement algorithm to generate the shared
5412 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005413 status = psa_key_agreement_raw_internal( ka_alg,
5414 private_key,
5415 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005416 shared_secret,
5417 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005418 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005419 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005420 goto exit;
5421
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005422 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005423 * the shared secret. A shared secret is permitted wherever a key
5424 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005425 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005426 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005427 shared_secret,
5428 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005429exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005430 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005431 return( status );
5432}
5433
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005434psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005435 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005436 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005437 const uint8_t *peer_key,
5438 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005439{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005440 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005441 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005442 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005443
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005444 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005445 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005446 status = psa_get_and_lock_transparent_key_slot_with_policy(
5447 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005448 if( status != PSA_SUCCESS )
5449 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005450 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005451 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005452 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005453 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005454 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005455 else
5456 {
5457 /* If a private key has been added as SECRET, we allow the derived
5458 * key material to be used as a key in PSA Crypto. */
5459 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5460 operation->can_output_key = 1;
5461 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005462
Ronald Cron5c522922020-11-14 16:35:34 +01005463 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005464
Ronald Cron5c522922020-11-14 16:35:34 +01005465 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005466}
5467
Gilles Peskinebe697d82019-05-16 18:00:41 +02005468psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005469 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005470 const uint8_t *peer_key,
5471 size_t peer_key_length,
5472 uint8_t *output,
5473 size_t output_size,
5474 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005475{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005476 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005477 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005478 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005479
5480 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5481 {
5482 status = PSA_ERROR_INVALID_ARGUMENT;
5483 goto exit;
5484 }
Ronald Cron5c522922020-11-14 16:35:34 +01005485 status = psa_get_and_lock_transparent_key_slot_with_policy(
5486 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005487 if( status != PSA_SUCCESS )
5488 goto exit;
5489
5490 status = psa_key_agreement_raw_internal( alg, slot,
5491 peer_key, peer_key_length,
5492 output, output_size,
5493 output_length );
5494
5495exit:
5496 if( status != PSA_SUCCESS )
5497 {
5498 /* If an error happens and is not handled properly, the output
5499 * may be used as a key to protect sensitive data. Arrange for such
5500 * a key to be random, which is likely to result in decryption or
5501 * verification errors. This is better than filling the buffer with
5502 * some constant data such as zeros, which would result in the data
5503 * being protected with a reproducible, easily knowable key.
5504 */
5505 psa_generate_random( output, output_size );
5506 *output_length = output_size;
5507 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005508
Ronald Cron5c522922020-11-14 16:35:34 +01005509 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005510
Ronald Cron5c522922020-11-14 16:35:34 +01005511 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005512}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005513
5514
Gilles Peskine30524eb2020-11-13 17:02:26 +01005515
Gilles Peskine86a440b2018-11-12 18:39:40 +01005516/****************************************************************/
5517/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005518/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005519
Gilles Peskine30524eb2020-11-13 17:02:26 +01005520/** Initialize the PSA random generator.
5521 */
5522static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5523{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005524#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5525 memset( rng, 0, sizeof( *rng ) );
5526#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5527
Gilles Peskine30524eb2020-11-13 17:02:26 +01005528 /* Set default configuration if
5529 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5530 if( rng->entropy_init == NULL )
5531 rng->entropy_init = mbedtls_entropy_init;
5532 if( rng->entropy_free == NULL )
5533 rng->entropy_free = mbedtls_entropy_free;
5534
5535 rng->entropy_init( &rng->entropy );
5536#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5537 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5538 /* The PSA entropy injection feature depends on using NV seed as an entropy
5539 * source. Add NV seed as an entropy source for PSA entropy injection. */
5540 mbedtls_entropy_add_source( &rng->entropy,
5541 mbedtls_nv_seed_poll, NULL,
5542 MBEDTLS_ENTROPY_BLOCK_SIZE,
5543 MBEDTLS_ENTROPY_SOURCE_STRONG );
5544#endif
5545
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005546 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005547#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005548}
5549
5550/** Deinitialize the PSA random generator.
5551 */
5552static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5553{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005554#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5555 memset( rng, 0, sizeof( *rng ) );
5556#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005557 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005558 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005559#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005560}
5561
5562/** Seed the PSA random generator.
5563 */
5564static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5565{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005566#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5567 /* Do nothing: the external RNG seeds itself. */
5568 (void) rng;
5569 return( PSA_SUCCESS );
5570#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005571 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005572 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5573 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005574 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005575#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005576}
5577
Gilles Peskinee59236f2018-01-27 23:32:46 +01005578psa_status_t psa_generate_random( uint8_t *output,
5579 size_t output_size )
5580{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005581 GUARD_MODULE_INITIALIZED;
5582
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005583#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5584
5585 size_t output_length = 0;
5586 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5587 output, output_size,
5588 &output_length );
5589 if( status != PSA_SUCCESS )
5590 return( status );
5591 /* Breaking up a request into smaller chunks is currently not supported
5592 * for the extrernal RNG interface. */
5593 if( output_length != output_size )
5594 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5595 return( PSA_SUCCESS );
5596
5597#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5598
Gilles Peskine71ddab92021-01-04 21:01:07 +01005599 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005600 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005601 size_t request_size =
5602 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5603 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5604 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005605 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5606 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005607 if( ret != 0 )
5608 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005609 output_size -= request_size;
5610 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005611 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005612 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005613#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005614}
5615
Gilles Peskine8814fc42020-12-14 15:33:44 +01005616/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005617 *
5618 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5619 * `psa_generate_random(...)`. The state parameter is ignored since the
5620 * PSA API doesn't support passing an explicit state.
5621 *
5622 * In the non-external case, psa_generate_random() calls an
5623 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5624 * and semantics as mbedtls_psa_get_random(). As an optimization,
5625 * instead of doing this back-and-forth between the PSA API and the
5626 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5627 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005628 */
5629#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5630int mbedtls_psa_get_random( void *p_rng,
5631 unsigned char *output,
5632 size_t output_size )
5633{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005634 /* This function takes a pointer to the RNG state because that's what
5635 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5636 * its own state internally and doesn't let the caller access that state.
5637 * So we just ignore the state parameter, and in practice we'll pass
5638 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005639 (void) p_rng;
5640 psa_status_t status = psa_generate_random( output, output_size );
5641 if( status == PSA_SUCCESS )
5642 return( 0 );
5643 else
5644 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5645}
5646#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5647
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005648#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5649#include "mbedtls/entropy_poll.h"
5650
Gilles Peskine7228da22019-07-15 11:06:15 +02005651psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005652 size_t seed_size )
5653{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005654 if( global_data.initialized )
5655 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005656
5657 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5658 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5659 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5660 return( PSA_ERROR_INVALID_ARGUMENT );
5661
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005662 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005663}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005664#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005665
Ronald Cron3772afe2021-02-08 16:10:05 +01005666/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005667 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005668 * \param type The key type
5669 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005670 *
5671 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005672 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005673 * \retval #PSA_ERROR_INVALID_ARGUMENT
5674 * The size in bits of the key is not valid.
5675 * \retval #PSA_ERROR_NOT_SUPPORTED
5676 * The type and/or the size in bits of the key or the combination of
5677 * the two is not supported.
5678 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005679static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5680 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005681{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005683
Gilles Peskinee59236f2018-01-27 23:32:46 +01005684 if( key_type_is_raw_bytes( type ) )
5685 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005686 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005687 if( status != PSA_SUCCESS )
5688 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005689 }
5690 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005691#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005692 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5693 {
5694 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5695 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005696
Ronald Cron01b2aba2020-10-05 09:42:02 +02005697 /* Accept only byte-aligned keys, for the same reasons as
5698 * in psa_import_rsa_key(). */
5699 if( bits % 8 != 0 )
5700 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005701 }
5702 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005703#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005704
Ronald Cron5c4d3862020-12-07 11:07:24 +01005705#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005706 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5707 {
Ronald Crond81ab562021-02-16 09:01:16 +01005708 /* To avoid empty block, return successfully here. */
5709 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005710 }
5711 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005712#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005713 {
5714 return( PSA_ERROR_NOT_SUPPORTED );
5715 }
5716
5717 return( PSA_SUCCESS );
5718}
5719
Ronald Cron55ed0592020-10-05 10:30:40 +02005720psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005721 const psa_key_attributes_t *attributes,
5722 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005723{
5724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005725 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005726
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005727 if( ( attributes->domain_parameters == NULL ) &&
5728 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005729 return( PSA_ERROR_INVALID_ARGUMENT );
5730
Ronald Cron01b2aba2020-10-05 09:42:02 +02005731 if( key_type_is_raw_bytes( type ) )
5732 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005733 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005734 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005735 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005736
Gilles Peskinee59236f2018-01-27 23:32:46 +01005737#if defined(MBEDTLS_DES_C)
5738 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005739 psa_des_set_key_parity( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005740#endif /* MBEDTLS_DES_C */
5741 }
5742 else
5743
John Durkop07cc04a2020-11-16 22:08:34 -08005744#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005745 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005746 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005747 return( mbedtls_psa_rsa_generate_key( attributes,
5748 key_buffer,
5749 key_buffer_size,
5750 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005751 }
5752 else
John Durkop07cc04a2020-11-16 22:08:34 -08005753#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005754
John Durkop9814fa22020-11-04 12:28:15 -08005755#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005756 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005757 {
Ronald Cron7023db52020-11-20 18:17:42 +01005758 return( mbedtls_psa_ecp_generate_key( attributes,
5759 key_buffer,
5760 key_buffer_size,
5761 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005762 }
5763 else
John Durkop9814fa22020-11-04 12:28:15 -08005764#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005765 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005766 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005767 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005768 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005769
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005770 return( PSA_SUCCESS );
5771}
Darryl Green0c6575a2018-11-07 16:05:30 +00005772
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005773psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005774 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005775{
5776 psa_status_t status;
5777 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005778 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005779 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005780
Ronald Cron81709fc2020-11-14 12:10:32 +01005781 *key = MBEDTLS_SVC_KEY_ID_INIT;
5782
Gilles Peskine0f84d622019-09-12 19:03:13 +02005783 /* Reject any attempt to create a zero-length key so that we don't
5784 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5785 if( psa_get_key_bits( attributes ) == 0 )
5786 return( PSA_ERROR_INVALID_ARGUMENT );
5787
Ronald Cron81709fc2020-11-14 12:10:32 +01005788 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5789 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005790 if( status != PSA_SUCCESS )
5791 goto exit;
5792
Ronald Cron977c2472020-10-13 08:32:21 +02005793 /* In the case of a transparent key or an opaque key stored in local
5794 * storage (thus not in the case of generating a key in a secure element
5795 * or cryptoprocessor with storage), we have to allocate a buffer to
5796 * hold the generated key material. */
5797 if( slot->key.data == NULL )
5798 {
5799 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5800 PSA_KEY_LOCATION_LOCAL_STORAGE )
5801 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005802 status = psa_validate_key_type_and_size_for_key_generation(
5803 attributes->core.type, attributes->core.bits );
5804 if( status != PSA_SUCCESS )
5805 goto exit;
5806
5807 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5808 attributes->core.type,
5809 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005810 }
5811 else
5812 {
5813 status = psa_driver_wrapper_get_key_buffer_size(
5814 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005815 if( status != PSA_SUCCESS )
5816 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005817 }
Ronald Cron977c2472020-10-13 08:32:21 +02005818
5819 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5820 if( status != PSA_SUCCESS )
5821 goto exit;
5822 }
5823
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005824 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005825 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005826
Ronald Cron2b56bc82020-10-05 10:02:26 +02005827 if( status != PSA_SUCCESS )
5828 psa_remove_key_data_from_memory( slot );
5829
Gilles Peskine11792082019-08-06 18:36:36 +02005830exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005831 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005832 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005833 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005834 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005835
Darryl Green0c6575a2018-11-07 16:05:30 +00005836 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005837}
5838
Gilles Peskinee59236f2018-01-27 23:32:46 +01005839/****************************************************************/
5840/* Module setup */
5841/****************************************************************/
5842
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005843#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005844psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5845 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5846 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5847{
5848 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5849 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005850 global_data.rng.entropy_init = entropy_init;
5851 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005852 return( PSA_SUCCESS );
5853}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005854#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005855
Gilles Peskinee59236f2018-01-27 23:32:46 +01005856void mbedtls_psa_crypto_free( void )
5857{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005858 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005859 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5860 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005861 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005862 }
5863 /* Wipe all remaining data, including configuration.
5864 * In particular, this sets all state indicator to the value
5865 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005866 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005867#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005868 /* Unregister all secure element drivers, so that we restart from
5869 * a pristine state. */
5870 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005871#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005872}
5873
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005874#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5875/** Recover a transaction that was interrupted by a power failure.
5876 *
5877 * This function is called during initialization, before psa_crypto_init()
5878 * returns. If this function returns a failure status, the initialization
5879 * fails.
5880 */
5881static psa_status_t psa_crypto_recover_transaction(
5882 const psa_crypto_transaction_t *transaction )
5883{
5884 switch( transaction->unknown.type )
5885 {
5886 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5887 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005888 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005889 * is implemented.
5890 * https://github.com/ARMmbed/mbed-crypto/issues/218
5891 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005892 default:
5893 /* We found an unsupported transaction in the storage.
5894 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005895 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005896 }
5897}
5898#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5899
Gilles Peskinee59236f2018-01-27 23:32:46 +01005900psa_status_t psa_crypto_init( void )
5901{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005902 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005903
Gilles Peskinec6b69072018-11-20 21:42:52 +01005904 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005905 if( global_data.initialized != 0 )
5906 return( PSA_SUCCESS );
5907
Gilles Peskine30524eb2020-11-13 17:02:26 +01005908 /* Initialize and seed the random generator. */
5909 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005910 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005911 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005912 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005913 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005914 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005915
Gilles Peskine66fb1262018-12-10 16:29:04 +01005916 status = psa_initialize_key_slots( );
5917 if( status != PSA_SUCCESS )
5918 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005919
Gilles Peskined9348f22019-10-01 15:22:29 +02005920#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5921 status = psa_init_all_se_drivers( );
5922 if( status != PSA_SUCCESS )
5923 goto exit;
5924#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5925
Gilles Peskine4b734222019-07-24 15:56:31 +02005926#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005927 status = psa_crypto_load_transaction( );
5928 if( status == PSA_SUCCESS )
5929 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005930 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5931 if( status != PSA_SUCCESS )
5932 goto exit;
5933 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005934 }
5935 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5936 {
5937 /* There's no transaction to complete. It's all good. */
5938 status = PSA_SUCCESS;
5939 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005940#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005941
Gilles Peskinec6b69072018-11-20 21:42:52 +01005942 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005943 global_data.initialized = 1;
5944
5945exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005946 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005947 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005948 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005949}
5950
5951#endif /* MBEDTLS_PSA_CRYPTO_C */