blob: a39c5353f241dff4322c1f2f68953a4b4a64e085 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
36#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010037#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020038#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020039#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010041#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010042/* Include internal declarations that are useful for implementing persistently
43 * stored keys. */
44#include "psa_crypto_storage.h"
45
Gilles Peskineb2b64d32020-12-14 16:43:58 +010046#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010047
Gilles Peskineb46bef22019-07-30 21:32:04 +020048#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010049#include <stdlib.h>
50#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020052#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#define mbedtls_calloc calloc
54#define mbedtls_free free
55#endif
56
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010057#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010058#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020059#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000060#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020061#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010062#include "mbedtls/blowfish.h"
63#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
75#include "mbedtls/md2.h"
76#include "mbedtls/md4.h"
77#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010078#include "mbedtls/md.h"
79#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010080#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010081#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010082#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000083#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010085#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010086#include "mbedtls/sha1.h"
87#include "mbedtls/sha256.h"
88#include "mbedtls/sha512.h"
89#include "mbedtls/xtea.h"
90
Gilles Peskine996deb12018-08-01 15:45:45 +020091#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
92
Gilles Peskine9ef733f2018-02-07 21:05:37 +010093/* constant-time buffer comparison */
94static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
95{
96 size_t i;
97 unsigned char diff = 0;
98
99 for( i = 0; i < n; i++ )
100 diff |= a[i] ^ b[i];
101
102 return( diff );
103}
104
105
106
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100107/****************************************************************/
108/* Global data, support functions and library management */
109/****************************************************************/
110
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200111static int key_type_is_raw_bytes( psa_key_type_t type )
112{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200113 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200114}
115
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100116/* Values for psa_global_data_t::rng_state */
117#define RNG_NOT_INITIALIZED 0
118#define RNG_INITIALIZED 1
119#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100120
Gilles Peskine2d277862018-06-18 15:41:12 +0200121typedef struct
122{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100123 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100124 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100125 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100126} psa_global_data_t;
127
128static psa_global_data_t global_data;
129
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100130#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
131mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
132 &global_data.rng.drbg;
133#endif
134
itayzafrir0adf0fc2018-09-06 16:24:41 +0300135#define GUARD_MODULE_INITIALIZED \
136 if( global_data.initialized == 0 ) \
137 return( PSA_ERROR_BAD_STATE );
138
Steven Cooreman01164162020-07-20 15:31:37 +0200139psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100140{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100141 /* Mbed TLS error codes can combine a high-level error code and a
142 * low-level error code. The low-level error usually reflects the
143 * root cause better, so dispatch on that preferably. */
144 int low_level_ret = - ( -ret & 0x007f );
145 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100146 {
147 case 0:
148 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100149
150 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
151 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
152 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
153 return( PSA_ERROR_NOT_SUPPORTED );
154 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
155 return( PSA_ERROR_HARDWARE_FAILURE );
156
157 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
158 return( PSA_ERROR_HARDWARE_FAILURE );
159
Gilles Peskine9a944802018-06-21 09:35:35 +0200160 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
161 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
162 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
163 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
164 case MBEDTLS_ERR_ASN1_INVALID_DATA:
165 return( PSA_ERROR_INVALID_ARGUMENT );
166 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
167 return( PSA_ERROR_INSUFFICIENT_MEMORY );
168 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
169 return( PSA_ERROR_BUFFER_TOO_SMALL );
170
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000172 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
174 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
175#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
178 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
179 return( PSA_ERROR_HARDWARE_FAILURE );
180
Jaeden Amero93e21112019-02-20 13:57:28 +0000181#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000182 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000183#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
184 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
185#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100186 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
187 return( PSA_ERROR_NOT_SUPPORTED );
188 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
189 return( PSA_ERROR_HARDWARE_FAILURE );
190
191 case MBEDTLS_ERR_CCM_BAD_INPUT:
192 return( PSA_ERROR_INVALID_ARGUMENT );
193 case MBEDTLS_ERR_CCM_AUTH_FAILED:
194 return( PSA_ERROR_INVALID_SIGNATURE );
195 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
196 return( PSA_ERROR_HARDWARE_FAILURE );
197
Gilles Peskine26869f22019-05-06 15:25:00 +0200198 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
199 return( PSA_ERROR_INVALID_ARGUMENT );
200
201 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
202 return( PSA_ERROR_BAD_STATE );
203 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205
Gilles Peskinea5905292018-02-07 20:59:33 +0100206 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
207 return( PSA_ERROR_NOT_SUPPORTED );
208 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
209 return( PSA_ERROR_INVALID_ARGUMENT );
210 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
211 return( PSA_ERROR_INSUFFICIENT_MEMORY );
212 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
213 return( PSA_ERROR_INVALID_PADDING );
214 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200215 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100216 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
217 return( PSA_ERROR_INVALID_SIGNATURE );
218 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200219 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
221 return( PSA_ERROR_HARDWARE_FAILURE );
222
223 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
224 return( PSA_ERROR_HARDWARE_FAILURE );
225
Gilles Peskine82e57d12020-11-13 21:31:17 +0100226#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
227 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100228 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
229 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100230 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
231 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
232 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
233 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
234 return( PSA_ERROR_NOT_SUPPORTED );
235 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
236 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100237#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100238
239 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
240 return( PSA_ERROR_NOT_SUPPORTED );
241 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
242 return( PSA_ERROR_HARDWARE_FAILURE );
243
Gilles Peskinee59236f2018-01-27 23:32:46 +0100244 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
245 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
246 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100248
249 case MBEDTLS_ERR_GCM_AUTH_FAILED:
250 return( PSA_ERROR_INVALID_SIGNATURE );
251 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200252 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100253 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
254 return( PSA_ERROR_HARDWARE_FAILURE );
255
Gilles Peskine82e57d12020-11-13 21:31:17 +0100256#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
257 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100258 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
259 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100260 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
261 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
262 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
263 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
264 return( PSA_ERROR_NOT_SUPPORTED );
265 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
266 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
267#endif
268
Gilles Peskinea5905292018-02-07 20:59:33 +0100269 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
270 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
271 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
272 return( PSA_ERROR_HARDWARE_FAILURE );
273
274 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
275 return( PSA_ERROR_NOT_SUPPORTED );
276 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
277 return( PSA_ERROR_INVALID_ARGUMENT );
278 case MBEDTLS_ERR_MD_ALLOC_FAILED:
279 return( PSA_ERROR_INSUFFICIENT_MEMORY );
280 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
281 return( PSA_ERROR_STORAGE_FAILURE );
282 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
283 return( PSA_ERROR_HARDWARE_FAILURE );
284
Gilles Peskinef76aa772018-10-29 19:24:33 +0100285 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
286 return( PSA_ERROR_STORAGE_FAILURE );
287 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
290 return( PSA_ERROR_INVALID_ARGUMENT );
291 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
292 return( PSA_ERROR_BUFFER_TOO_SMALL );
293 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
294 return( PSA_ERROR_INVALID_ARGUMENT );
295 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
296 return( PSA_ERROR_INVALID_ARGUMENT );
297 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
298 return( PSA_ERROR_INVALID_ARGUMENT );
299 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
300 return( PSA_ERROR_INSUFFICIENT_MEMORY );
301
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100302 case MBEDTLS_ERR_PK_ALLOC_FAILED:
303 return( PSA_ERROR_INSUFFICIENT_MEMORY );
304 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
305 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100308 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100309 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
310 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
311 return( PSA_ERROR_INVALID_ARGUMENT );
312 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
313 return( PSA_ERROR_NOT_SUPPORTED );
314 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
315 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
316 return( PSA_ERROR_NOT_PERMITTED );
317 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
318 return( PSA_ERROR_INVALID_ARGUMENT );
319 case MBEDTLS_ERR_PK_INVALID_ALG:
320 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
321 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
322 return( PSA_ERROR_NOT_SUPPORTED );
323 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
324 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100325 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
326 return( PSA_ERROR_HARDWARE_FAILURE );
327
Gilles Peskineff2d2002019-05-06 15:26:23 +0200328 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
331 return( PSA_ERROR_NOT_SUPPORTED );
332
Gilles Peskinea5905292018-02-07 20:59:33 +0100333 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
334 return( PSA_ERROR_HARDWARE_FAILURE );
335
336 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
337 return( PSA_ERROR_INVALID_ARGUMENT );
338 case MBEDTLS_ERR_RSA_INVALID_PADDING:
339 return( PSA_ERROR_INVALID_PADDING );
340 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
341 return( PSA_ERROR_HARDWARE_FAILURE );
342 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
343 return( PSA_ERROR_INVALID_ARGUMENT );
344 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
345 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200346 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100347 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
348 return( PSA_ERROR_INVALID_SIGNATURE );
349 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
350 return( PSA_ERROR_BUFFER_TOO_SMALL );
351 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100352 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100353 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
354 return( PSA_ERROR_NOT_SUPPORTED );
355 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
356 return( PSA_ERROR_HARDWARE_FAILURE );
357
358 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
359 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
360 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
361 return( PSA_ERROR_HARDWARE_FAILURE );
362
363 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
364 return( PSA_ERROR_INVALID_ARGUMENT );
365 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
366 return( PSA_ERROR_HARDWARE_FAILURE );
367
itayzafrir5c753392018-05-08 11:18:38 +0300368 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300369 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300370 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
372 return( PSA_ERROR_BUFFER_TOO_SMALL );
373 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
374 return( PSA_ERROR_NOT_SUPPORTED );
375 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
376 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
377 return( PSA_ERROR_INVALID_SIGNATURE );
378 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
379 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100380 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
381 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300382 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
383 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100384
Janos Follatha13b9052019-11-22 12:48:59 +0000385 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
386 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300387
Gilles Peskinee59236f2018-01-27 23:32:46 +0100388 default:
David Saadab4ecc272019-02-14 13:48:10 +0200389 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100390 }
391}
392
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200393
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200394
395
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100396/****************************************************************/
397/* Key management */
398/****************************************************************/
399
Gilles Peskine73167e12019-07-12 23:44:37 +0200400#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
401static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
402{
Gilles Peskine8e338702019-07-30 20:06:31 +0200403 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200404}
405#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
406
John Durkop07cc04a2020-11-16 22:08:34 -0800407/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
408 * current test driver in key_management.c is using this function
409 * when accelerators are used for ECC key pair and public key.
410 * Once that dependency is resolved these guards can be removed.
411 */
John Durkop9814fa22020-11-04 12:28:15 -0800412#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800413 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
414 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
415 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100416mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100417 size_t bits,
418 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200419{
420 switch( curve )
421 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100422 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100429 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100430 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100432 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100433 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100434 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100435 case 528:
436 if( bits_is_sloppy )
437 return( MBEDTLS_ECP_DP_SECP521R1 );
438 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 }
440 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100441
Paul Elliott8ff510a2020-06-02 17:19:28 +0100442 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100443 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100444 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100445 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100446 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100447 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100448 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100449 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100450 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100451 }
452 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100453
Paul Elliott8ff510a2020-06-02 17:19:28 +0100454 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100455 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100456 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100457 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100458 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100459 case 256:
460 if( bits_is_sloppy )
461 return( MBEDTLS_ECP_DP_CURVE25519 );
462 break;
463 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100464 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100465 }
466 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100467
Paul Elliott8ff510a2020-06-02 17:19:28 +0100468 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100469 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100470 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100471 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100472 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100473 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100474 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100475 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100476 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100477 }
478 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200479 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100480
481 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200482}
John Durkop9814fa22020-11-04 12:28:15 -0800483#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800484 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
485 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
486 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200487
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200488static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
489 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490{
491 /* Check that the bit size is acceptable for the key type */
492 switch( type )
493 {
494 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200495 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200496 case PSA_KEY_TYPE_DERIVE:
497 break;
David Browne04acc22021-01-26 11:39:16 -0700498#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200499 case PSA_KEY_TYPE_AES:
500 if( bits != 128 && bits != 192 && bits != 256 )
501 return( PSA_ERROR_INVALID_ARGUMENT );
502 break;
503#endif
David Browne04acc22021-01-26 11:39:16 -0700504#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200505 case PSA_KEY_TYPE_CAMELLIA:
506 if( bits != 128 && bits != 192 && bits != 256 )
507 return( PSA_ERROR_INVALID_ARGUMENT );
508 break;
509#endif
David Browne04acc22021-01-26 11:39:16 -0700510#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200511 case PSA_KEY_TYPE_DES:
512 if( bits != 64 && bits != 128 && bits != 192 )
513 return( PSA_ERROR_INVALID_ARGUMENT );
514 break;
515#endif
David Browne04acc22021-01-26 11:39:16 -0700516#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200517 case PSA_KEY_TYPE_ARC4:
518 if( bits < 8 || bits > 2048 )
519 return( PSA_ERROR_INVALID_ARGUMENT );
520 break;
521#endif
David Brown1bfe4d72021-02-16 12:54:35 -0700522#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200523 case PSA_KEY_TYPE_CHACHA20:
524 if( bits != 256 )
525 return( PSA_ERROR_INVALID_ARGUMENT );
526 break;
527#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200528 default:
529 return( PSA_ERROR_NOT_SUPPORTED );
530 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200531 if( bits % 8 != 0 )
532 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200533
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200534 return( PSA_SUCCESS );
535}
536
Gilles Peskineb46bef22019-07-30 21:32:04 +0200537/** Return the size of the key in the given slot, in bits.
538 *
539 * \param[in] slot A key slot.
540 *
541 * \return The key size in bits, read from the metadata in the slot.
542 */
543static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
544{
545 return( slot->attr.bits );
546}
547
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100548/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100549 *
Steven Cooremancd640932021-03-08 12:00:27 +0100550 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
551 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100552 *
553 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100554 * \param[in] key_type The key type of the key to be used with the
555 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100556 *
557 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100558 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100559 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100560 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100561 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100562MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100563 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100564 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100565{
Steven Cooremancd640932021-03-08 12:00:27 +0100566 if( PSA_ALG_IS_HMAC( algorithm ) )
567 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100568 if( key_type == PSA_KEY_TYPE_HMAC )
569 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100570 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100571
572 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100573 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100574 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
575 * key. */
576 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
577 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
578 {
579 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
580 * the block length (larger than 1) for block ciphers. */
581 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
582 return( PSA_SUCCESS );
583 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100584 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100585
586 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100587}
588
Steven Cooreman75b74362020-07-28 14:30:13 +0200589/** Try to allocate a buffer to an empty key slot.
590 *
591 * \param[in,out] slot Key slot to attach buffer to.
592 * \param[in] buffer_length Requested size of the buffer.
593 *
594 * \retval #PSA_SUCCESS
595 * The buffer has been successfully allocated.
596 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
597 * Not enough memory was available for allocation.
598 * \retval #PSA_ERROR_ALREADY_EXISTS
599 * Trying to allocate a buffer to a non-empty key slot.
600 */
601static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
602 size_t buffer_length )
603{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100604 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200605 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200606
Ronald Cronea0f8a62020-11-25 17:52:23 +0100607 slot->key.data = mbedtls_calloc( 1, buffer_length );
608 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200609 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200610
Ronald Cronea0f8a62020-11-25 17:52:23 +0100611 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200612 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200613}
614
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200615psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
616 const uint8_t* data,
617 size_t data_length )
618{
619 psa_status_t status = psa_allocate_buffer_to_slot( slot,
620 data_length );
621 if( status != PSA_SUCCESS )
622 return( status );
623
Ronald Cronea0f8a62020-11-25 17:52:23 +0100624 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200625 return( PSA_SUCCESS );
626}
627
Ronald Crona0fe59f2020-11-29 11:14:53 +0100628psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100629 const psa_key_attributes_t *attributes,
630 const uint8_t *data, size_t data_length,
631 uint8_t *key_buffer, size_t key_buffer_size,
632 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100633{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100634 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
635 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100636
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200637 /* zero-length keys are never supported. */
638 if( data_length == 0 )
639 return( PSA_ERROR_NOT_SUPPORTED );
640
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100641 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100642 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100643 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200644
Steven Cooreman75b74362020-07-28 14:30:13 +0200645 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
646 if( data_length > SIZE_MAX / 8 )
647 return( PSA_ERROR_NOT_SUPPORTED );
648
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200649 /* Enforce a size limit, and in particular ensure that the bit
650 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100651 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200652 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200653
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100654 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200655 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200656 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200657
Ronald Crondd04d422020-11-28 15:14:42 +0100658 /* Copy the key material. */
659 memcpy( key_buffer, data, data_length );
660 *key_buffer_length = data_length;
661 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200662
Steven Cooreman40120f62020-10-29 11:42:22 +0100663 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100664 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100665 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200666 {
John Durkop9814fa22020-11-04 12:28:15 -0800667#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
668 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100669 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200670 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100671 return( mbedtls_psa_ecp_import_key( attributes,
672 data, data_length,
673 key_buffer, key_buffer_size,
674 key_buffer_length,
675 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100676 }
John Durkop9814fa22020-11-04 12:28:15 -0800677#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
678 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700679#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
680 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100681 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200682 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 return( mbedtls_psa_rsa_import_key( attributes,
684 data, data_length,
685 key_buffer, key_buffer_size,
686 key_buffer_length,
687 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200688 }
John Durkop9814fa22020-11-04 12:28:15 -0800689#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
690 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100691 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100692
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100693 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100694}
695
Gilles Peskinef603c712019-01-19 13:40:11 +0100696/** Calculate the intersection of two algorithm usage policies.
697 *
698 * Return 0 (which allows no operation) on incompatibility.
699 */
700static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100702 psa_algorithm_t alg1,
703 psa_algorithm_t alg2 )
704{
Gilles Peskine549ea862019-05-22 11:45:59 +0200705 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100706 if( alg1 == alg2 )
707 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100708 /* If the policies are from the same hash-and-sign family, check
709 * if one is a wildcard. If so the other has the specific algorithm. */
710 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
711 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
712 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100713 {
Steven Cooreman03488022021-02-18 12:07:20 +0100714 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
715 return( alg2 );
716 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
717 return( alg1 );
718 }
719 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100720 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100721 * restrictive tag length. */
722 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
723 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
724 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
725 {
726 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
727 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100728 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100729
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100730 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100731 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
732 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100733 {
Steven Cooremancd640932021-03-08 12:00:27 +0100734 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
735 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100736 }
737 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100738 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100739 ( alg1_len <= alg2_len ) )
740 {
741 return( alg2 );
742 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100743 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100744 ( alg2_len <= alg1_len ) )
745 {
746 return( alg1 );
747 }
748 }
749 /* If the policies are from the same MAC family, check whether one
750 * of them is a minimum-MAC-length policy. Calculate the most
751 * restrictive tag length. */
752 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
753 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
754 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
755 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100756 /* Validate the combination of key type and algorithm. Since the base
757 * algorithm of alg1 and alg2 are the same, we only need this once. */
758 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100759 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100760
Steven Cooreman31a876d2021-03-03 20:47:40 +0100761 /* Get the (exact or at-least) output lengths for both sides of the
762 * requested intersection. None of the currently supported algorithms
763 * have an output length dependent on the actual key size, so setting it
764 * to a bogus value of 0 is currently OK.
765 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100766 * Note that for at-least-this-length wildcard algorithms, the output
767 * length is set to the shortest allowed length, which allows us to
768 * calculate the most restrictive tag length for the intersection. */
769 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
770 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100771 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100772
Steven Cooremana1d83222021-02-25 10:20:29 +0100773 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100774 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
775 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100776 {
Steven Cooremancd640932021-03-08 12:00:27 +0100777 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100778 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779
780 /* If only one is an at-least-this-length policy, the intersection would
781 * be the other (fixed-length) policy as long as said fixed length is
782 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100783 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100784 {
Steven Cooremancd640932021-03-08 12:00:27 +0100785 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100786 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100787 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100788 {
Steven Cooremancd640932021-03-08 12:00:27 +0100789 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100790 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100791
Steven Cooremancd640932021-03-08 12:00:27 +0100792 /* If none of them are wildcards, check whether they define the same tag
793 * length. This is still possible here when one is default-length and
794 * the other specific-length. Ensure to always return the
795 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100796 if( alg1_len == alg2_len )
797 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100798 }
799 /* If the policies are incompatible, allow nothing. */
800 return( 0 );
801}
802
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100803static int psa_key_algorithm_permits( psa_key_type_t key_type,
804 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200805 psa_algorithm_t requested_alg )
806{
Gilles Peskine549ea862019-05-22 11:45:59 +0200807 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200808 if( requested_alg == policy_alg )
809 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100810 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
811 * and requested_alg is the same hash-and-sign family with any hash,
812 * then requested_alg is compliant with policy_alg. */
813 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
814 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200815 {
Steven Cooreman03488022021-02-18 12:07:20 +0100816 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
817 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
818 }
819 /* If policy_alg is a wildcard AEAD algorithm of the same base as
820 * the requested algorithm, check the requested tag length to be
821 * equal-length or longer than the wildcard-specified length. */
822 if( PSA_ALG_IS_AEAD( policy_alg ) &&
823 PSA_ALG_IS_AEAD( requested_alg ) &&
824 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
825 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100826 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100827 {
828 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
829 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
830 }
Steven Cooremancd640932021-03-08 12:00:27 +0100831 /* If policy_alg is a MAC algorithm of the same base as the requested
832 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100833 if( PSA_ALG_IS_MAC( policy_alg ) &&
834 PSA_ALG_IS_MAC( requested_alg ) &&
835 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100836 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100837 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100838 /* Validate the combination of key type and algorithm. Since the policy
839 * and requested algorithms are the same, we only need this once. */
840 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100841 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100842
Steven Cooreman31a876d2021-03-03 20:47:40 +0100843 /* Get both the requested output length for the algorithm which is to be
844 * verified, and the default output length for the base algorithm.
845 * Note that none of the currently supported algorithms have an output
846 * length dependent on actual key size, so setting it to a bogus value
847 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100848 size_t requested_output_length = PSA_MAC_LENGTH(
849 key_type, 0, requested_alg );
850 size_t default_output_length = PSA_MAC_LENGTH(
851 key_type, 0,
852 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100853
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100854 /* If the policy is default-length, only allow an algorithm with
855 * a declared exact-length matching the default. */
856 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100857 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100858
859 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100860 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100861 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
862 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
863 {
864 return( 1 );
865 }
866
Steven Cooremancd640932021-03-08 12:00:27 +0100867 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
868 * check for the requested MAC length to be equal to or longer than the
869 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100870 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
871 {
872 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100873 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100874 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200875 }
Steven Cooremance48e852020-10-05 16:02:45 +0200876 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200877 * a key derivation with that key agreement should also be allowed. This
878 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200879 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
880 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
881 {
882 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
883 policy_alg );
884 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100885 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200886 return( 0 );
887}
888
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100889/** Test whether a policy permits an algorithm.
890 *
891 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100892 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100893 * \note This function requires providing the key type for which the policy is
894 * being validated, since some algorithm policy definitions (e.g. MAC)
895 * have different properties depending on what kind of cipher it is
896 * combined with.
897 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100898 * \retval PSA_SUCCESS When \p alg is a specific algorithm
899 * allowed by the \p policy.
900 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
901 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
902 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100903 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100904static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100905 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100906 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100907{
Steven Cooremand788fab2021-02-25 11:29:17 +0100908 /* '0' is not a valid algorithm */
909 if( alg == 0 )
910 return( PSA_ERROR_INVALID_ARGUMENT );
911
Steven Cooreman7e39f052021-02-23 14:18:32 +0100912 /* A requested algorithm cannot be a wildcard. */
913 if( PSA_ALG_IS_WILDCARD( alg ) )
914 return( PSA_ERROR_INVALID_ARGUMENT );
915
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100916 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
917 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100918 return( PSA_SUCCESS );
919 else
920 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100921}
922
Gilles Peskinef603c712019-01-19 13:40:11 +0100923/** Restrict a key policy based on a constraint.
924 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100925 * \note This function requires providing the key type for which the policy is
926 * being restricted, since some algorithm policy definitions (e.g. MAC)
927 * have different properties depending on what kind of cipher it is
928 * combined with.
929 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100930 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100931 * \param[in,out] policy The policy to restrict.
932 * \param[in] constraint The policy constraint to apply.
933 *
934 * \retval #PSA_SUCCESS
935 * \c *policy contains the intersection of the original value of
936 * \c *policy and \c *constraint.
937 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100938 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100939 * \c *policy is unchanged.
940 */
941static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100942 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100943 psa_key_policy_t *policy,
944 const psa_key_policy_t *constraint )
945{
946 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100947 psa_key_policy_algorithm_intersection( key_type, policy->alg,
948 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200949 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100950 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
951 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100952 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
953 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200954 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
955 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100956 policy->usage &= constraint->usage;
957 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200958 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100959 return( PSA_SUCCESS );
960}
961
Ronald Cron5c522922020-11-14 16:35:34 +0100962/** Get the description of a key given its identifier and policy constraints
963 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200964 *
Ronald Cron5c522922020-11-14 16:35:34 +0100965 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100966 * nonzero, the key must allow operations with this algorithm. If \p alg is
967 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100968 *
Ronald Cron5c522922020-11-14 16:35:34 +0100969 * In case of a persistent key, the function loads the description of the key
970 * into a key slot if not already done.
971 *
972 * On success, the returned key slot is locked. It is the responsibility of
973 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200974 */
Ronald Cron5c522922020-11-14 16:35:34 +0100975static psa_status_t psa_get_and_lock_key_slot_with_policy(
976 mbedtls_svc_key_id_t key,
977 psa_key_slot_t **p_slot,
978 psa_key_usage_t usage,
979 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100980{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200981 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
982 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100983
Ronald Cron5c522922020-11-14 16:35:34 +0100984 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100985 if( status != PSA_SUCCESS )
986 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100988
989 /* Enforce that usage policy for the key slot contains all the flags
990 * required by the usage parameter. There is one exception: public
991 * keys can always be exported, so we treat public key objects as
992 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200993 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100994 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200995
Gilles Peskine8e338702019-07-30 20:06:31 +0200996 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100997 {
998 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200999 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001000 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001001
1002 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001003 if( alg != 0 )
1004 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001005 status = psa_key_policy_permits( &slot->attr.policy,
1006 slot->attr.type,
1007 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001008 if( status != PSA_SUCCESS )
1009 goto error;
1010 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001011
Darryl Green06fd18d2018-07-16 11:21:11 +01001012 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001013
1014error:
1015 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001016 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001017
1018 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001019}
Darryl Green940d72c2018-07-13 13:18:51 +01001020
Ronald Cron5c522922020-11-14 16:35:34 +01001021/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001022 *
1023 * A transparent key is a key for which the key material is directly
1024 * available, as opposed to a key in a secure element.
1025 *
Ronald Cron5c522922020-11-14 16:35:34 +01001026 * This is a temporary function to use instead of
1027 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1028 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001029 *
Ronald Cron5c522922020-11-14 16:35:34 +01001030 * On success, the returned key slot is locked. It is the responsibility of the
1031 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001032 */
1033#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001034static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1035 mbedtls_svc_key_id_t key,
1036 psa_key_slot_t **p_slot,
1037 psa_key_usage_t usage,
1038 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001039{
Ronald Cron5c522922020-11-14 16:35:34 +01001040 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1041 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001042 if( status != PSA_SUCCESS )
1043 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001044
Gilles Peskineadad8132019-07-25 11:31:23 +02001045 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001046 {
Ronald Cron5c522922020-11-14 16:35:34 +01001047 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001048 *p_slot = NULL;
1049 return( PSA_ERROR_NOT_SUPPORTED );
1050 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001051
Gilles Peskine28f8f302019-07-24 13:30:31 +02001052 return( PSA_SUCCESS );
1053}
1054#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1055/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001056#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1057 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001058#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1059
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001060/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001061static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001062{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001063 /* Data pointer will always be either a valid pointer or NULL in an
1064 * initialized slot, so we can just free it. */
1065 if( slot->key.data != NULL )
1066 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1067
1068 mbedtls_free( slot->key.data );
1069 slot->key.data = NULL;
1070 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001071
1072 return( PSA_SUCCESS );
1073}
1074
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001075/** Completely wipe a slot in memory, including its policy.
1076 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001077psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001078{
1079 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001080
1081 /*
1082 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001083 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001084 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1085 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001086 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001087 */
Ronald Cron5c522922020-11-14 16:35:34 +01001088 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001089 {
1090#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001091 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001092#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001093 status = PSA_ERROR_CORRUPTION_DETECTED;
1094 }
1095
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001096 /* Multipart operations may still be using the key. This is safe
1097 * because all multipart operation objects are independent from
1098 * the key slot: if they need to access the key after the setup
1099 * phase, they have a copy of the key. Note that this means that
1100 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001101 /* At this point, key material and other type-specific content has
1102 * been wiped. Clear remaining metadata. We can call memset and not
1103 * zeroize because the metadata is not particularly sensitive. */
1104 memset( slot, 0, sizeof( *slot ) );
1105 return( status );
1106}
1107
Ronald Croncf56a0a2020-08-04 09:51:30 +02001108psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001109{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001110 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001111 psa_status_t status; /* status of the last operation */
1112 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001113#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1114 psa_se_drv_table_entry_t *driver;
1115#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001116
Ronald Croncf56a0a2020-08-04 09:51:30 +02001117 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001118 return( PSA_SUCCESS );
1119
Ronald Cronf2911112020-10-29 17:51:10 +01001120 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001121 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001122 * key, this will load the key description from persistent memory if not
1123 * done yet. We cannot avoid this loading as without it we don't know if
1124 * the key is operated by an SE or not and this information is needed by
1125 * the current implementation.
1126 */
Ronald Cron5c522922020-11-14 16:35:34 +01001127 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001128 if( status != PSA_SUCCESS )
1129 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001130
Ronald Cronf2911112020-10-29 17:51:10 +01001131 /*
1132 * If the key slot containing the key description is under access by the
1133 * library (apart from the present access), the key cannot be destroyed
1134 * yet. For the time being, just return in error. Eventually (to be
1135 * implemented), the key should be destroyed when all accesses have
1136 * stopped.
1137 */
Ronald Cron5c522922020-11-14 16:35:34 +01001138 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001139 {
Ronald Cron5c522922020-11-14 16:35:34 +01001140 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001141 return( PSA_ERROR_GENERIC_ERROR );
1142 }
1143
Gilles Peskine354f7672019-07-12 23:46:38 +02001144#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001145 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001146 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001147 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001148 /* For a key in a secure element, we need to do three things:
1149 * remove the key file in internal storage, destroy the
1150 * key inside the secure element, and update the driver's
1151 * persistent data. Start a transaction that will encompass these
1152 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001153 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001154 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001155 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001156 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001157 status = psa_crypto_save_transaction( );
1158 if( status != PSA_SUCCESS )
1159 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001160 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001161 /* We should still try to destroy the key in the secure
1162 * element and the key metadata in storage. This is especially
1163 * important if the error is that the storage is full.
1164 * But how to do it exactly without risking an inconsistent
1165 * state after a reset?
1166 * https://github.com/ARMmbed/mbed-crypto/issues/215
1167 */
1168 overall_status = status;
1169 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001170 }
1171
Ronald Cronea0f8a62020-11-25 17:52:23 +01001172 status = psa_destroy_se_key( driver,
1173 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001174 if( overall_status == PSA_SUCCESS )
1175 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001176 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001177#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1178
Darryl Greend49a4992018-06-18 17:27:26 +01001179#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001180 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001181 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001182 status = psa_destroy_persistent_key( slot->attr.id );
1183 if( overall_status == PSA_SUCCESS )
1184 overall_status = status;
1185
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001186 /* TODO: other slots may have a copy of the same key. We should
1187 * invalidate them.
1188 * https://github.com/ARMmbed/mbed-crypto/issues/214
1189 */
Darryl Greend49a4992018-06-18 17:27:26 +01001190 }
1191#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001192
Gilles Peskinefc762652019-07-22 19:30:34 +02001193#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1194 if( driver != NULL )
1195 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001196 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001197 if( overall_status == PSA_SUCCESS )
1198 overall_status = status;
1199 status = psa_crypto_stop_transaction( );
1200 if( overall_status == PSA_SUCCESS )
1201 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001202 }
1203#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1204
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001205#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1206exit:
1207#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001208 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001209 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1210 if( overall_status == PSA_SUCCESS )
1211 overall_status = status;
1212 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001213}
1214
John Durkop07cc04a2020-11-16 22:08:34 -08001215#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001216 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001217static psa_status_t psa_get_rsa_public_exponent(
1218 const mbedtls_rsa_context *rsa,
1219 psa_key_attributes_t *attributes )
1220{
1221 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 uint8_t *buffer = NULL;
1224 size_t buflen;
1225 mbedtls_mpi_init( &mpi );
1226
1227 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1228 if( ret != 0 )
1229 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001230 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1231 {
1232 /* It's the default value, which is reported as an empty string,
1233 * so there's nothing to do. */
1234 goto exit;
1235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236
1237 buflen = mbedtls_mpi_size( &mpi );
1238 buffer = mbedtls_calloc( 1, buflen );
1239 if( buffer == NULL )
1240 {
1241 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1242 goto exit;
1243 }
1244 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1245 if( ret != 0 )
1246 goto exit;
1247 attributes->domain_parameters = buffer;
1248 attributes->domain_parameters_size = buflen;
1249
1250exit:
1251 mbedtls_mpi_free( &mpi );
1252 if( ret != 0 )
1253 mbedtls_free( buffer );
1254 return( mbedtls_to_psa_error( ret ) );
1255}
John Durkop07cc04a2020-11-16 22:08:34 -08001256#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001257 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001258
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001259/** Retrieve all the publicly-accessible attributes of a key.
1260 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001261psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001262 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001263{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001265 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001266 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001267
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001268 psa_reset_key_attributes( attributes );
1269
Ronald Cron5c522922020-11-14 16:35:34 +01001270 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001271 if( status != PSA_SUCCESS )
1272 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001273
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001274 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001275 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1276 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1277
1278#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1279 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001280 psa_set_key_slot_number( attributes,
1281 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001282#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001283
Gilles Peskine8e338702019-07-30 20:06:31 +02001284 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001285 {
John Durkop07cc04a2020-11-16 22:08:34 -08001286#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001287 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001288 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001289 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001290#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001291 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001292 * is not yet implemented.
1293 * https://github.com/ARMmbed/mbed-crypto/issues/216
1294 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001295 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001296 break;
1297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001298 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001299 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001300
Ronald Cron90857082020-11-25 14:58:33 +01001301 status = mbedtls_psa_rsa_load_representation(
1302 slot->attr.type,
1303 slot->key.data,
1304 slot->key.bytes,
1305 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001306 if( status != PSA_SUCCESS )
1307 break;
1308
Steven Cooremana2371e52020-07-28 14:30:39 +02001309 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001310 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001311 mbedtls_rsa_free( rsa );
1312 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001313 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001314 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001315#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001316 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001317 default:
1318 /* Nothing else to do. */
1319 break;
1320 }
1321
1322 if( status != PSA_SUCCESS )
1323 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001324
Ronald Cron5c522922020-11-14 16:35:34 +01001325 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001326
Ronald Cron5c522922020-11-14 16:35:34 +01001327 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001328}
1329
Gilles Peskinec8000c02019-08-02 20:15:51 +02001330#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1331psa_status_t psa_get_key_slot_number(
1332 const psa_key_attributes_t *attributes,
1333 psa_key_slot_number_t *slot_number )
1334{
1335 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1336 {
1337 *slot_number = attributes->slot_number;
1338 return( PSA_SUCCESS );
1339 }
1340 else
1341 return( PSA_ERROR_INVALID_ARGUMENT );
1342}
1343#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1346 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001347 uint8_t *data,
1348 size_t data_size,
1349 size_t *data_length )
1350{
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001352 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 memcpy( data, key_buffer, key_buffer_size );
1354 memset( data + key_buffer_size, 0,
1355 data_size - key_buffer_size );
1356 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001357 return( PSA_SUCCESS );
1358}
1359
Ronald Cron7285cda2020-11-26 14:46:37 +01001360psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 const psa_key_attributes_t *attributes,
1362 const uint8_t *key_buffer, size_t key_buffer_size,
1363 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001364{
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 psa_key_type_t type = attributes->core.type;
1366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( key_type_is_raw_bytes( type ) ||
1368 PSA_KEY_TYPE_IS_RSA( type ) ||
1369 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001370 {
1371 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001372 key_buffer, key_buffer_size,
1373 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001374 }
1375 else
1376 {
1377 /* This shouldn't happen in the reference implementation, but
1378 it is valid for a special-purpose implementation to omit
1379 support for exporting certain key types. */
1380 return( PSA_ERROR_NOT_SUPPORTED );
1381 }
1382}
1383
1384psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1385 uint8_t *data,
1386 size_t data_size,
1387 size_t *data_length )
1388{
1389 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1390 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1391 psa_key_slot_t *slot;
1392
Ronald Crone907e552021-01-18 13:22:38 +01001393 /* Reject a zero-length output buffer now, since this can never be a
1394 * valid key representation. This way we know that data must be a valid
1395 * pointer and we can do things like memset(data, ..., data_size). */
1396 if( data_size == 0 )
1397 return( PSA_ERROR_BUFFER_TOO_SMALL );
1398
Ronald Cron9486f9d2020-11-26 13:36:23 +01001399 /* Set the key to empty now, so that even when there are errors, we always
1400 * set data_length to a value between 0 and data_size. On error, setting
1401 * the key to empty is a good choice because an empty key representation is
1402 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001403 *data_length = 0;
1404
Ronald Cron9486f9d2020-11-26 13:36:23 +01001405 /* Export requires the EXPORT flag. There is an exception for public keys,
1406 * which don't require any flag, but
1407 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1408 */
1409 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1410 PSA_KEY_USAGE_EXPORT, 0 );
1411 if( status != PSA_SUCCESS )
1412 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001413
Ronald Crond18b5f82020-11-25 16:46:05 +01001414 psa_key_attributes_t attributes = {
1415 .core = slot->attr
1416 };
Ronald Cron67227982020-11-26 15:16:05 +01001417 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001418 slot->key.data, slot->key.bytes,
1419 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001420
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421 unlock_status = psa_unlock_key_slot( slot );
1422
1423 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1424}
1425
Ronald Cron7285cda2020-11-26 14:46:37 +01001426psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 const psa_key_attributes_t *attributes,
1428 const uint8_t *key_buffer,
1429 size_t key_buffer_size,
1430 uint8_t *data,
1431 size_t data_size,
1432 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433{
Ronald Crond18b5f82020-11-25 16:46:05 +01001434 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001435
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001437 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001438 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001439 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001440 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001441 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001442 key_buffer, key_buffer_size,
1443 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001444 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001445
Ronald Crond18b5f82020-11-25 16:46:05 +01001446 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001447 {
John Durkop0e005192020-10-31 22:06:54 -07001448#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1449 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001450 return( mbedtls_psa_rsa_export_public_key( attributes,
1451 key_buffer,
1452 key_buffer_size,
1453 data,
1454 data_size,
1455 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001456#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001457 /* We don't know how to convert a private RSA key to public. */
1458 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001459#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1460 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001461 }
1462 else
Moran Pekera998bc62018-04-16 18:16:20 +03001463 {
John Durkop6ba40d12020-11-10 08:50:04 -08001464#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1465 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001466 return( mbedtls_psa_ecp_export_public_key( attributes,
1467 key_buffer,
1468 key_buffer_size,
1469 data,
1470 data_size,
1471 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001472#else
1473 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001474 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001475#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1476 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001477 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001479 else
1480 {
1481 /* This shouldn't happen in the reference implementation, but
1482 it is valid for a special-purpose implementation to omit
1483 support for exporting certain key types. */
1484 return( PSA_ERROR_NOT_SUPPORTED );
1485 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001486}
Ronald Crond18b5f82020-11-25 16:46:05 +01001487
Ronald Croncf56a0a2020-08-04 09:51:30 +02001488psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001489 uint8_t *data,
1490 size_t data_size,
1491 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001492{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001494 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001495 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001496
Ronald Crone907e552021-01-18 13:22:38 +01001497 /* Reject a zero-length output buffer now, since this can never be a
1498 * valid key representation. This way we know that data must be a valid
1499 * pointer and we can do things like memset(data, ..., data_size). */
1500 if( data_size == 0 )
1501 return( PSA_ERROR_BUFFER_TOO_SMALL );
1502
Darryl Greendd8fb772018-11-07 16:00:44 +00001503 /* Set the key to empty now, so that even when there are errors, we always
1504 * set data_length to a value between 0 and data_size. On error, setting
1505 * the key to empty is a good choice because an empty key representation is
1506 * unlikely to be accepted anywhere. */
1507 *data_length = 0;
1508
1509 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001510 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001511 if( status != PSA_SUCCESS )
1512 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001513
Ronald Cron9486f9d2020-11-26 13:36:23 +01001514 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1515 {
1516 status = PSA_ERROR_INVALID_ARGUMENT;
1517 goto exit;
1518 }
1519
Ronald Crond18b5f82020-11-25 16:46:05 +01001520 psa_key_attributes_t attributes = {
1521 .core = slot->attr
1522 };
Ronald Cron67227982020-11-26 15:16:05 +01001523 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001524 &attributes, slot->key.data, slot->key.bytes,
1525 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001526
1527exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001528 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001529
Ronald Cron5c522922020-11-14 16:35:34 +01001530 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001531}
1532
Gilles Peskine91e8c332019-08-02 19:19:39 +02001533#if defined(static_assert)
1534static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1535 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001536static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001537 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001538static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001539 "One or more key attribute flag is listed as both internal-only and external-only" );
1540#endif
1541
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001542/** Validate that a key policy is internally well-formed.
1543 *
1544 * This function only rejects invalid policies. It does not validate the
1545 * consistency of the policy with respect to other attributes of the key
1546 * such as the key type.
1547 */
1548static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001549{
1550 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001551 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001552 PSA_KEY_USAGE_ENCRYPT |
1553 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001554 PSA_KEY_USAGE_SIGN_HASH |
1555 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001556 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1557 return( PSA_ERROR_INVALID_ARGUMENT );
1558
Gilles Peskine4747d192019-04-17 15:05:45 +02001559 return( PSA_SUCCESS );
1560}
1561
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001562/** Validate the internal consistency of key attributes.
1563 *
1564 * This function only rejects invalid attribute values. If does not
1565 * validate the consistency of the attributes with any key data that may
1566 * be involved in the creation of the key.
1567 *
1568 * Call this function early in the key creation process.
1569 *
1570 * \param[in] attributes Key attributes for the new key.
1571 * \param[out] p_drv On any return, the driver for the key, if any.
1572 * NULL for a transparent key.
1573 *
1574 */
1575static psa_status_t psa_validate_key_attributes(
1576 const psa_key_attributes_t *attributes,
1577 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001578{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001579 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001580 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001581 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001582
Ronald Cron54b90082020-10-29 15:26:43 +01001583 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001584 if( status != PSA_SUCCESS )
1585 return( status );
1586
Ronald Crond2ed4812020-07-17 16:11:30 +02001587 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001588 if( status != PSA_SUCCESS )
1589 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001590
Ronald Cron65f38a32020-10-23 17:11:13 +02001591 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1592 {
1593 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1594 return( PSA_ERROR_INVALID_ARGUMENT );
1595 }
1596 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001597 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001598 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001599 if( status != PSA_SUCCESS )
1600 return( status );
1601 }
1602
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001603 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001604 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001605 return( status );
1606
1607 /* Refuse to create overly large keys.
1608 * Note that this doesn't trigger on import if the attributes don't
1609 * explicitly specify a size (so psa_get_key_bits returns 0), so
1610 * psa_import_key() needs its own checks. */
1611 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1612 return( PSA_ERROR_NOT_SUPPORTED );
1613
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614 /* Reject invalid flags. These should not be reachable through the API. */
1615 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1616 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1617 return( PSA_ERROR_INVALID_ARGUMENT );
1618
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001619 return( PSA_SUCCESS );
1620}
1621
Gilles Peskine4747d192019-04-17 15:05:45 +02001622/** Prepare a key slot to receive key material.
1623 *
1624 * This function allocates a key slot and sets its metadata.
1625 *
1626 * If this function fails, call psa_fail_key_creation().
1627 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001628 * This function is intended to be used as follows:
1629 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001630 * it with the specified attributes, and in case of a volatile key assign it
1631 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001632 * -# Populate the slot with the key material.
1633 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1634 * In case of failure at any step, stop the sequence and call
1635 * psa_fail_key_creation().
1636 *
Ronald Cron5c522922020-11-14 16:35:34 +01001637 * On success, the key slot is locked. It is the responsibility of the caller
1638 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001639 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001640 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001641 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001642 * \param[out] p_slot On success, a pointer to the prepared slot.
1643 * \param[out] p_drv On any return, the driver for the key, if any.
1644 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001645 *
1646 * \retval #PSA_SUCCESS
1647 * The key slot is ready to receive key material.
1648 * \return If this function fails, the key slot is an invalid state.
1649 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001650 */
1651static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001652 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001653 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001655 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001656{
1657 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001658 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001659 psa_key_slot_t *slot;
1660
Gilles Peskinedf179142019-07-15 22:02:14 +02001661 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001662 *p_drv = NULL;
1663
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001664 status = psa_validate_key_attributes( attributes, p_drv );
1665 if( status != PSA_SUCCESS )
1666 return( status );
1667
Ronald Cronc4d1b512020-07-31 11:26:37 +02001668 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001669 if( status != PSA_SUCCESS )
1670 return( status );
1671 slot = *p_slot;
1672
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001673 /* We're storing the declared bit-size of the key. It's up to each
1674 * creation mechanism to verify that this information is correct.
1675 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001676 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001677 * is optional (import, copy). In case of a volatile key, assign it the
1678 * volatile key identifier associated to the slot returned to contain its
1679 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001680
1681 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001682 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1683 {
1684#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1685 slot->attr.id = volatile_key_id;
1686#else
1687 slot->attr.id.key_id = volatile_key_id;
1688#endif
1689 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001690
Gilles Peskine91e8c332019-08-02 19:19:39 +02001691 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001692 * external-only flags, query `attributes`. Thanks to the check
1693 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001694 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001695 * may have set. */
1696 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001697
Gilles Peskinecbaff462019-07-12 23:46:04 +02001698#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001699 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001700 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001701 * create the key file in internal storage, create the
1702 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001703 * persistent data. This is done by starting a transaction that will
1704 * encompass these three actions.
1705 * For registering a volatile key, we just need to find an appropriate
1706 * slot number inside the SE. Since the key is designated volatile, creating
1707 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001708 /* The first thing to do is to find a slot number for the new key.
1709 * We save the slot number in persistent storage as part of the
1710 * transaction data. It will be needed to recover if the power
1711 * fails during the key creation process, to clean up on the secure
1712 * element side after restarting. Obtaining a slot number from the
1713 * secure element driver updates its persistent state, but we do not yet
1714 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001715 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001716 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001717 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001718 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001719 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001721 if( status != PSA_SUCCESS )
1722 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001723
1724 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001725 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001726 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1727 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001728 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001729 psa_crypto_transaction.key.id = slot->attr.id;
1730 status = psa_crypto_save_transaction( );
1731 if( status != PSA_SUCCESS )
1732 {
1733 (void) psa_crypto_stop_transaction( );
1734 return( status );
1735 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001736 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001737
1738 status = psa_copy_key_material_into_slot(
1739 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001740 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001741
1742 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1743 {
1744 /* Key registration only makes sense with a secure element. */
1745 return( PSA_ERROR_INVALID_ARGUMENT );
1746 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001747#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1748
Ronald Cronc4d1b512020-07-31 11:26:37 +02001749 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001750}
Gilles Peskine4747d192019-04-17 15:05:45 +02001751
1752/** Finalize the creation of a key once its key material has been set.
1753 *
1754 * This entails writing the key to persistent storage.
1755 *
1756 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001757 * See the documentation of psa_start_key_creation() for the intended use
1758 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001759 *
Ronald Cron5c522922020-11-14 16:35:34 +01001760 * If the finalization succeeds, the function unlocks the key slot (it was
1761 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1762 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001763 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001764 * \param[in,out] slot Pointer to the slot with key material.
1765 * \param[in] driver The secure element driver for the key,
1766 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 * \param[out] key On success, identifier of the key. Note that the
1768 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001769 *
1770 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001771 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001772 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1773 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1774 * \retval #PSA_ERROR_ALREADY_EXISTS
1775 * \retval #PSA_ERROR_DATA_INVALID
1776 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001777 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001778 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001779 * \return If this function fails, the key slot is an invalid state.
1780 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001782static psa_status_t psa_finish_key_creation(
1783 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001784 psa_se_drv_table_entry_t *driver,
1785 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001786{
1787 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001788 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001789 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001790
1791#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001792 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001794#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1795 if( driver != NULL )
1796 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001797 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001798 psa_key_slot_number_t slot_number =
1799 psa_key_slot_get_slot_number( slot ) ;
1800
Gilles Peskineb46bef22019-07-30 21:32:04 +02001801#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001802 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001803 sizeof( data.slot_number ),
1804 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001805#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001806 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001807 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001808 (uint8_t*) &data,
1809 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001810 }
1811 else
1812#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1813 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001814 /* Key material is saved in export representation in the slot, so
1815 * just pass the slot buffer for storage. */
1816 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001817 slot->key.data,
1818 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001819 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001820 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001821#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1822
Gilles Peskinecbaff462019-07-12 23:46:04 +02001823#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001824 /* Finish the transaction for a key creation. This does not
1825 * happen when registering an existing key. Detect this case
1826 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001827 * creation of a persistent key in a secure element requires a transaction,
1828 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001829 if( driver != NULL &&
1830 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001831 {
1832 status = psa_save_se_persistent_data( driver );
1833 if( status != PSA_SUCCESS )
1834 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001835 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001836 return( status );
1837 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001838 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001839 }
1840#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1841
Ronald Cron50972942020-11-14 11:28:25 +01001842 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001843 {
1844 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001845 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001846 if( status != PSA_SUCCESS )
1847 *key = MBEDTLS_SVC_KEY_ID_INIT;
1848 }
Ronald Cron50972942020-11-14 11:28:25 +01001849
Gilles Peskine4747d192019-04-17 15:05:45 +02001850 return( status );
1851}
1852
1853/** Abort the creation of a key.
1854 *
1855 * You may call this function after calling psa_start_key_creation(),
1856 * or after psa_finish_key_creation() fails. In other circumstances, this
1857 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001858 * See the documentation of psa_start_key_creation() for the intended use
1859 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001860 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001861 * \param[in,out] slot Pointer to the slot with key material.
1862 * \param[in] driver The secure element driver for the key,
1863 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001864 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001865static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001866 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001867{
Gilles Peskine011e4282019-06-26 18:34:38 +02001868 (void) driver;
1869
Gilles Peskine4747d192019-04-17 15:05:45 +02001870 if( slot == NULL )
1871 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001872
1873#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001874 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001875 * element, and the failure happened later (when saving metadata
1876 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001877 * element.
1878 * https://github.com/ARMmbed/mbed-crypto/issues/217
1879 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001880
Gilles Peskined7729582019-08-05 15:55:54 +02001881 /* Abort the ongoing transaction if any (there may not be one if
1882 * the creation process failed before starting one, or if the
1883 * key creation is a registration of a key in a secure element).
1884 * Earlier functions must already have done what it takes to undo any
1885 * partial creation. All that's left is to update the transaction data
1886 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001887 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001888#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1889
Gilles Peskine4747d192019-04-17 15:05:45 +02001890 psa_wipe_key_slot( slot );
1891}
1892
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001893/** Validate optional attributes during key creation.
1894 *
1895 * Some key attributes are optional during key creation. If they are
1896 * specified in the attributes structure, check that they are consistent
1897 * with the data in the slot.
1898 *
1899 * This function should be called near the end of key creation, after
1900 * the slot in memory is fully populated but before saving persistent data.
1901 */
1902static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 const psa_key_slot_t *slot,
1904 const psa_key_attributes_t *attributes )
1905{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001906 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001908 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909 return( PSA_ERROR_INVALID_ARGUMENT );
1910 }
1911
1912 if( attributes->domain_parameters_size != 0 )
1913 {
John Durkop0e005192020-10-31 22:06:54 -07001914#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1915 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001916 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001917 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001918 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001919 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001921
Ronald Cron90857082020-11-25 14:58:33 +01001922 psa_status_t status = mbedtls_psa_rsa_load_representation(
1923 slot->attr.type,
1924 slot->key.data,
1925 slot->key.bytes,
1926 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001927 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001928 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001929
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001930 mbedtls_mpi_init( &actual );
1931 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001932 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001933 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001934 mbedtls_rsa_free( rsa );
1935 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001936 if( ret != 0 )
1937 goto rsa_exit;
1938 ret = mbedtls_mpi_read_binary( &required,
1939 attributes->domain_parameters,
1940 attributes->domain_parameters_size );
1941 if( ret != 0 )
1942 goto rsa_exit;
1943 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1944 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1945 rsa_exit:
1946 mbedtls_mpi_free( &actual );
1947 mbedtls_mpi_free( &required );
1948 if( ret != 0)
1949 return( mbedtls_to_psa_error( ret ) );
1950 }
1951 else
John Durkop9814fa22020-11-04 12:28:15 -08001952#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1953 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954 {
1955 return( PSA_ERROR_INVALID_ARGUMENT );
1956 }
1957 }
1958
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001959 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001960 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001961 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001962 return( PSA_ERROR_INVALID_ARGUMENT );
1963 }
1964
1965 return( PSA_SUCCESS );
1966}
1967
Gilles Peskine4747d192019-04-17 15:05:45 +02001968psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001969 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001970 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001971 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001972{
1973 psa_status_t status;
1974 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001975 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001976 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001977
Ronald Cron81709fc2020-11-14 12:10:32 +01001978 *key = MBEDTLS_SVC_KEY_ID_INIT;
1979
Gilles Peskine0f84d622019-09-12 19:03:13 +02001980 /* Reject zero-length symmetric keys (including raw data key objects).
1981 * This also rejects any key which might be encoded as an empty string,
1982 * which is never valid. */
1983 if( data_length == 0 )
1984 return( PSA_ERROR_INVALID_ARGUMENT );
1985
Gilles Peskinedf179142019-07-15 22:02:14 +02001986 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001987 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001988 if( status != PSA_SUCCESS )
1989 goto exit;
1990
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001991 /* In the case of a transparent key or an opaque key stored in local
1992 * storage (thus not in the case of generating a key in a secure element
1993 * or cryptoprocessor with storage), we have to allocate a buffer to
1994 * hold the generated key material. */
1995 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001996 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001997 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001998 if( status != PSA_SUCCESS )
1999 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002000 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002001
2002 bits = slot->attr.bits;
2003 status = psa_driver_wrapper_import_key( attributes,
2004 data, data_length,
2005 slot->key.data,
2006 slot->key.bytes,
2007 &slot->key.bytes, &bits );
2008 if( status != PSA_SUCCESS )
2009 goto exit;
2010
2011 if( slot->attr.bits == 0 )
2012 slot->attr.bits = (psa_key_bits_t) bits;
2013 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002014 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002015 status = PSA_ERROR_INVALID_ARGUMENT;
2016 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002017 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002018
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002019 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002020 if( status != PSA_SUCCESS )
2021 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022
Ronald Cron81709fc2020-11-14 12:10:32 +01002023 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002024exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002025 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002026 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002027
Gilles Peskine4747d192019-04-17 15:05:45 +02002028 return( status );
2029}
2030
Gilles Peskined7729582019-08-05 15:55:54 +02002031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2032psa_status_t mbedtls_psa_register_se_key(
2033 const psa_key_attributes_t *attributes )
2034{
2035 psa_status_t status;
2036 psa_key_slot_t *slot = NULL;
2037 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002038 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002039
2040 /* Leaving attributes unspecified is not currently supported.
2041 * It could make sense to query the key type and size from the
2042 * secure element, but not all secure elements support this
2043 * and the driver HAL doesn't currently support it. */
2044 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2045 return( PSA_ERROR_NOT_SUPPORTED );
2046 if( psa_get_key_bits( attributes ) == 0 )
2047 return( PSA_ERROR_NOT_SUPPORTED );
2048
2049 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002050 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002051 if( status != PSA_SUCCESS )
2052 goto exit;
2053
Ronald Cron81709fc2020-11-14 12:10:32 +01002054 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002055
2056exit:
2057 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002058 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002059
Gilles Peskined7729582019-08-05 15:55:54 +02002060 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002061 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002062 return( status );
2063}
2064#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2065
Gilles Peskinef603c712019-01-19 13:40:11 +01002066static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002067 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002068{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002069 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002070 source->key.data,
2071 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002072 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002073 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002074
Steven Cooreman398aee52020-10-13 14:35:45 +02002075 target->attr.type = source->attr.type;
2076 target->attr.bits = source->attr.bits;
2077
2078 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002079}
2080
Ronald Croncf56a0a2020-08-04 09:51:30 +02002081psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002082 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002083 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002084{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002085 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002086 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002087 psa_key_slot_t *source_slot = NULL;
2088 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002089 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002090 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002091
Ronald Cron81709fc2020-11-14 12:10:32 +01002092 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2093
Ronald Cron5c522922020-11-14 16:35:34 +01002094 status = psa_get_and_lock_transparent_key_slot_with_policy(
2095 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002096 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002097 goto exit;
2098
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002099 status = psa_validate_optional_attributes( source_slot,
2100 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002101 if( status != PSA_SUCCESS )
2102 goto exit;
2103
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002104 status = psa_restrict_key_policy( source_slot->attr.type,
2105 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002106 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002107 if( status != PSA_SUCCESS )
2108 goto exit;
2109
Ronald Cron81709fc2020-11-14 12:10:32 +01002110 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2111 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002112 if( status != PSA_SUCCESS )
2113 goto exit;
2114
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002115#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2116 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002117 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002118 /* Copying to a secure element is not implemented yet. */
2119 status = PSA_ERROR_NOT_SUPPORTED;
2120 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002121 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002122#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002123
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002124 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002125 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002126 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002127
Ronald Cron81709fc2020-11-14 12:10:32 +01002128 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002129exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002130 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002131 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002132
Ronald Cron5c522922020-11-14 16:35:34 +01002133 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002134
Ronald Cron5c522922020-11-14 16:35:34 +01002135 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002136}
2137
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002138
2139
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002140/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002141/* Message digests */
2142/****************************************************************/
2143
John Durkop07cc04a2020-11-16 22:08:34 -08002144#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002145 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2146 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002147 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Ronald Cron36f641b2021-02-16 17:20:43 +01002148const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002149{
2150 switch( alg )
2151 {
John Durkopee4e6602020-11-27 08:48:46 -08002152#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002153 case PSA_ALG_MD2:
2154 return( &mbedtls_md2_info );
2155#endif
John Durkopee4e6602020-11-27 08:48:46 -08002156#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002157 case PSA_ALG_MD4:
2158 return( &mbedtls_md4_info );
2159#endif
John Durkopee4e6602020-11-27 08:48:46 -08002160#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002161 case PSA_ALG_MD5:
2162 return( &mbedtls_md5_info );
2163#endif
John Durkopee4e6602020-11-27 08:48:46 -08002164#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002165 case PSA_ALG_RIPEMD160:
2166 return( &mbedtls_ripemd160_info );
2167#endif
John Durkopee4e6602020-11-27 08:48:46 -08002168#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002169 case PSA_ALG_SHA_1:
2170 return( &mbedtls_sha1_info );
2171#endif
John Durkopee4e6602020-11-27 08:48:46 -08002172#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002173 case PSA_ALG_SHA_224:
2174 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002175#endif
2176#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002177 case PSA_ALG_SHA_256:
2178 return( &mbedtls_sha256_info );
2179#endif
John Durkopee4e6602020-11-27 08:48:46 -08002180#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002181 case PSA_ALG_SHA_384:
2182 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002183#endif
John Durkopee4e6602020-11-27 08:48:46 -08002184#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002185 case PSA_ALG_SHA_512:
2186 return( &mbedtls_sha512_info );
2187#endif
2188 default:
2189 return( NULL );
2190 }
2191}
John Durkop07cc04a2020-11-16 22:08:34 -08002192#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002193 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2194 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2195 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002196
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2198{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002199 /* Aborting a non-active operation is allowed */
2200 if( operation->id == 0 )
2201 return( PSA_SUCCESS );
2202
2203 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2204 operation->id = 0;
2205
2206 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207}
2208
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002209psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002210 psa_algorithm_t alg )
2211{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002212 /* A context must be freshly initialized before it can be set up. */
2213 if( operation->id != 0 )
2214 return( PSA_ERROR_BAD_STATE );
2215
2216 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002217 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002218
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002219 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002220}
2221
2222psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2223 const uint8_t *input,
2224 size_t input_length )
2225{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002226 if( operation->id == 0 )
2227 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002228
Steven Cooremanc8288352021-03-04 14:02:19 +01002229 /* Don't require hash implementations to behave correctly on a
2230 * zero-length input, which may have an invalid pointer. */
2231 if( input_length == 0 )
2232 return( PSA_SUCCESS );
2233
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002234 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2235 input, input_length );
2236 if( status != PSA_SUCCESS )
2237 psa_hash_abort( operation );
2238
2239 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240}
2241
2242psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2243 uint8_t *hash,
2244 size_t hash_size,
2245 size_t *hash_length )
2246{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002247 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002248 if( operation->id == 0 )
2249 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250
Steven Cooreman1e582352021-02-18 17:24:37 +01002251 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002252 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002253 psa_hash_abort( operation );
2254 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255}
2256
Gilles Peskine2d277862018-06-18 15:41:12 +02002257psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2258 const uint8_t *hash,
2259 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002260{
2261 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2262 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002263 psa_status_t status = psa_hash_finish(
2264 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002265 actual_hash, sizeof( actual_hash ),
2266 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002267 if( status != PSA_SUCCESS )
2268 return( status );
2269 if( actual_hash_length != hash_length )
2270 return( PSA_ERROR_INVALID_SIGNATURE );
2271 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2272 return( PSA_ERROR_INVALID_SIGNATURE );
2273 return( PSA_SUCCESS );
2274}
2275
Gilles Peskine0a749c82019-11-28 19:33:58 +01002276psa_status_t psa_hash_compute( psa_algorithm_t alg,
2277 const uint8_t *input, size_t input_length,
2278 uint8_t *hash, size_t hash_size,
2279 size_t *hash_length )
2280{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002281 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002282 if( !PSA_ALG_IS_HASH( alg ) )
2283 return( PSA_ERROR_INVALID_ARGUMENT );
2284
Steven Cooreman1e582352021-02-18 17:24:37 +01002285 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2286 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002287}
2288
2289psa_status_t psa_hash_compare( psa_algorithm_t alg,
2290 const uint8_t *input, size_t input_length,
2291 const uint8_t *hash, size_t hash_length )
2292{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002293 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2294 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002295
2296 if( !PSA_ALG_IS_HASH( alg ) )
2297 return( PSA_ERROR_INVALID_ARGUMENT );
2298
Steven Cooreman1e582352021-02-18 17:24:37 +01002299 psa_status_t status = psa_driver_wrapper_hash_compute(
2300 alg, input, input_length,
2301 actual_hash, sizeof(actual_hash),
2302 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002303 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002304 return( status );
2305 if( actual_hash_length != hash_length )
2306 return( PSA_ERROR_INVALID_SIGNATURE );
2307 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2308 return( PSA_ERROR_INVALID_SIGNATURE );
2309 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002310}
2311
Gilles Peskineeb35d782019-01-22 17:56:16 +01002312psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2313 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002314{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002315 if( source_operation->id == 0 ||
2316 target_operation->id != 0 )
2317 {
2318 return( PSA_ERROR_BAD_STATE );
2319 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002320
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002321 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2322 target_operation );
2323 if( status != PSA_SUCCESS )
2324 psa_hash_abort( target_operation );
2325
2326 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002327}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002328
2329
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002330/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002331/* MAC */
2332/****************************************************************/
2333
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002334static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002335 psa_algorithm_t alg,
2336 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002337 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002338 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002339{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002340 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002341 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002342
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002343 if( PSA_ALG_IS_AEAD( alg ) )
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002344 alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002345
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2347 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002348 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002349 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002350 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351 mode = MBEDTLS_MODE_STREAM;
2352 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002353 case PSA_ALG_CTR:
2354 mode = MBEDTLS_MODE_CTR;
2355 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002356 case PSA_ALG_CFB:
2357 mode = MBEDTLS_MODE_CFB;
2358 break;
2359 case PSA_ALG_OFB:
2360 mode = MBEDTLS_MODE_OFB;
2361 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002362 case PSA_ALG_ECB_NO_PADDING:
2363 mode = MBEDTLS_MODE_ECB;
2364 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002365 case PSA_ALG_CBC_NO_PADDING:
2366 mode = MBEDTLS_MODE_CBC;
2367 break;
2368 case PSA_ALG_CBC_PKCS7:
2369 mode = MBEDTLS_MODE_CBC;
2370 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002371 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002372 mode = MBEDTLS_MODE_CCM;
2373 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002374 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002375 mode = MBEDTLS_MODE_GCM;
2376 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002377 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02002378 mode = MBEDTLS_MODE_CHACHAPOLY;
2379 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002380 default:
2381 return( NULL );
2382 }
2383 }
2384 else if( alg == PSA_ALG_CMAC )
2385 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002386 else
2387 return( NULL );
2388
2389 switch( key_type )
2390 {
2391 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002392 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002393 break;
2394 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002395 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2396 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002397 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002398 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002399 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002400 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002401 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2402 * but two-key Triple-DES is functionally three-key Triple-DES
2403 * with K1=K3, so that's how we present it to mbedtls. */
2404 if( key_bits == 128 )
2405 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002406 break;
2407 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002408 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002409 break;
2410 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002411 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002413 case PSA_KEY_TYPE_CHACHA20:
2414 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2415 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002416 default:
2417 return( NULL );
2418 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002419 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002420 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002421
Jaeden Amero23bbb752018-06-26 14:16:54 +01002422 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2423 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002424}
2425
John Durkop6ba40d12020-11-10 08:50:04 -08002426#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002427static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002428{
Gilles Peskine2d277862018-06-18 15:41:12 +02002429 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002430 {
2431 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002432 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002433 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002434 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002435 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002436 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002437 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002438 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002439 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002440 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002441 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002442 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002443 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002444 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002445 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002446 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002447 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002448 return( 128 );
2449 default:
2450 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002451 }
2452}
John Durkop07cc04a2020-11-16 22:08:34 -08002453#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002454
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002455/* Initialize the MAC operation structure. Once this function has been
2456 * called, psa_mac_abort can run and will do the right thing. */
2457static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2458 psa_algorithm_t alg )
2459{
2460 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2461
Steven Cooreman15472f82021-03-02 16:16:22 +01002462 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002463 operation->key_set = 0;
2464 operation->iv_set = 0;
2465 operation->iv_required = 0;
2466 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002467 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002468
2469#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002470 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002471 {
2472 operation->iv_required = 0;
2473 mbedtls_cipher_init( &operation->ctx.cmac );
2474 status = PSA_SUCCESS;
2475 }
2476 else
2477#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002478#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002479 if( PSA_ALG_IS_HMAC( operation->alg ) )
2480 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002481 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002482 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002483 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002484 }
2485 else
John Durkopd0321952020-10-29 21:37:36 -07002486#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002487 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002488 if( ! PSA_ALG_IS_MAC( alg ) )
2489 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002490 }
2491
2492 if( status != PSA_SUCCESS )
2493 memset( operation, 0, sizeof( *operation ) );
2494 return( status );
2495}
2496
John Durkop6ba40d12020-11-10 08:50:04 -08002497#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002498static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2499{
Gilles Peskine3f108122018-12-07 18:14:53 +01002500 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002501 return( psa_hash_abort( &hmac->hash_ctx ) );
2502}
John Durkop6ba40d12020-11-10 08:50:04 -08002503#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002504
Gilles Peskine8c9def32018-02-08 10:02:12 +01002505psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2506{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002507 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002508 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002509 /* The object has (apparently) been initialized but it is not
2510 * in use. It's ok to call abort on such an object, and there's
2511 * nothing to do. */
2512 return( PSA_SUCCESS );
2513 }
2514 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002516 if( operation->alg == PSA_ALG_CMAC )
2517 {
2518 mbedtls_cipher_free( &operation->ctx.cmac );
2519 }
2520 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002521#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002522#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002523 if( PSA_ALG_IS_HMAC( operation->alg ) )
2524 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002525 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002526 }
2527 else
John Durkopd0321952020-10-29 21:37:36 -07002528#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002529 {
2530 /* Sanity check (shouldn't happen: operation->alg should
2531 * always have been initialized to a valid value). */
2532 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002533 }
Moran Peker41deec42018-04-04 15:43:05 +03002534
Gilles Peskine8c9def32018-02-08 10:02:12 +01002535 operation->alg = 0;
2536 operation->key_set = 0;
2537 operation->iv_set = 0;
2538 operation->iv_required = 0;
2539 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002540 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002541
Gilles Peskine8c9def32018-02-08 10:02:12 +01002542 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002543
2544bad_state:
2545 /* If abort is called on an uninitialized object, we can't trust
2546 * anything. Wipe the object in case it contains confidential data.
2547 * This may result in a memory leak if a pointer gets overwritten,
2548 * but it's too late to do anything about this. */
2549 memset( operation, 0, sizeof( *operation ) );
2550 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002551}
2552
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002553#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002554static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2555 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002556{
Janos Follath24eed8d2019-11-22 13:21:35 +00002557 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002558 const mbedtls_cipher_info_t *cipher_info =
2559 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2560 slot->attr.type, slot->attr.bits,
2561 NULL );
2562 if( cipher_info == NULL )
2563 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002564
2565 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2566 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002567 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002568
2569 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002570 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002571 slot->attr.bits );
2572exit:
2573 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002574}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002575#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002576
John Durkop6ba40d12020-11-10 08:50:04 -08002577#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002578static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2579 const uint8_t *key,
2580 size_t key_length,
2581 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002582{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002583 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002584 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002585 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002586 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002587 psa_status_t status;
2588
Steven Cooreman0e307642021-02-18 16:18:32 +01002589 hmac->alg = hash_alg;
2590
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002591 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2592 * overflow below. This should never trigger if the hash algorithm
2593 * is implemented correctly. */
2594 /* The size checks against the ipad and opad buffers cannot be written
2595 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2596 * because that triggers -Wlogical-op on GCC 7.3. */
2597 if( block_size > sizeof( ipad ) )
2598 return( PSA_ERROR_NOT_SUPPORTED );
2599 if( block_size > sizeof( hmac->opad ) )
2600 return( PSA_ERROR_NOT_SUPPORTED );
2601 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002602 return( PSA_ERROR_NOT_SUPPORTED );
2603
Gilles Peskined223b522018-06-11 18:12:58 +02002604 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002605 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002606 status = psa_hash_compute( hash_alg, key, key_length,
2607 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002608 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002609 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002610 }
Gilles Peskine96889972018-07-12 17:07:03 +02002611 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2612 * but it is permitted. It is common when HMAC is used in HKDF, for
2613 * example. Don't call `memcpy` in the 0-length because `key` could be
2614 * an invalid pointer which would make the behavior undefined. */
2615 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002616 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002617
Gilles Peskined223b522018-06-11 18:12:58 +02002618 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2619 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002620 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002621 ipad[i] ^= 0x36;
2622 memset( ipad + key_length, 0x36, block_size - key_length );
2623
2624 /* Copy the key material from ipad to opad, flipping the requisite bits,
2625 * and filling the rest of opad with the requisite constant. */
2626 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002627 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2628 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002629
Gilles Peskine01126fa2018-07-12 17:04:55 +02002630 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002631 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002632 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002633
Gilles Peskine01126fa2018-07-12 17:04:55 +02002634 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002635
2636cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002637 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002638
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002639 return( status );
2640}
John Durkop6ba40d12020-11-10 08:50:04 -08002641#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002642
Gilles Peskine89167cb2018-07-08 20:12:23 +02002643static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002644 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002645 psa_algorithm_t alg,
2646 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002648 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002649 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002650 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002651 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002652 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002653
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002654 /* A context must be freshly initialized before it can be set up. */
2655 if( operation->alg != 0 )
2656 {
2657 return( PSA_ERROR_BAD_STATE );
2658 }
2659
Steven Cooreman15472f82021-03-02 16:16:22 +01002660 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002661 if( status != PSA_SUCCESS )
2662 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002663 if( is_sign )
2664 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665
Ronald Cron5c522922020-11-14 16:35:34 +01002666 status = psa_get_and_lock_transparent_key_slot_with_policy(
2667 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002668 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002669 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002670
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002671 /* Validate the combination of key type and algorithm */
2672 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002673 if( status != PSA_SUCCESS )
2674 goto exit;
2675
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002676 /* Get the output length for the algorithm and key combination. None of the
2677 * currently supported algorithms have an output length dependent on actual
2678 * key size, so setting it to a bogus value is currently OK. */
2679 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002680
2681 if( operation->mac_size < 4 )
2682 {
2683 /* A very short MAC is too short for security since it can be
2684 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2685 * so we make this our minimum, even though 32 bits is still
2686 * too small for security. */
2687 status = PSA_ERROR_NOT_SUPPORTED;
2688 goto exit;
2689 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002690
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002691 if( operation->mac_size >
2692 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2693 {
2694 /* It's impossible to "truncate" to a larger length than the full length
2695 * of the algorithm. */
2696 status = PSA_ERROR_INVALID_ARGUMENT;
2697 goto exit;
2698 }
2699
Gilles Peskine8c9def32018-02-08 10:02:12 +01002700#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002701 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002702 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002703 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002704 }
2705 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002706#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002707#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002708 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002709 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002710 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002711 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002712 {
2713 status = PSA_ERROR_NOT_SUPPORTED;
2714 goto exit;
2715 }
2716
Gilles Peskine8e338702019-07-30 20:06:31 +02002717 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002718 {
2719 status = PSA_ERROR_INVALID_ARGUMENT;
2720 goto exit;
2721 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002722
Gilles Peskine01126fa2018-07-12 17:04:55 +02002723 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002724 slot->key.data,
2725 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002726 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002727 }
2728 else
John Durkopd0321952020-10-29 21:37:36 -07002729#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002730 {
2731 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002732 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002733
Gilles Peskinefbfac682018-07-08 20:51:54 +02002734exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002735 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002736 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002737 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002738 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002739 else
2740 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002741 operation->key_set = 1;
2742 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002743
Ronald Cron5c522922020-11-14 16:35:34 +01002744 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002745
Ronald Cron5c522922020-11-14 16:35:34 +01002746 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002747}
2748
Gilles Peskine89167cb2018-07-08 20:12:23 +02002749psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002750 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002751 psa_algorithm_t alg )
2752{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002753 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002754}
2755
2756psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002757 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002758 psa_algorithm_t alg )
2759{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002760 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002761}
2762
Gilles Peskine8c9def32018-02-08 10:02:12 +01002763psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2764 const uint8_t *input,
2765 size_t input_length )
2766{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002767 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002768 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002769 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002770 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002771 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002772 operation->has_input = 1;
2773
Gilles Peskine8c9def32018-02-08 10:02:12 +01002774#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002775 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002776 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002777 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2778 input, input_length );
2779 status = mbedtls_to_psa_error( ret );
2780 }
2781 else
2782#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002783#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002784 if( PSA_ALG_IS_HMAC( operation->alg ) )
2785 {
2786 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2787 input_length );
2788 }
2789 else
John Durkopd0321952020-10-29 21:37:36 -07002790#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002791 {
2792 /* This shouldn't happen if `operation` was initialized by
2793 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002794 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002795 }
2796
Gilles Peskinefbfac682018-07-08 20:51:54 +02002797 if( status != PSA_SUCCESS )
2798 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002799 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800}
2801
John Durkop6ba40d12020-11-10 08:50:04 -08002802#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002803static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2804 uint8_t *mac,
2805 size_t mac_size )
2806{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002807 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002808 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002809 size_t hash_size = 0;
2810 size_t block_size = psa_get_hash_block_size( hash_alg );
2811 psa_status_t status;
2812
Gilles Peskine01126fa2018-07-12 17:04:55 +02002813 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2814 if( status != PSA_SUCCESS )
2815 return( status );
2816 /* From here on, tmp needs to be wiped. */
2817
2818 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2819 if( status != PSA_SUCCESS )
2820 goto exit;
2821
2822 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2823 if( status != PSA_SUCCESS )
2824 goto exit;
2825
2826 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2827 if( status != PSA_SUCCESS )
2828 goto exit;
2829
Gilles Peskined911eb72018-08-14 15:18:45 +02002830 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2831 if( status != PSA_SUCCESS )
2832 goto exit;
2833
2834 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002835
2836exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002837 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002838 return( status );
2839}
John Durkop6ba40d12020-11-10 08:50:04 -08002840#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002841
mohammad16036df908f2018-04-02 08:34:15 -07002842static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002843 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002844 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002845{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002846 if( ! operation->key_set )
2847 return( PSA_ERROR_BAD_STATE );
2848 if( operation->iv_required && ! operation->iv_set )
2849 return( PSA_ERROR_BAD_STATE );
2850
Gilles Peskine8c9def32018-02-08 10:02:12 +01002851 if( mac_size < operation->mac_size )
2852 return( PSA_ERROR_BUFFER_TOO_SMALL );
2853
Gilles Peskine8c9def32018-02-08 10:02:12 +01002854#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002855 if( operation->alg == PSA_ALG_CMAC )
2856 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002857 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002858 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2859 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002860 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002861 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002862 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002863 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002864 else
2865#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002866#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002867 if( PSA_ALG_IS_HMAC( operation->alg ) )
2868 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002869 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002870 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002871 }
2872 else
John Durkopd0321952020-10-29 21:37:36 -07002873#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002874 {
2875 /* This shouldn't happen if `operation` was initialized by
2876 * a setup function. */
2877 return( PSA_ERROR_BAD_STATE );
2878 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002879}
2880
Gilles Peskineacd4be32018-07-08 19:56:25 +02002881psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2882 uint8_t *mac,
2883 size_t mac_size,
2884 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002885{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002886 psa_status_t status;
2887
Jaeden Amero252ef282019-02-15 14:05:35 +00002888 if( operation->alg == 0 )
2889 {
2890 return( PSA_ERROR_BAD_STATE );
2891 }
2892
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002893 /* Fill the output buffer with something that isn't a valid mac
2894 * (barring an attack on the mac and deliberately-crafted input),
2895 * in case the caller doesn't check the return status properly. */
2896 *mac_length = mac_size;
2897 /* If mac_size is 0 then mac may be NULL and then the
2898 * call to memset would have undefined behavior. */
2899 if( mac_size != 0 )
2900 memset( mac, '!', mac_size );
2901
Gilles Peskine89167cb2018-07-08 20:12:23 +02002902 if( ! operation->is_sign )
2903 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002904 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002905 }
mohammad16036df908f2018-04-02 08:34:15 -07002906
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002907 status = psa_mac_finish_internal( operation, mac, mac_size );
2908
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002909 if( status == PSA_SUCCESS )
2910 {
2911 status = psa_mac_abort( operation );
2912 if( status == PSA_SUCCESS )
2913 *mac_length = operation->mac_size;
2914 else
2915 memset( mac, '!', mac_size );
2916 }
2917 else
2918 psa_mac_abort( operation );
2919 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002920}
2921
Gilles Peskineacd4be32018-07-08 19:56:25 +02002922psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2923 const uint8_t *mac,
2924 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002925{
Gilles Peskine828ed142018-06-18 23:25:51 +02002926 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002927 psa_status_t status;
2928
Jaeden Amero252ef282019-02-15 14:05:35 +00002929 if( operation->alg == 0 )
2930 {
2931 return( PSA_ERROR_BAD_STATE );
2932 }
2933
Gilles Peskine89167cb2018-07-08 20:12:23 +02002934 if( operation->is_sign )
2935 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002936 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002937 }
2938 if( operation->mac_size != mac_length )
2939 {
2940 status = PSA_ERROR_INVALID_SIGNATURE;
2941 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002942 }
mohammad16036df908f2018-04-02 08:34:15 -07002943
2944 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002945 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002946 if( status != PSA_SUCCESS )
2947 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002948
2949 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2950 status = PSA_ERROR_INVALID_SIGNATURE;
2951
2952cleanup:
2953 if( status == PSA_SUCCESS )
2954 status = psa_mac_abort( operation );
2955 else
2956 psa_mac_abort( operation );
2957
Gilles Peskine3f108122018-12-07 18:14:53 +01002958 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002959
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002960 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961}
2962
2963
Gilles Peskine20035e32018-02-03 22:44:14 +01002964
Gilles Peskine20035e32018-02-03 22:44:14 +01002965/****************************************************************/
2966/* Asymmetric cryptography */
2967/****************************************************************/
2968
Ronald Cron67b1eb32020-12-08 17:37:27 +01002969psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002970 const psa_key_attributes_t *attributes,
2971 const uint8_t *key_buffer, size_t key_buffer_size,
2972 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2973 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002974{
Gilles Peskine20035e32018-02-03 22:44:14 +01002975#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2976 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01002977 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002978 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01002979 return( mbedtls_psa_rsa_sign_hash(
2980 attributes,
2981 key_buffer, key_buffer_size,
2982 alg, hash, hash_length,
2983 signature, signature_size, signature_length ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01002984 }
2985 else
Gilles Peskine20035e32018-02-03 22:44:14 +01002986#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2987 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002988#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2989 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Ronald Cronbb9cbc72021-03-04 17:09:00 +01002990 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01002991 {
Ronald Cron9103d492021-03-04 11:26:03 +01002992 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002993 {
Ronald Cron072722c2020-12-09 16:36:19 +01002994 return( mbedtls_psa_ecdsa_sign_hash(
2995 attributes,
2996 key_buffer, key_buffer_size,
2997 alg, hash, hash_length,
2998 signature, signature_size, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02002999 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003000 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003001 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003002 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003003 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003004 }
3005 else
Gilles Peskinee59236f2018-01-27 23:32:46 +01003006#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3007 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
itayzafrir5c753392018-05-08 11:18:38 +03003008 {
Ronald Cronbb9cbc72021-03-04 17:09:00 +01003009 (void)attributes;
Ronald Cron8a494f32021-02-17 09:49:51 +01003010 (void)key_buffer;
3011 (void)key_buffer_size;
3012 (void)alg;
3013 (void)hash;
3014 (void)hash_length;
3015 (void)signature;
3016 (void)signature_size;
3017 (void)signature_length;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003018
Ronald Cron8a494f32021-02-17 09:49:51 +01003019 return( PSA_ERROR_NOT_SUPPORTED );
3020 }
Ronald Cron18659932020-12-08 16:32:23 +01003021}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003022
3023psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
3024 psa_algorithm_t alg,
3025 const uint8_t *hash,
3026 size_t hash_length,
3027 uint8_t *signature,
3028 size_t signature_size,
3029 size_t *signature_length )
3030{
3031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3032 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3033 psa_key_slot_t *slot;
3034
3035 *signature_length = signature_size;
3036 /* Immediately reject a zero-length signature buffer. This guarantees
3037 * that signature must be a valid pointer. (On the other hand, the hash
3038 * buffer can in principle be empty since it doesn't actually have
3039 * to be a hash.) */
3040 if( signature_size == 0 )
3041 return( PSA_ERROR_BUFFER_TOO_SMALL );
3042
3043 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3044 PSA_KEY_USAGE_SIGN_HASH,
3045 alg );
3046 if( status != PSA_SUCCESS )
3047 goto exit;
3048 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
3049 {
3050 status = PSA_ERROR_INVALID_ARGUMENT;
3051 goto exit;
3052 }
3053
Ronald Cron9f17aa42020-12-08 17:07:25 +01003054 psa_key_attributes_t attributes = {
3055 .core = slot->attr
3056 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003057
Ronald Cron9f17aa42020-12-08 17:07:25 +01003058 status = psa_driver_wrapper_sign_hash(
3059 &attributes, slot->key.data, slot->key.bytes,
3060 alg, hash, hash_length,
3061 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003062
3063exit:
3064 /* Fill the unused part of the output buffer (the whole buffer on error,
3065 * the trailing part on success) with something that isn't a valid mac
3066 * (barring an attack on the mac and deliberately-crafted input),
3067 * in case the caller doesn't check the return status properly. */
3068 if( status == PSA_SUCCESS )
3069 memset( signature + *signature_length, '!',
3070 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003071 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003072 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003073 /* If signature_size is 0 then we have nothing to do. We must not call
3074 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003075
Ronald Cron5c522922020-11-14 16:35:34 +01003076 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003077
Ronald Cron5c522922020-11-14 16:35:34 +01003078 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003079}
3080
Ronald Cron67b1eb32020-12-08 17:37:27 +01003081psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01003082 const psa_key_attributes_t *attributes,
3083 const uint8_t *key_buffer, size_t key_buffer_size,
3084 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3085 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003086{
John Durkop6ba40d12020-11-10 08:50:04 -08003087#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3088 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01003089 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003090 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01003091 return( mbedtls_psa_rsa_verify_hash(
3092 attributes,
3093 key_buffer, key_buffer_size,
3094 alg, hash, hash_length,
3095 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096 }
3097 else
John Durkop6ba40d12020-11-10 08:50:04 -08003098#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3099 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Ronald Cron99b8ed72021-02-17 10:33:32 +01003100 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003101 {
John Durkop9814fa22020-11-04 12:28:15 -08003102#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3103 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003104 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003105 {
Ronald Cron072722c2020-12-09 16:36:19 +01003106 return( mbedtls_psa_ecdsa_verify_hash(
3107 attributes,
3108 key_buffer, key_buffer_size,
3109 alg, hash, hash_length,
3110 signature, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003111 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003112 else
John Durkop9814fa22020-11-04 12:28:15 -08003113#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3114 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003115 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003116 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003117 }
itayzafrir5c753392018-05-08 11:18:38 +03003118 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003119 else
Gilles Peskinee59236f2018-01-27 23:32:46 +01003120 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003121 (void)key_buffer;
3122 (void)key_buffer_size;
3123 (void)alg;
3124 (void)hash;
3125 (void)hash_length;
3126 (void)signature;
3127 (void)signature_length;
Ronald Cronf95a2b12020-10-22 15:24:49 +02003128
Ronald Cron8a494f32021-02-17 09:49:51 +01003129 return( PSA_ERROR_NOT_SUPPORTED );
3130 }
Ronald Cron18659932020-12-08 16:32:23 +01003131}
3132
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3134 psa_algorithm_t alg,
3135 const uint8_t *hash,
3136 size_t hash_length,
3137 const uint8_t *signature,
3138 size_t signature_length )
3139{
3140 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3141 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003142 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003143
3144 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003145 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003146 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003147 if( status != PSA_SUCCESS )
3148 return( status );
3149
Ronald Cron9f17aa42020-12-08 17:07:25 +01003150 psa_key_attributes_t attributes = {
3151 .core = slot->attr
3152 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003153
Ronald Cron9f17aa42020-12-08 17:07:25 +01003154 status = psa_driver_wrapper_verify_hash(
3155 &attributes, slot->key.data, slot->key.bytes,
3156 alg, hash, hash_length,
3157 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003158
Ronald Cron5c522922020-11-14 16:35:34 +01003159 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003160
Ronald Cron5c522922020-11-14 16:35:34 +01003161 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003162}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003163
John Durkop0e005192020-10-31 22:06:54 -07003164#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003165static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3166 mbedtls_rsa_context *rsa )
3167{
3168 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3169 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3170 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3171 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3172}
John Durkop0e005192020-10-31 22:06:54 -07003173#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003174
Ronald Croncf56a0a2020-08-04 09:51:30 +02003175psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003176 psa_algorithm_t alg,
3177 const uint8_t *input,
3178 size_t input_length,
3179 const uint8_t *salt,
3180 size_t salt_length,
3181 uint8_t *output,
3182 size_t output_size,
3183 size_t *output_length )
3184{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003186 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003187 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003188
Darryl Green5cc689a2018-07-24 15:34:10 +01003189 (void) input;
3190 (void) input_length;
3191 (void) salt;
3192 (void) output;
3193 (void) output_size;
3194
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003195 *output_length = 0;
3196
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003197 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3198 return( PSA_ERROR_INVALID_ARGUMENT );
3199
Ronald Cron5c522922020-11-14 16:35:34 +01003200 status = psa_get_and_lock_transparent_key_slot_with_policy(
3201 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003202 if( status != PSA_SUCCESS )
3203 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003204 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3205 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003206 {
3207 status = PSA_ERROR_INVALID_ARGUMENT;
3208 goto exit;
3209 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210
John Durkop6ba40d12020-11-10 08:50:04 -08003211#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3212 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003213 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003215 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003216 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3217 slot->key.data,
3218 slot->key.bytes,
3219 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003220 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003221 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003222
3223 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003224 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003225 status = PSA_ERROR_BUFFER_TOO_SMALL;
3226 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003227 }
John Durkop0e005192020-10-31 22:06:54 -07003228#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003229 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3230 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003231 status = mbedtls_to_psa_error(
3232 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003233 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003234 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003235 MBEDTLS_RSA_PUBLIC,
3236 input_length,
3237 input,
3238 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003239 }
3240 else
John Durkop0e005192020-10-31 22:06:54 -07003241#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3242#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003243 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3244 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003245 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003246 status = mbedtls_to_psa_error(
3247 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003248 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003249 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003250 MBEDTLS_RSA_PUBLIC,
3251 salt, salt_length,
3252 input_length,
3253 input,
3254 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003255 }
3256 else
John Durkop0e005192020-10-31 22:06:54 -07003257#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003258 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003259 status = PSA_ERROR_INVALID_ARGUMENT;
3260 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003261 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003262rsa_exit:
3263 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003264 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003265
Steven Cooremana2371e52020-07-28 14:30:39 +02003266 mbedtls_rsa_free( rsa );
3267 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003268 }
3269 else
John Durkop9814fa22020-11-04 12:28:15 -08003270#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003271 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003272 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003273 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003274 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003275
3276exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003277 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003278
Ronald Cron5c522922020-11-14 16:35:34 +01003279 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003280}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003281
Ronald Croncf56a0a2020-08-04 09:51:30 +02003282psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003283 psa_algorithm_t alg,
3284 const uint8_t *input,
3285 size_t input_length,
3286 const uint8_t *salt,
3287 size_t salt_length,
3288 uint8_t *output,
3289 size_t output_size,
3290 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003291{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003292 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003293 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003294 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003295
Darryl Green5cc689a2018-07-24 15:34:10 +01003296 (void) input;
3297 (void) input_length;
3298 (void) salt;
3299 (void) output;
3300 (void) output_size;
3301
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003302 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003303
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003304 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3305 return( PSA_ERROR_INVALID_ARGUMENT );
3306
Ronald Cron5c522922020-11-14 16:35:34 +01003307 status = psa_get_and_lock_transparent_key_slot_with_policy(
3308 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003309 if( status != PSA_SUCCESS )
3310 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003311 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003312 {
3313 status = PSA_ERROR_INVALID_ARGUMENT;
3314 goto exit;
3315 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003316
John Durkop6ba40d12020-11-10 08:50:04 -08003317#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3318 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003319 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003320 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003321 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003322 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3323 slot->key.data,
3324 slot->key.bytes,
3325 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003326 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003327 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003328
Steven Cooremana2371e52020-07-28 14:30:39 +02003329 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003330 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003331 status = PSA_ERROR_INVALID_ARGUMENT;
3332 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003333 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003334
John Durkop0e005192020-10-31 22:06:54 -07003335#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003336 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003337 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003338 status = mbedtls_to_psa_error(
3339 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003340 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003341 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003342 MBEDTLS_RSA_PRIVATE,
3343 output_length,
3344 input,
3345 output,
3346 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003347 }
3348 else
John Durkop0e005192020-10-31 22:06:54 -07003349#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3350#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003351 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003352 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003353 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003354 status = mbedtls_to_psa_error(
3355 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003356 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003357 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003358 MBEDTLS_RSA_PRIVATE,
3359 salt, salt_length,
3360 output_length,
3361 input,
3362 output,
3363 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003364 }
3365 else
John Durkop0e005192020-10-31 22:06:54 -07003366#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003367 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003368 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003369 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003370
Steven Cooreman4fed4552020-08-03 14:46:03 +02003371rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003372 mbedtls_rsa_free( rsa );
3373 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003374 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003375 else
John Durkop6ba40d12020-11-10 08:50:04 -08003376#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3377 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003378 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003379 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003380 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003381
3382exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003383 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003384
Ronald Cron5c522922020-11-14 16:35:34 +01003385 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003386}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003387
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003388
3389
mohammad1603503973b2018-03-12 15:59:30 +02003390/****************************************************************/
3391/* Symmetric cryptography */
3392/****************************************************************/
3393
Gilles Peskinee553c652018-06-04 16:22:46 +02003394static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003395 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003396 psa_algorithm_t alg,
3397 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003398{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003399 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003400 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003401 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003402 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003403 size_t key_bits;
3404 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003405 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3406 PSA_KEY_USAGE_ENCRYPT :
3407 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003408
Steven Cooremand3feccd2020-09-01 15:56:14 +02003409 /* A context must be freshly initialized before it can be set up. */
3410 if( operation->alg != 0 )
3411 return( PSA_ERROR_BAD_STATE );
3412
Steven Cooremana07b9972020-09-10 14:54:14 +02003413 /* The requested algorithm must be one that can be processed by cipher. */
3414 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003415 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003416
Steven Cooremanef8575e2020-09-11 11:44:50 +02003417 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003418 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003419 if( status != PSA_SUCCESS )
3420 goto exit;
3421
3422 /* Initialize the operation struct members, except for alg. The alg member
3423 * is used to indicate to psa_cipher_abort that there are resources to free,
3424 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003425 operation->key_set = 0;
3426 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003427 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003428 operation->iv_size = 0;
3429 operation->block_size = 0;
3430 if( alg == PSA_ALG_ECB_NO_PADDING )
3431 operation->iv_required = 0;
3432 else
3433 operation->iv_required = 1;
3434
Steven Cooremana07b9972020-09-10 14:54:14 +02003435 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003436 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003437 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003438 slot,
3439 alg );
3440 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003441 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003442 slot,
3443 alg );
3444
Steven Cooremanef8575e2020-09-11 11:44:50 +02003445 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003446 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003447 /* Once the driver context is initialised, it needs to be freed using
3448 * psa_cipher_abort. Indicate this through setting alg. */
3449 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003450 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003451
Steven Cooremand3feccd2020-09-01 15:56:14 +02003452 if( status != PSA_ERROR_NOT_SUPPORTED ||
3453 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3454 goto exit;
3455
Steven Cooremana07b9972020-09-10 14:54:14 +02003456 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003457 * available for the given algorithm & key. */
3458 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003459
Steven Cooremana07b9972020-09-10 14:54:14 +02003460 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003461 * psa_cipher_abort. Indicate there is something to be freed through setting
3462 * alg, and indicate the operation is being done using mbedtls crypto through
3463 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003464 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003465 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02003466
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003467 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02003468 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003469 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003470 {
3471 status = PSA_ERROR_NOT_SUPPORTED;
3472 goto exit;
3473 }
mohammad1603503973b2018-03-12 15:59:30 +02003474
mohammad1603503973b2018-03-12 15:59:30 +02003475 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003476 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003477 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003478
David Brown12ca5032021-02-11 11:02:00 -07003479#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003480 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003481 {
3482 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003483 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01003484 memcpy( keys, slot->key.data, 16 );
3485 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003486 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3487 keys,
3488 192, cipher_operation );
3489 }
3490 else
3491#endif
3492 {
3493 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003494 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003495 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003496 }
Moran Peker41deec42018-04-04 15:43:05 +03003497 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003498 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003499
David Brown63ca2602021-01-26 11:51:12 -07003500#if defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
3501 defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003502 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003503 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003504 case PSA_ALG_CBC_NO_PADDING:
3505 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3506 MBEDTLS_PADDING_NONE );
3507 break;
3508 case PSA_ALG_CBC_PKCS7:
3509 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3510 MBEDTLS_PADDING_PKCS7 );
3511 break;
3512 default:
3513 /* The algorithm doesn't involve padding. */
3514 ret = 0;
3515 break;
3516 }
3517 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003518 goto exit;
David Brown288a96e2021-02-09 16:27:55 -07003519#endif /* MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING || MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7 */
mohammad16038481e742018-03-18 13:57:31 +02003520
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003521 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003522 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02003523 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
3524 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02003525 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003526 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003527 }
David Brown1bfe4d72021-02-16 12:54:35 -07003528#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +02003529 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01003530 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02003531 operation->iv_size = 12;
3532#endif
mohammad1603503973b2018-03-12 15:59:30 +02003533
Steven Cooreman7df02922020-09-09 15:28:49 +02003534 status = PSA_SUCCESS;
3535
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003536exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003537 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003538 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02003539 if( status == PSA_SUCCESS )
3540 {
3541 /* Update operation flags for both driver and software implementations */
3542 operation->key_set = 1;
3543 }
3544 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003545 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003546
Ronald Cron5c522922020-11-14 16:35:34 +01003547 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003548
Ronald Cron5c522922020-11-14 16:35:34 +01003549 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003550}
3551
Gilles Peskinefe119512018-07-08 21:39:34 +02003552psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003553 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003554 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003555{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003556 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003557}
3558
Gilles Peskinefe119512018-07-08 21:39:34 +02003559psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003560 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003561 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003562{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003563 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003564}
3565
Gilles Peskinefe119512018-07-08 21:39:34 +02003566psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003567 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003568 size_t iv_size,
3569 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003570{
itayzafrir534bd7c2018-08-02 13:56:32 +03003571 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003572 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003573 if( operation->iv_set || ! operation->iv_required )
3574 {
3575 return( PSA_ERROR_BAD_STATE );
3576 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003577
Steven Cooremanef8575e2020-09-11 11:44:50 +02003578 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003579 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003580 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003581 iv,
3582 iv_size,
3583 iv_length );
3584 goto exit;
3585 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003586
Moran Peker41deec42018-04-04 15:43:05 +03003587 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003588 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003589 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003590 goto exit;
3591 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003592 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003593 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003594 if( ret != 0 )
3595 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003596 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003597 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003598 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003599
mohammad16038481e742018-03-18 13:57:31 +02003600 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003601 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003602
Moran Peker395db872018-05-31 14:07:14 +03003603exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003604 if( status == PSA_SUCCESS )
3605 operation->iv_set = 1;
3606 else
Moran Peker395db872018-05-31 14:07:14 +03003607 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003608 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003609}
3610
Gilles Peskinefe119512018-07-08 21:39:34 +02003611psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003612 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003613 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003614{
itayzafrir534bd7c2018-08-02 13:56:32 +03003615 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003616 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003617 if( operation->iv_set || ! operation->iv_required )
3618 {
3619 return( PSA_ERROR_BAD_STATE );
3620 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003621
Steven Cooremanef8575e2020-09-11 11:44:50 +02003622 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003623 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003624 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003625 iv,
3626 iv_length );
3627 goto exit;
3628 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003629
Moran Pekera28258c2018-05-29 16:25:04 +03003630 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003631 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003632 status = PSA_ERROR_INVALID_ARGUMENT;
3633 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003634 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003635 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3636 status = mbedtls_to_psa_error( ret );
3637exit:
3638 if( status == PSA_SUCCESS )
3639 operation->iv_set = 1;
3640 else
mohammad1603503973b2018-03-12 15:59:30 +02003641 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003642 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003643}
3644
Steven Cooreman177deba2020-09-07 17:14:14 +02003645/* Process input for which the algorithm is set to ECB mode. This requires
3646 * manual processing, since the PSA API is defined as being able to process
3647 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
3648 * underlying mbedtls_cipher_update only takes full blocks. */
3649static psa_status_t psa_cipher_update_ecb_internal(
3650 mbedtls_cipher_context_t *ctx,
3651 const uint8_t *input,
3652 size_t input_length,
3653 uint8_t *output,
3654 size_t output_size,
3655 size_t *output_length )
3656{
3657 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3658 size_t block_size = ctx->cipher_info->block_size;
3659 size_t internal_output_length = 0;
3660 *output_length = 0;
3661
3662 if( input_length == 0 )
3663 {
3664 status = PSA_SUCCESS;
3665 goto exit;
3666 }
3667
3668 if( ctx->unprocessed_len > 0 )
3669 {
3670 /* Fill up to block size, and run the block if there's a full one. */
3671 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
3672
3673 if( input_length < bytes_to_copy )
3674 bytes_to_copy = input_length;
3675
3676 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3677 input, bytes_to_copy );
3678 input_length -= bytes_to_copy;
3679 input += bytes_to_copy;
3680 ctx->unprocessed_len += bytes_to_copy;
3681
3682 if( ctx->unprocessed_len == block_size )
3683 {
3684 status = mbedtls_to_psa_error(
3685 mbedtls_cipher_update( ctx,
3686 ctx->unprocessed_data,
3687 block_size,
3688 output, &internal_output_length ) );
3689
3690 if( status != PSA_SUCCESS )
3691 goto exit;
3692
3693 output += internal_output_length;
3694 output_size -= internal_output_length;
3695 *output_length += internal_output_length;
3696 ctx->unprocessed_len = 0;
3697 }
3698 }
3699
3700 while( input_length >= block_size )
3701 {
3702 /* Run all full blocks we have, one by one */
3703 status = mbedtls_to_psa_error(
3704 mbedtls_cipher_update( ctx, input,
3705 block_size,
3706 output, &internal_output_length ) );
3707
3708 if( status != PSA_SUCCESS )
3709 goto exit;
3710
3711 input_length -= block_size;
3712 input += block_size;
3713
3714 output += internal_output_length;
3715 output_size -= internal_output_length;
3716 *output_length += internal_output_length;
3717 }
3718
3719 if( input_length > 0 )
3720 {
3721 /* Save unprocessed bytes for later processing */
3722 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3723 input, input_length );
3724 ctx->unprocessed_len += input_length;
3725 }
3726
3727 status = PSA_SUCCESS;
3728
3729exit:
3730 return( status );
3731}
3732
Gilles Peskinee553c652018-06-04 16:22:46 +02003733psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3734 const uint8_t *input,
3735 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003736 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003737 size_t output_size,
3738 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003739{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003740 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003741 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02003742 if( operation->alg == 0 )
3743 {
3744 return( PSA_ERROR_BAD_STATE );
3745 }
3746 if( operation->iv_required && ! operation->iv_set )
3747 {
3748 return( PSA_ERROR_BAD_STATE );
3749 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003750
Steven Cooremanef8575e2020-09-11 11:44:50 +02003751 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003752 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003753 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003754 input,
3755 input_length,
3756 output,
3757 output_size,
3758 output_length );
3759 goto exit;
3760 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003761
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003762 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003763 {
3764 /* Take the unprocessed partial block left over from previous
3765 * update calls, if any, plus the input to this call. Remove
3766 * the last partial block, if any. You get the data that will be
3767 * output in this call. */
3768 expected_output_size =
3769 ( operation->ctx.cipher.unprocessed_len + input_length )
3770 / operation->block_size * operation->block_size;
3771 }
3772 else
3773 {
3774 expected_output_size = input_length;
3775 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003776
Gilles Peskine89d789c2018-06-04 17:17:16 +02003777 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003778 {
3779 status = PSA_ERROR_BUFFER_TOO_SMALL;
3780 goto exit;
3781 }
mohammad160382759612018-03-12 18:16:40 +02003782
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003783 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
3784 {
3785 /* mbedtls_cipher_update has an API inconsistency: it will only
3786 * process a single block at a time in ECB mode. Abstract away that
3787 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02003788 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
3789 input,
3790 input_length,
3791 output,
3792 output_size,
3793 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003794 }
3795 else
3796 {
3797 status = mbedtls_to_psa_error(
3798 mbedtls_cipher_update( &operation->ctx.cipher, input,
3799 input_length, output, output_length ) );
3800 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003801exit:
3802 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003803 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003804 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003805}
3806
Gilles Peskinee553c652018-06-04 16:22:46 +02003807psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3808 uint8_t *output,
3809 size_t output_size,
3810 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003811{
David Saadab4ecc272019-02-14 13:48:10 +02003812 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02003813 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02003814 if( operation->alg == 0 )
3815 {
3816 return( PSA_ERROR_BAD_STATE );
3817 }
3818 if( operation->iv_required && ! operation->iv_set )
3819 {
3820 return( PSA_ERROR_BAD_STATE );
3821 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003822
Steven Cooremanef8575e2020-09-11 11:44:50 +02003823 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003824 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003825 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003826 output,
3827 output_size,
3828 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003829 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02003830 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003831
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003832 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003833 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003834 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02003835 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02003836 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003837 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003838 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003839 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003840 }
3841
Steven Cooremanef8575e2020-09-11 11:44:50 +02003842 status = mbedtls_to_psa_error(
3843 mbedtls_cipher_finish( &operation->ctx.cipher,
3844 temp_output_buffer,
3845 output_length ) );
3846 if( status != PSA_SUCCESS )
3847 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01003848
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003849 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003850 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003851 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003852 memcpy( output, temp_output_buffer, *output_length );
3853 else
Janos Follath315b51c2018-07-09 16:04:51 +01003854 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02003855
Steven Cooremanef8575e2020-09-11 11:44:50 +02003856exit:
3857 if( operation->mbedtls_in_use == 1 )
3858 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003859
Steven Cooremanef8575e2020-09-11 11:44:50 +02003860 if( status == PSA_SUCCESS )
3861 return( psa_cipher_abort( operation ) );
3862 else
3863 {
3864 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003865 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003866
Steven Cooremanef8575e2020-09-11 11:44:50 +02003867 return( status );
3868 }
mohammad1603503973b2018-03-12 15:59:30 +02003869}
3870
Gilles Peskinee553c652018-06-04 16:22:46 +02003871psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3872{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003873 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003874 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003875 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003876 * in use. It's ok to call abort on such an object, and there's
3877 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003878 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003879 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003880
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003881 /* Sanity check (shouldn't happen: operation->alg should
3882 * always have been initialized to a valid value). */
3883 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3884 return( PSA_ERROR_BAD_STATE );
3885
Steven Cooremanef8575e2020-09-11 11:44:50 +02003886 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003887 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003888 else
3889 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003890
Moran Peker41deec42018-04-04 15:43:05 +03003891 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003892 operation->key_set = 0;
3893 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003894 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003895 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003896 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003897 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003898
Moran Peker395db872018-05-31 14:07:14 +03003899 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003900}
3901
Gilles Peskinea0655c32018-04-30 17:06:50 +02003902
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003903
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003904
mohammad16035955c982018-04-26 00:53:03 +03003905/****************************************************************/
3906/* AEAD */
3907/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003908
Gilles Peskineedf9a652018-08-17 18:11:56 +02003909typedef struct
3910{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003911 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003912 const mbedtls_cipher_info_t *cipher_info;
3913 union
3914 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003915 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003916#if defined(MBEDTLS_CCM_C)
3917 mbedtls_ccm_context ccm;
3918#endif /* MBEDTLS_CCM_C */
3919#if defined(MBEDTLS_GCM_C)
3920 mbedtls_gcm_context gcm;
3921#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003922#if defined(MBEDTLS_CHACHAPOLY_C)
3923 mbedtls_chachapoly_context chachapoly;
3924#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003925 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003926 psa_algorithm_t core_alg;
3927 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003928 uint8_t tag_length;
3929} aead_operation_t;
3930
Ronald Cronf95a2b12020-10-22 15:24:49 +02003931#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
3932
Gilles Peskine30a9e412019-01-14 18:36:12 +01003933static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003934{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003935 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003936 {
3937#if defined(MBEDTLS_CCM_C)
3938 case PSA_ALG_CCM:
3939 mbedtls_ccm_free( &operation->ctx.ccm );
3940 break;
3941#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003942#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003943 case PSA_ALG_GCM:
3944 mbedtls_gcm_free( &operation->ctx.gcm );
3945 break;
3946#endif /* MBEDTLS_GCM_C */
3947 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003948
Ronald Cron5c522922020-11-14 16:35:34 +01003949 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003950}
3951
3952static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003953 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003954 psa_key_usage_t usage,
3955 psa_algorithm_t alg )
3956{
3957 psa_status_t status;
3958 size_t key_bits;
3959 mbedtls_cipher_id_t cipher_id;
3960
Ronald Cron5c522922020-11-14 16:35:34 +01003961 status = psa_get_and_lock_transparent_key_slot_with_policy(
3962 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003963 if( status != PSA_SUCCESS )
3964 return( status );
3965
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003966 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003967
3968 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003969 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003970 &cipher_id );
3971 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003972 {
3973 status = PSA_ERROR_NOT_SUPPORTED;
3974 goto cleanup;
3975 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003976
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003977 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003978 {
3979#if defined(MBEDTLS_CCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003980 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003981 operation->core_alg = PSA_ALG_CCM;
3982 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003983 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3984 * The call to mbedtls_ccm_encrypt_and_tag or
3985 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003986 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003987 {
3988 status = PSA_ERROR_INVALID_ARGUMENT;
3989 goto cleanup;
3990 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003991 mbedtls_ccm_init( &operation->ctx.ccm );
3992 status = mbedtls_to_psa_error(
3993 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003994 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003995 (unsigned int) key_bits ) );
3996 if( status != 0 )
3997 goto cleanup;
3998 break;
3999#endif /* MBEDTLS_CCM_C */
4000
4001#if defined(MBEDTLS_GCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004002 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004003 operation->core_alg = PSA_ALG_GCM;
4004 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004005 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4006 * The call to mbedtls_gcm_crypt_and_tag or
4007 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004008 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004009 {
4010 status = PSA_ERROR_INVALID_ARGUMENT;
4011 goto cleanup;
4012 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004013 mbedtls_gcm_init( &operation->ctx.gcm );
4014 status = mbedtls_to_psa_error(
4015 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004016 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004017 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004018 if( status != 0 )
4019 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004020 break;
4021#endif /* MBEDTLS_GCM_C */
4022
Gilles Peskine26869f22019-05-06 15:25:00 +02004023#if defined(MBEDTLS_CHACHAPOLY_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01004024 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02004025 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4026 operation->full_tag_length = 16;
4027 /* We only support the default tag length. */
4028 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004029 {
4030 status = PSA_ERROR_NOT_SUPPORTED;
4031 goto cleanup;
4032 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004033 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4034 status = mbedtls_to_psa_error(
4035 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004036 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004037 if( status != 0 )
4038 goto cleanup;
4039 break;
4040#endif /* MBEDTLS_CHACHAPOLY_C */
4041
Gilles Peskineedf9a652018-08-17 18:11:56 +02004042 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004043 status = PSA_ERROR_NOT_SUPPORTED;
4044 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004045 }
4046
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004047 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4048 {
4049 status = PSA_ERROR_INVALID_ARGUMENT;
4050 goto cleanup;
4051 }
4052 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004053
Gilles Peskineedf9a652018-08-17 18:11:56 +02004054 return( PSA_SUCCESS );
4055
4056cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004057 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004058 return( status );
4059}
4060
Ronald Croncf56a0a2020-08-04 09:51:30 +02004061psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004062 psa_algorithm_t alg,
4063 const uint8_t *nonce,
4064 size_t nonce_length,
4065 const uint8_t *additional_data,
4066 size_t additional_data_length,
4067 const uint8_t *plaintext,
4068 size_t plaintext_length,
4069 uint8_t *ciphertext,
4070 size_t ciphertext_size,
4071 size_t *ciphertext_length )
4072{
mohammad16035955c982018-04-26 00:53:03 +03004073 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004074 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004075 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004076
mohammad1603f08a5502018-06-03 15:05:47 +03004077 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004078
Ronald Croncf56a0a2020-08-04 09:51:30 +02004079 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004080 if( status != PSA_SUCCESS )
4081 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004082
Gilles Peskineedf9a652018-08-17 18:11:56 +02004083 /* For all currently supported modes, the tag is at the end of the
4084 * ciphertext. */
4085 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4086 {
4087 status = PSA_ERROR_BUFFER_TOO_SMALL;
4088 goto exit;
4089 }
4090 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004091
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004092#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004093 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004094 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004095 status = mbedtls_to_psa_error(
4096 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4097 MBEDTLS_GCM_ENCRYPT,
4098 plaintext_length,
4099 nonce, nonce_length,
4100 additional_data, additional_data_length,
4101 plaintext, ciphertext,
4102 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004103 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004104 else
4105#endif /* MBEDTLS_GCM_C */
4106#if defined(MBEDTLS_CCM_C)
4107 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004108 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004109 status = mbedtls_to_psa_error(
4110 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4111 plaintext_length,
4112 nonce, nonce_length,
4113 additional_data,
4114 additional_data_length,
4115 plaintext, ciphertext,
4116 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004117 }
mohammad16035c8845f2018-05-09 05:40:09 -07004118 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004119#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004120#if defined(MBEDTLS_CHACHAPOLY_C)
4121 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4122 {
4123 if( nonce_length != 12 || operation.tag_length != 16 )
4124 {
4125 status = PSA_ERROR_NOT_SUPPORTED;
4126 goto exit;
4127 }
4128 status = mbedtls_to_psa_error(
4129 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4130 plaintext_length,
4131 nonce,
4132 additional_data,
4133 additional_data_length,
4134 plaintext,
4135 ciphertext,
4136 tag ) );
4137 }
4138 else
4139#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004140 {
Steven Cooreman7196fef2021-02-10 17:13:28 +01004141 (void) tag;
mohammad1603554faad2018-06-03 15:07:38 +03004142 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004143 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004144
Gilles Peskineedf9a652018-08-17 18:11:56 +02004145 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4146 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004147
Gilles Peskineedf9a652018-08-17 18:11:56 +02004148exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004149 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004150 if( status == PSA_SUCCESS )
4151 *ciphertext_length = plaintext_length + operation.tag_length;
4152 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004153}
4154
Gilles Peskineee652a32018-06-01 19:23:52 +02004155/* Locate the tag in a ciphertext buffer containing the encrypted data
4156 * followed by the tag. Return the length of the part preceding the tag in
4157 * *plaintext_length. This is the size of the plaintext in modes where
4158 * the encrypted data has the same size as the plaintext, such as
4159 * CCM and GCM. */
4160static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4161 const uint8_t *ciphertext,
4162 size_t ciphertext_length,
4163 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004164 const uint8_t **p_tag )
4165{
4166 size_t payload_length;
4167 if( tag_length > ciphertext_length )
4168 return( PSA_ERROR_INVALID_ARGUMENT );
4169 payload_length = ciphertext_length - tag_length;
4170 if( payload_length > plaintext_size )
4171 return( PSA_ERROR_BUFFER_TOO_SMALL );
4172 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004173 return( PSA_SUCCESS );
4174}
4175
Ronald Croncf56a0a2020-08-04 09:51:30 +02004176psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004177 psa_algorithm_t alg,
4178 const uint8_t *nonce,
4179 size_t nonce_length,
4180 const uint8_t *additional_data,
4181 size_t additional_data_length,
4182 const uint8_t *ciphertext,
4183 size_t ciphertext_length,
4184 uint8_t *plaintext,
4185 size_t plaintext_size,
4186 size_t *plaintext_length )
4187{
mohammad16035955c982018-04-26 00:53:03 +03004188 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004189 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004190 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004191
Gilles Peskineee652a32018-06-01 19:23:52 +02004192 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004193
Ronald Croncf56a0a2020-08-04 09:51:30 +02004194 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004195 if( status != PSA_SUCCESS )
4196 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004197
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004198 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4199 ciphertext, ciphertext_length,
4200 plaintext_size, &tag );
4201 if( status != PSA_SUCCESS )
4202 goto exit;
4203
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004204#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004205 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004206 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004207 status = mbedtls_to_psa_error(
4208 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4209 ciphertext_length - operation.tag_length,
4210 nonce, nonce_length,
4211 additional_data,
4212 additional_data_length,
4213 tag, operation.tag_length,
4214 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004215 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004216 else
4217#endif /* MBEDTLS_GCM_C */
4218#if defined(MBEDTLS_CCM_C)
4219 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004220 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004221 status = mbedtls_to_psa_error(
4222 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4223 ciphertext_length - operation.tag_length,
4224 nonce, nonce_length,
4225 additional_data,
4226 additional_data_length,
4227 ciphertext, plaintext,
4228 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004229 }
mohammad160339574652018-06-01 04:39:53 -07004230 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004231#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004232#if defined(MBEDTLS_CHACHAPOLY_C)
4233 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4234 {
4235 if( nonce_length != 12 || operation.tag_length != 16 )
4236 {
4237 status = PSA_ERROR_NOT_SUPPORTED;
4238 goto exit;
4239 }
4240 status = mbedtls_to_psa_error(
4241 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4242 ciphertext_length - operation.tag_length,
4243 nonce,
4244 additional_data,
4245 additional_data_length,
4246 tag,
4247 ciphertext,
4248 plaintext ) );
4249 }
4250 else
4251#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004252 {
mohammad1603554faad2018-06-03 15:07:38 +03004253 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004254 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004255
Gilles Peskineedf9a652018-08-17 18:11:56 +02004256 if( status != PSA_SUCCESS && plaintext_size != 0 )
4257 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004258
Gilles Peskineedf9a652018-08-17 18:11:56 +02004259exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004260 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004261 if( status == PSA_SUCCESS )
4262 *plaintext_length = ciphertext_length - operation.tag_length;
4263 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004264}
4265
Gilles Peskinea0655c32018-04-30 17:06:50 +02004266
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004267
Gilles Peskinee59236f2018-01-27 23:32:46 +01004268/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004269/* Generators */
4270/****************************************************************/
4271
John Durkop07cc04a2020-11-16 22:08:34 -08004272#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4273 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4274 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4275#define AT_LEAST_ONE_BUILTIN_KDF
4276#endif
4277
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004278#define HKDF_STATE_INIT 0 /* no input yet */
4279#define HKDF_STATE_STARTED 1 /* got salt */
4280#define HKDF_STATE_KEYED 2 /* got key */
4281#define HKDF_STATE_OUTPUT 3 /* output started */
4282
Gilles Peskinecbe66502019-05-16 16:59:18 +02004283static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004284 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004285{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004286 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4287 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004288 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004289 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004290}
4291
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004292psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004293{
4294 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004295 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004296 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004297 {
4298 /* The object has (apparently) been initialized but it is not
4299 * in use. It's ok to call abort on such an object, and there's
4300 * nothing to do. */
4301 }
4302 else
John Durkopd0321952020-10-29 21:37:36 -07004303#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004304 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004305 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004306 mbedtls_free( operation->ctx.hkdf.info );
4307 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004308 }
John Durkop07cc04a2020-11-16 22:08:34 -08004309 else
4310#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4311#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4312 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4313 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004314 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004315 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004316 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004317 if( operation->ctx.tls12_prf.seed != NULL )
4318 {
4319 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4320 operation->ctx.tls12_prf.seed_length );
4321 mbedtls_free( operation->ctx.tls12_prf.seed );
4322 }
4323
4324 if( operation->ctx.tls12_prf.label != NULL )
4325 {
4326 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4327 operation->ctx.tls12_prf.label_length );
4328 mbedtls_free( operation->ctx.tls12_prf.label );
4329 }
4330
4331 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4332
4333 /* We leave the fields Ai and output_block to be erased safely by the
4334 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004335 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004336 else
John Durkop07cc04a2020-11-16 22:08:34 -08004337#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4338 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004339 {
4340 status = PSA_ERROR_BAD_STATE;
4341 }
Janos Follath083036a2019-06-11 10:22:26 +01004342 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004343 return( status );
4344}
4345
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004346psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004347 size_t *capacity)
4348{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004349 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004350 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004351 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004352 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004353 }
4354
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004355 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004356 return( PSA_SUCCESS );
4357}
4358
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004359psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004360 size_t capacity )
4361{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004362 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004363 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004364 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004365 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004366 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004367 return( PSA_SUCCESS );
4368}
4369
John Durkopd0321952020-10-29 21:37:36 -07004370#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004371/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004372 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004373static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004374 psa_algorithm_t hash_alg,
4375 uint8_t *output,
4376 size_t output_length )
4377{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004378 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004379 psa_status_t status;
4380
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004381 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4382 return( PSA_ERROR_BAD_STATE );
4383 hkdf->state = HKDF_STATE_OUTPUT;
4384
Gilles Peskinebef7f142018-07-12 17:22:21 +02004385 while( output_length != 0 )
4386 {
4387 /* Copy what remains of the current block */
4388 uint8_t n = hash_length - hkdf->offset_in_block;
4389 if( n > output_length )
4390 n = (uint8_t) output_length;
4391 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4392 output += n;
4393 output_length -= n;
4394 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004395 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004396 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004397 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004398 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004399 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004400 * object was corrupted or if this function is called directly
4401 * inside the library. */
4402 if( hkdf->block_number == 0xff )
4403 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004404
4405 /* We need a new block */
4406 ++hkdf->block_number;
4407 hkdf->offset_in_block = 0;
4408 status = psa_hmac_setup_internal( &hkdf->hmac,
4409 hkdf->prk, hash_length,
4410 hash_alg );
4411 if( status != PSA_SUCCESS )
4412 return( status );
4413 if( hkdf->block_number != 1 )
4414 {
4415 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4416 hkdf->output_block,
4417 hash_length );
4418 if( status != PSA_SUCCESS )
4419 return( status );
4420 }
4421 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4422 hkdf->info,
4423 hkdf->info_length );
4424 if( status != PSA_SUCCESS )
4425 return( status );
4426 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4427 &hkdf->block_number, 1 );
4428 if( status != PSA_SUCCESS )
4429 return( status );
4430 status = psa_hmac_finish_internal( &hkdf->hmac,
4431 hkdf->output_block,
4432 sizeof( hkdf->output_block ) );
4433 if( status != PSA_SUCCESS )
4434 return( status );
4435 }
4436
4437 return( PSA_SUCCESS );
4438}
John Durkop07cc04a2020-11-16 22:08:34 -08004439#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004440
John Durkop07cc04a2020-11-16 22:08:34 -08004441#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4442 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004443static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4444 psa_tls12_prf_key_derivation_t *tls12_prf,
4445 psa_algorithm_t alg )
4446{
4447 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004448 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004449 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4450 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004451
Janos Follath7742fee2019-06-17 12:58:10 +01004452 /* We can't be wanting more output after block 0xff, otherwise
4453 * the capacity check in psa_key_derivation_output_bytes() would have
4454 * prevented this call. It could happen only if the operation
4455 * object was corrupted or if this function is called directly
4456 * inside the library. */
4457 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004458 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004459
4460 /* We need a new block */
4461 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004462 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004463
4464 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4465 *
4466 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4467 *
4468 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4469 * HMAC_hash(secret, A(2) + seed) +
4470 * HMAC_hash(secret, A(3) + seed) + ...
4471 *
4472 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004473 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004474 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004475 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004476 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004477 * is currently extracted as `output_block` and where i is
4478 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004479 */
4480
Janos Follathea29bfb2019-06-19 12:21:20 +01004481 /* Save the hash context before using it, to preserve the hash state with
4482 * only the inner padding in it. We need this, because inner padding depends
4483 * on the key (secret in the RFC's terminology). */
4484 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4485 if( status != PSA_SUCCESS )
4486 goto cleanup;
4487
4488 /* Calculate A(i) where i = tls12_prf->block_number. */
4489 if( tls12_prf->block_number == 1 )
4490 {
4491 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4492 * the variable seed and in this instance means it in the context of the
4493 * P_hash function, where seed = label + seed.) */
4494 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4495 tls12_prf->label, tls12_prf->label_length );
4496 if( status != PSA_SUCCESS )
4497 goto cleanup;
4498 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4499 tls12_prf->seed, tls12_prf->seed_length );
4500 if( status != PSA_SUCCESS )
4501 goto cleanup;
4502 }
4503 else
4504 {
4505 /* A(i) = HMAC_hash(secret, A(i-1)) */
4506 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4507 tls12_prf->Ai, hash_length );
4508 if( status != PSA_SUCCESS )
4509 goto cleanup;
4510 }
4511
4512 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4513 tls12_prf->Ai, hash_length );
4514 if( status != PSA_SUCCESS )
4515 goto cleanup;
4516 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4517 if( status != PSA_SUCCESS )
4518 goto cleanup;
4519
4520 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4521 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4522 tls12_prf->Ai, hash_length );
4523 if( status != PSA_SUCCESS )
4524 goto cleanup;
4525 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4526 tls12_prf->label, tls12_prf->label_length );
4527 if( status != PSA_SUCCESS )
4528 goto cleanup;
4529 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4530 tls12_prf->seed, tls12_prf->seed_length );
4531 if( status != PSA_SUCCESS )
4532 goto cleanup;
4533 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4534 tls12_prf->output_block, hash_length );
4535 if( status != PSA_SUCCESS )
4536 goto cleanup;
4537 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4538 if( status != PSA_SUCCESS )
4539 goto cleanup;
4540
Janos Follath7742fee2019-06-17 12:58:10 +01004541
4542cleanup:
4543
Janos Follathea29bfb2019-06-19 12:21:20 +01004544 cleanup_status = psa_hash_abort( &backup );
4545 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4546 status = cleanup_status;
4547
4548 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004549}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004550
Janos Follath844eb0e2019-06-19 12:10:49 +01004551static psa_status_t psa_key_derivation_tls12_prf_read(
4552 psa_tls12_prf_key_derivation_t *tls12_prf,
4553 psa_algorithm_t alg,
4554 uint8_t *output,
4555 size_t output_length )
4556{
4557 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004558 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004559 psa_status_t status;
4560 uint8_t offset, length;
4561
4562 while( output_length != 0 )
4563 {
4564 /* Check if we have fully processed the current block. */
4565 if( tls12_prf->left_in_block == 0 )
4566 {
4567 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4568 alg );
4569 if( status != PSA_SUCCESS )
4570 return( status );
4571
4572 continue;
4573 }
4574
4575 if( tls12_prf->left_in_block > output_length )
4576 length = (uint8_t) output_length;
4577 else
4578 length = tls12_prf->left_in_block;
4579
4580 offset = hash_length - tls12_prf->left_in_block;
4581 memcpy( output, tls12_prf->output_block + offset, length );
4582 output += length;
4583 output_length -= length;
4584 tls12_prf->left_in_block -= length;
4585 }
4586
4587 return( PSA_SUCCESS );
4588}
John Durkop07cc04a2020-11-16 22:08:34 -08004589#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4590 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004591
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004592psa_status_t psa_key_derivation_output_bytes(
4593 psa_key_derivation_operation_t *operation,
4594 uint8_t *output,
4595 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004596{
4597 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004598 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004599
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004600 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004601 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004602 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004603 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004604 }
4605
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004606 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004607 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004608 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004609 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004610 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004611 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004612 goto exit;
4613 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004614 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004615 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004616 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004617 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004618 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4619 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004620 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004621 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004622 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004623 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004624 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004625
John Durkopd0321952020-10-29 21:37:36 -07004626#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004627 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004628 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004629 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004630 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004631 output, output_length );
4632 }
Janos Follathadbec812019-06-14 11:05:39 +01004633 else
John Durkop07cc04a2020-11-16 22:08:34 -08004634#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4635#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4636 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004637 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004638 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004639 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004640 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004641 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004642 output_length );
4643 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004644 else
John Durkop07cc04a2020-11-16 22:08:34 -08004645#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4646 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004647 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004648 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004649 return( PSA_ERROR_BAD_STATE );
4650 }
4651
4652exit:
4653 if( status != PSA_SUCCESS )
4654 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004655 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004656 * This allows us to differentiate between exhausted operations and
4657 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4658 * operations. */
4659 psa_algorithm_t alg = operation->alg;
4660 psa_key_derivation_abort( operation );
4661 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004662 memset( output, '!', output_length );
4663 }
4664 return( status );
4665}
4666
David Brown7807bf72021-02-09 16:28:23 -07004667#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004668static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4669{
4670 if( data_size >= 8 )
4671 mbedtls_des_key_set_parity( data );
4672 if( data_size >= 16 )
4673 mbedtls_des_key_set_parity( data + 8 );
4674 if( data_size >= 24 )
4675 mbedtls_des_key_set_parity( data + 16 );
4676}
David Brown7807bf72021-02-09 16:28:23 -07004677#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004678
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004679static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004680 psa_key_slot_t *slot,
4681 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004682 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004683{
4684 uint8_t *data = NULL;
4685 size_t bytes = PSA_BITS_TO_BYTES( bits );
4686 psa_status_t status;
4687
Gilles Peskine8e338702019-07-30 20:06:31 +02004688 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004689 return( PSA_ERROR_INVALID_ARGUMENT );
4690 if( bits % 8 != 0 )
4691 return( PSA_ERROR_INVALID_ARGUMENT );
4692 data = mbedtls_calloc( 1, bytes );
4693 if( data == NULL )
4694 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4695
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004696 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004697 if( status != PSA_SUCCESS )
4698 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004699#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004700 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004701 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004702#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004703
4704 status = psa_allocate_buffer_to_slot( slot, bytes );
4705 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004706 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004707
Ronald Cronbf33c932020-11-28 18:06:53 +01004708 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004709 psa_key_attributes_t attributes = {
4710 .core = slot->attr
4711 };
4712
Ronald Cronbf33c932020-11-28 18:06:53 +01004713 status = psa_driver_wrapper_import_key( &attributes,
4714 data, bytes,
4715 slot->key.data,
4716 slot->key.bytes,
4717 &slot->key.bytes, &bits );
4718 if( bits != slot->attr.bits )
4719 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004720
4721exit:
4722 mbedtls_free( data );
4723 return( status );
4724}
4725
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004726psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004727 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004728 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004729{
4730 psa_status_t status;
4731 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004732 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004733
Ronald Cron81709fc2020-11-14 12:10:32 +01004734 *key = MBEDTLS_SVC_KEY_ID_INIT;
4735
Gilles Peskine0f84d622019-09-12 19:03:13 +02004736 /* Reject any attempt to create a zero-length key so that we don't
4737 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4738 if( psa_get_key_bits( attributes ) == 0 )
4739 return( PSA_ERROR_INVALID_ARGUMENT );
4740
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004741 if( ! operation->can_output_key )
4742 return( PSA_ERROR_NOT_PERMITTED );
4743
Ronald Cron81709fc2020-11-14 12:10:32 +01004744 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4745 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004746#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4747 if( driver != NULL )
4748 {
4749 /* Deriving a key in a secure element is not implemented yet. */
4750 status = PSA_ERROR_NOT_SUPPORTED;
4751 }
4752#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004753 if( status == PSA_SUCCESS )
4754 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004755 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004756 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004757 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004758 }
4759 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004760 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004761 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004762 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004763
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004764 return( status );
4765}
4766
Gilles Peskineeab56e42018-07-12 17:12:33 +02004767
4768
4769/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004770/* Key derivation */
4771/****************************************************************/
4772
Steven Cooreman932ffb72021-02-15 12:14:32 +01004773#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004774static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004775 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004776 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004777{
John Durkop07cc04a2020-11-16 22:08:34 -08004778 int is_kdf_alg_supported;
4779
Janos Follath5fe19732019-06-20 15:09:30 +01004780 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4781 * initialisers for this union leave some bytes unspecified.) */
4782 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4783
Gilles Peskine969c5d62019-01-16 15:53:06 +01004784 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004785#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004786 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4787 is_kdf_alg_supported = 1;
4788 else
4789#endif
4790#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4791 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4792 is_kdf_alg_supported = 1;
4793 else
4794#endif
4795#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4796 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4797 is_kdf_alg_supported = 1;
4798 else
4799#endif
4800 is_kdf_alg_supported = 0;
4801
4802 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004803 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004804 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004805 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004806 if( hash_size == 0 )
4807 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004808 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4809 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004810 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004811 {
4812 return( PSA_ERROR_NOT_SUPPORTED );
4813 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004814 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004815 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004816 }
John Durkop07cc04a2020-11-16 22:08:34 -08004817
4818 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004819}
John Durkop07cc04a2020-11-16 22:08:34 -08004820#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004821
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004822psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004823 psa_algorithm_t alg )
4824{
4825 psa_status_t status;
4826
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004827 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004828 return( PSA_ERROR_BAD_STATE );
4829
Gilles Peskine6843c292019-01-18 16:44:49 +01004830 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4831 return( PSA_ERROR_INVALID_ARGUMENT );
4832 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004833 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004834#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004835 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004836 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004837#else
4838 return( PSA_ERROR_NOT_SUPPORTED );
4839#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004840 }
4841 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4842 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004843#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004844 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004845#else
4846 return( PSA_ERROR_NOT_SUPPORTED );
4847#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004848 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004849 else
4850 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004851
4852 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004853 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004854 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004855}
4856
John Durkopd0321952020-10-29 21:37:36 -07004857#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004858static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004859 psa_algorithm_t hash_alg,
4860 psa_key_derivation_step_t step,
4861 const uint8_t *data,
4862 size_t data_length )
4863{
4864 psa_status_t status;
4865 switch( step )
4866 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004867 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004868 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004869 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004870 status = psa_hmac_setup_internal( &hkdf->hmac,
4871 data, data_length,
4872 hash_alg );
4873 if( status != PSA_SUCCESS )
4874 return( status );
4875 hkdf->state = HKDF_STATE_STARTED;
4876 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004877 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004878 /* If no salt was provided, use an empty salt. */
4879 if( hkdf->state == HKDF_STATE_INIT )
4880 {
4881 status = psa_hmac_setup_internal( &hkdf->hmac,
4882 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004883 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004884 if( status != PSA_SUCCESS )
4885 return( status );
4886 hkdf->state = HKDF_STATE_STARTED;
4887 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004888 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004889 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004890 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4891 data, data_length );
4892 if( status != PSA_SUCCESS )
4893 return( status );
4894 status = psa_hmac_finish_internal( &hkdf->hmac,
4895 hkdf->prk,
4896 sizeof( hkdf->prk ) );
4897 if( status != PSA_SUCCESS )
4898 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004899 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004900 hkdf->block_number = 0;
4901 hkdf->state = HKDF_STATE_KEYED;
4902 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004903 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004904 if( hkdf->state == HKDF_STATE_OUTPUT )
4905 return( PSA_ERROR_BAD_STATE );
4906 if( hkdf->info_set )
4907 return( PSA_ERROR_BAD_STATE );
4908 hkdf->info_length = data_length;
4909 if( data_length != 0 )
4910 {
4911 hkdf->info = mbedtls_calloc( 1, data_length );
4912 if( hkdf->info == NULL )
4913 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4914 memcpy( hkdf->info, data, data_length );
4915 }
4916 hkdf->info_set = 1;
4917 return( PSA_SUCCESS );
4918 default:
4919 return( PSA_ERROR_INVALID_ARGUMENT );
4920 }
4921}
John Durkop07cc04a2020-11-16 22:08:34 -08004922#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004923
John Durkop07cc04a2020-11-16 22:08:34 -08004924#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4925 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004926static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4927 const uint8_t *data,
4928 size_t data_length )
4929{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004930 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004931 return( PSA_ERROR_BAD_STATE );
4932
Janos Follathd6dce9f2019-07-04 09:11:38 +01004933 if( data_length != 0 )
4934 {
4935 prf->seed = mbedtls_calloc( 1, data_length );
4936 if( prf->seed == NULL )
4937 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004938
Janos Follathd6dce9f2019-07-04 09:11:38 +01004939 memcpy( prf->seed, data, data_length );
4940 prf->seed_length = data_length;
4941 }
Janos Follathf08e2652019-06-13 09:05:41 +01004942
Gilles Peskine43f958b2020-12-13 14:55:14 +01004943 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004944
4945 return( PSA_SUCCESS );
4946}
4947
Janos Follath81550542019-06-13 14:26:34 +01004948static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4949 psa_algorithm_t hash_alg,
4950 const uint8_t *data,
4951 size_t data_length )
4952{
4953 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004954 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004955 return( PSA_ERROR_BAD_STATE );
4956
4957 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4958 if( status != PSA_SUCCESS )
4959 return( status );
4960
Gilles Peskine43f958b2020-12-13 14:55:14 +01004961 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004962
4963 return( PSA_SUCCESS );
4964}
4965
Janos Follath63028dd2019-06-13 09:15:47 +01004966static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4967 const uint8_t *data,
4968 size_t data_length )
4969{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004970 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004971 return( PSA_ERROR_BAD_STATE );
4972
Janos Follathd6dce9f2019-07-04 09:11:38 +01004973 if( data_length != 0 )
4974 {
4975 prf->label = mbedtls_calloc( 1, data_length );
4976 if( prf->label == NULL )
4977 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004978
Janos Follathd6dce9f2019-07-04 09:11:38 +01004979 memcpy( prf->label, data, data_length );
4980 prf->label_length = data_length;
4981 }
Janos Follath63028dd2019-06-13 09:15:47 +01004982
Gilles Peskine43f958b2020-12-13 14:55:14 +01004983 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004984
4985 return( PSA_SUCCESS );
4986}
4987
Janos Follathb03233e2019-06-11 15:30:30 +01004988static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4989 psa_algorithm_t hash_alg,
4990 psa_key_derivation_step_t step,
4991 const uint8_t *data,
4992 size_t data_length )
4993{
Janos Follathb03233e2019-06-11 15:30:30 +01004994 switch( step )
4995 {
Janos Follathf08e2652019-06-13 09:05:41 +01004996 case PSA_KEY_DERIVATION_INPUT_SEED:
4997 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004998 case PSA_KEY_DERIVATION_INPUT_SECRET:
4999 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005000 case PSA_KEY_DERIVATION_INPUT_LABEL:
5001 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005002 default:
5003 return( PSA_ERROR_INVALID_ARGUMENT );
5004 }
5005}
John Durkop07cc04a2020-11-16 22:08:34 -08005006#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5007 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5008
5009#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5010static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5011 psa_tls12_prf_key_derivation_t *prf,
5012 psa_algorithm_t hash_alg,
5013 const uint8_t *data,
5014 size_t data_length )
5015{
5016 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005017 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005018 uint8_t *cur = pms;
5019
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005020 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005021 return( PSA_ERROR_INVALID_ARGUMENT );
5022
5023 /* Quoting RFC 4279, Section 2:
5024 *
5025 * The premaster secret is formed as follows: if the PSK is N octets
5026 * long, concatenate a uint16 with the value N, N zero octets, a second
5027 * uint16 with the value N, and the PSK itself.
5028 */
5029
5030 *cur++ = ( data_length >> 8 ) & 0xff;
5031 *cur++ = ( data_length >> 0 ) & 0xff;
5032 memset( cur, 0, data_length );
5033 cur += data_length;
5034 *cur++ = pms[0];
5035 *cur++ = pms[1];
5036 memcpy( cur, data, data_length );
5037 cur += data_length;
5038
5039 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5040
5041 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5042 return( status );
5043}
Janos Follath6660f0e2019-06-17 08:44:03 +01005044
5045static psa_status_t psa_tls12_prf_psk_to_ms_input(
5046 psa_tls12_prf_key_derivation_t *prf,
5047 psa_algorithm_t hash_alg,
5048 psa_key_derivation_step_t step,
5049 const uint8_t *data,
5050 size_t data_length )
5051{
5052 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005053 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005054 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5055 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005056 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005057
5058 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5059}
John Durkop07cc04a2020-11-16 22:08:34 -08005060#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005061
Gilles Peskineb8965192019-09-24 16:21:10 +02005062/** Check whether the given key type is acceptable for the given
5063 * input step of a key derivation.
5064 *
5065 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5066 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5067 * Both secret and non-secret inputs can alternatively have the type
5068 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5069 * that the input was passed as a buffer rather than via a key object.
5070 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005071static int psa_key_derivation_check_input_type(
5072 psa_key_derivation_step_t step,
5073 psa_key_type_t key_type )
5074{
5075 switch( step )
5076 {
5077 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005078 if( key_type == PSA_KEY_TYPE_DERIVE )
5079 return( PSA_SUCCESS );
5080 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005081 return( PSA_SUCCESS );
5082 break;
5083 case PSA_KEY_DERIVATION_INPUT_LABEL:
5084 case PSA_KEY_DERIVATION_INPUT_SALT:
5085 case PSA_KEY_DERIVATION_INPUT_INFO:
5086 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005087 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5088 return( PSA_SUCCESS );
5089 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005090 return( PSA_SUCCESS );
5091 break;
5092 }
5093 return( PSA_ERROR_INVALID_ARGUMENT );
5094}
5095
Janos Follathb80a94e2019-06-12 15:54:46 +01005096static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005097 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005098 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005099 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005100 const uint8_t *data,
5101 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005102{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005103 psa_status_t status;
5104 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5105
5106 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005107 if( status != PSA_SUCCESS )
5108 goto exit;
5109
John Durkopd0321952020-10-29 21:37:36 -07005110#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005111 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005112 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005114 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005115 step, data, data_length );
5116 }
John Durkop07cc04a2020-11-16 22:08:34 -08005117 else
5118#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5119#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5120 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005121 {
Janos Follathb03233e2019-06-11 15:30:30 +01005122 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5123 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5124 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005125 }
John Durkop07cc04a2020-11-16 22:08:34 -08005126 else
5127#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5128#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5129 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005130 {
5131 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5132 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5133 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005134 }
5135 else
John Durkop07cc04a2020-11-16 22:08:34 -08005136#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005137 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005138 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005139 (void) data;
5140 (void) data_length;
5141 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005142 return( PSA_ERROR_BAD_STATE );
5143 }
5144
Gilles Peskine224b0d62019-09-23 18:13:17 +02005145exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005146 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005147 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005148 return( status );
5149}
5150
Janos Follath51f4a0f2019-06-14 11:35:55 +01005151psa_status_t psa_key_derivation_input_bytes(
5152 psa_key_derivation_operation_t *operation,
5153 psa_key_derivation_step_t step,
5154 const uint8_t *data,
5155 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005156{
Gilles Peskineb8965192019-09-24 16:21:10 +02005157 return( psa_key_derivation_input_internal( operation, step,
5158 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005159 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005160}
5161
Janos Follath51f4a0f2019-06-14 11:35:55 +01005162psa_status_t psa_key_derivation_input_key(
5163 psa_key_derivation_operation_t *operation,
5164 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005165 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005166{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005167 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005168 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005169 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005170
Ronald Cron5c522922020-11-14 16:35:34 +01005171 status = psa_get_and_lock_transparent_key_slot_with_policy(
5172 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005173 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005174 {
5175 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005176 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005177 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005178
5179 /* Passing a key object as a SECRET input unlocks the permission
5180 * to output to a key object. */
5181 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5182 operation->can_output_key = 1;
5183
Ronald Cronf95a2b12020-10-22 15:24:49 +02005184 status = psa_key_derivation_input_internal( operation,
5185 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005186 slot->key.data,
5187 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005188
Ronald Cron5c522922020-11-14 16:35:34 +01005189 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005190
Ronald Cron5c522922020-11-14 16:35:34 +01005191 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005192}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005193
5194
5195
5196/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005197/* Key agreement */
5198/****************************************************************/
5199
John Durkop6ba40d12020-11-10 08:50:04 -08005200#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005201static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5202 size_t peer_key_length,
5203 const mbedtls_ecp_keypair *our_key,
5204 uint8_t *shared_secret,
5205 size_t shared_secret_size,
5206 size_t *shared_secret_length )
5207{
Steven Cooremand4867872020-08-05 16:31:39 +02005208 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005209 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005210 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005211 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005212 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005213 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005214
Ronald Cron90857082020-11-25 14:58:33 +01005215 status = mbedtls_psa_ecp_load_representation(
5216 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005217 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005218 peer_key,
5219 peer_key_length,
5220 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005221 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005222 goto exit;
5223
Jaeden Amero97271b32019-01-10 19:38:51 +00005224 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005225 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005226 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005227 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005228 status = mbedtls_to_psa_error(
5229 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5230 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005231 goto exit;
5232
Jaeden Amero97271b32019-01-10 19:38:51 +00005233 status = mbedtls_to_psa_error(
5234 mbedtls_ecdh_calc_secret( &ecdh,
5235 shared_secret_length,
5236 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005237 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005238 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005239 if( status != PSA_SUCCESS )
5240 goto exit;
5241 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5242 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005243
5244exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005245 if( status != PSA_SUCCESS )
5246 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005247 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005248 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005249 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005250
Jaeden Amero97271b32019-01-10 19:38:51 +00005251 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005252}
John Durkop6ba40d12020-11-10 08:50:04 -08005253#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005254
Gilles Peskine01d718c2018-09-18 12:01:02 +02005255#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5256
Gilles Peskine0216fe12019-04-11 21:23:21 +02005257static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5258 psa_key_slot_t *private_key,
5259 const uint8_t *peer_key,
5260 size_t peer_key_length,
5261 uint8_t *shared_secret,
5262 size_t shared_secret_size,
5263 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005264{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005265 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005266 {
John Durkop6ba40d12020-11-10 08:50:04 -08005267#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005268 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005269 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005270 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005271 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005272 psa_status_t status = mbedtls_psa_ecp_load_representation(
5273 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005274 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005275 private_key->key.data,
5276 private_key->key.bytes,
5277 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005278 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005279 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005280 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005281 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005282 shared_secret, shared_secret_size,
5283 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005284 mbedtls_ecp_keypair_free( ecp );
5285 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005286 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005287#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005288 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005289 (void) private_key;
5290 (void) peer_key;
5291 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005292 (void) shared_secret;
5293 (void) shared_secret_size;
5294 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005295 return( PSA_ERROR_NOT_SUPPORTED );
5296 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005297}
5298
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005299/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005300 * to potentially free embedded data structures and wipe confidential data.
5301 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005302static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005303 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005304 psa_key_slot_t *private_key,
5305 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005306 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005307{
5308 psa_status_t status;
5309 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5310 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005311 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005312
5313 /* Step 1: run the secret agreement algorithm to generate the shared
5314 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005315 status = psa_key_agreement_raw_internal( ka_alg,
5316 private_key,
5317 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005318 shared_secret,
5319 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005320 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005321 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005322 goto exit;
5323
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005324 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005325 * the shared secret. A shared secret is permitted wherever a key
5326 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005327 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005328 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005329 shared_secret,
5330 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005331exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005332 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005333 return( status );
5334}
5335
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005336psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005337 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005338 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005339 const uint8_t *peer_key,
5340 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005341{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005342 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005343 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005344 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005345
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005346 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005347 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005348 status = psa_get_and_lock_transparent_key_slot_with_policy(
5349 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005350 if( status != PSA_SUCCESS )
5351 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005352 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005353 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005354 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005355 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005356 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005357 else
5358 {
5359 /* If a private key has been added as SECRET, we allow the derived
5360 * key material to be used as a key in PSA Crypto. */
5361 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5362 operation->can_output_key = 1;
5363 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005364
Ronald Cron5c522922020-11-14 16:35:34 +01005365 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005366
Ronald Cron5c522922020-11-14 16:35:34 +01005367 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005368}
5369
Gilles Peskinebe697d82019-05-16 18:00:41 +02005370psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005371 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005372 const uint8_t *peer_key,
5373 size_t peer_key_length,
5374 uint8_t *output,
5375 size_t output_size,
5376 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005377{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005379 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005380 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005381
5382 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5383 {
5384 status = PSA_ERROR_INVALID_ARGUMENT;
5385 goto exit;
5386 }
Ronald Cron5c522922020-11-14 16:35:34 +01005387 status = psa_get_and_lock_transparent_key_slot_with_policy(
5388 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005389 if( status != PSA_SUCCESS )
5390 goto exit;
5391
5392 status = psa_key_agreement_raw_internal( alg, slot,
5393 peer_key, peer_key_length,
5394 output, output_size,
5395 output_length );
5396
5397exit:
5398 if( status != PSA_SUCCESS )
5399 {
5400 /* If an error happens and is not handled properly, the output
5401 * may be used as a key to protect sensitive data. Arrange for such
5402 * a key to be random, which is likely to result in decryption or
5403 * verification errors. This is better than filling the buffer with
5404 * some constant data such as zeros, which would result in the data
5405 * being protected with a reproducible, easily knowable key.
5406 */
5407 psa_generate_random( output, output_size );
5408 *output_length = output_size;
5409 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005410
Ronald Cron5c522922020-11-14 16:35:34 +01005411 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005412
Ronald Cron5c522922020-11-14 16:35:34 +01005413 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005414}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005415
5416
Gilles Peskine30524eb2020-11-13 17:02:26 +01005417
Gilles Peskine86a440b2018-11-12 18:39:40 +01005418/****************************************************************/
5419/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005420/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005421
Gilles Peskine30524eb2020-11-13 17:02:26 +01005422/** Initialize the PSA random generator.
5423 */
5424static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5425{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005426#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5427 memset( rng, 0, sizeof( *rng ) );
5428#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5429
Gilles Peskine30524eb2020-11-13 17:02:26 +01005430 /* Set default configuration if
5431 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5432 if( rng->entropy_init == NULL )
5433 rng->entropy_init = mbedtls_entropy_init;
5434 if( rng->entropy_free == NULL )
5435 rng->entropy_free = mbedtls_entropy_free;
5436
5437 rng->entropy_init( &rng->entropy );
5438#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5439 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5440 /* The PSA entropy injection feature depends on using NV seed as an entropy
5441 * source. Add NV seed as an entropy source for PSA entropy injection. */
5442 mbedtls_entropy_add_source( &rng->entropy,
5443 mbedtls_nv_seed_poll, NULL,
5444 MBEDTLS_ENTROPY_BLOCK_SIZE,
5445 MBEDTLS_ENTROPY_SOURCE_STRONG );
5446#endif
5447
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005448 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005449#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005450}
5451
5452/** Deinitialize the PSA random generator.
5453 */
5454static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5455{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005456#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5457 memset( rng, 0, sizeof( *rng ) );
5458#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005459 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005460 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005461#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005462}
5463
5464/** Seed the PSA random generator.
5465 */
5466static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5467{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005468#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5469 /* Do nothing: the external RNG seeds itself. */
5470 (void) rng;
5471 return( PSA_SUCCESS );
5472#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005473 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005474 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5475 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005476 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005477#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005478}
5479
Gilles Peskinee59236f2018-01-27 23:32:46 +01005480psa_status_t psa_generate_random( uint8_t *output,
5481 size_t output_size )
5482{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005483 GUARD_MODULE_INITIALIZED;
5484
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005485#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5486
5487 size_t output_length = 0;
5488 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5489 output, output_size,
5490 &output_length );
5491 if( status != PSA_SUCCESS )
5492 return( status );
5493 /* Breaking up a request into smaller chunks is currently not supported
5494 * for the extrernal RNG interface. */
5495 if( output_length != output_size )
5496 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5497 return( PSA_SUCCESS );
5498
5499#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5500
Gilles Peskine71ddab92021-01-04 21:01:07 +01005501 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005502 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005503 size_t request_size =
5504 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5505 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5506 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005507 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5508 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005509 if( ret != 0 )
5510 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005511 output_size -= request_size;
5512 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005513 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005514 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005515#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005516}
5517
Gilles Peskine8814fc42020-12-14 15:33:44 +01005518/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005519 *
5520 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5521 * `psa_generate_random(...)`. The state parameter is ignored since the
5522 * PSA API doesn't support passing an explicit state.
5523 *
5524 * In the non-external case, psa_generate_random() calls an
5525 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5526 * and semantics as mbedtls_psa_get_random(). As an optimization,
5527 * instead of doing this back-and-forth between the PSA API and the
5528 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5529 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005530 */
5531#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5532int mbedtls_psa_get_random( void *p_rng,
5533 unsigned char *output,
5534 size_t output_size )
5535{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005536 /* This function takes a pointer to the RNG state because that's what
5537 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5538 * its own state internally and doesn't let the caller access that state.
5539 * So we just ignore the state parameter, and in practice we'll pass
5540 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005541 (void) p_rng;
5542 psa_status_t status = psa_generate_random( output, output_size );
5543 if( status == PSA_SUCCESS )
5544 return( 0 );
5545 else
5546 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5547}
5548#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5549
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005550#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5551#include "mbedtls/entropy_poll.h"
5552
Gilles Peskine7228da22019-07-15 11:06:15 +02005553psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005554 size_t seed_size )
5555{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005556 if( global_data.initialized )
5557 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005558
5559 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5560 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5561 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5562 return( PSA_ERROR_INVALID_ARGUMENT );
5563
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005564 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005565}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005566#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005567
Ronald Cron3772afe2021-02-08 16:10:05 +01005568/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005569 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005570 * \param type The key type
5571 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005572 *
5573 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005574 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005575 * \retval #PSA_ERROR_INVALID_ARGUMENT
5576 * The size in bits of the key is not valid.
5577 * \retval #PSA_ERROR_NOT_SUPPORTED
5578 * The type and/or the size in bits of the key or the combination of
5579 * the two is not supported.
5580 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005581static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5582 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005583{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005585
Gilles Peskinee59236f2018-01-27 23:32:46 +01005586 if( key_type_is_raw_bytes( type ) )
5587 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005588 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005589 if( status != PSA_SUCCESS )
5590 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005591 }
5592 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005593#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005594 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5595 {
5596 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5597 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005598
Ronald Cron01b2aba2020-10-05 09:42:02 +02005599 /* Accept only byte-aligned keys, for the same reasons as
5600 * in psa_import_rsa_key(). */
5601 if( bits % 8 != 0 )
5602 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005603 }
5604 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005605#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005606
Ronald Cron5c4d3862020-12-07 11:07:24 +01005607#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005608 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5609 {
Ronald Crond81ab562021-02-16 09:01:16 +01005610 /* To avoid empty block, return successfully here. */
5611 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005612 }
5613 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005614#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005615 {
5616 return( PSA_ERROR_NOT_SUPPORTED );
5617 }
5618
5619 return( PSA_SUCCESS );
5620}
5621
Ronald Cron55ed0592020-10-05 10:30:40 +02005622psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005623 const psa_key_attributes_t *attributes,
5624 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005625{
5626 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005627 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005628
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005629 if( ( attributes->domain_parameters == NULL ) &&
5630 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005631 return( PSA_ERROR_INVALID_ARGUMENT );
5632
Ronald Cron01b2aba2020-10-05 09:42:02 +02005633 if( key_type_is_raw_bytes( type ) )
5634 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005635 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005636 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005637 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005638
David Brown12ca5032021-02-11 11:02:00 -07005639#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005640 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005641 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005642#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005643 }
5644 else
5645
John Durkop07cc04a2020-11-16 22:08:34 -08005646#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005647 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005648 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005649 return( mbedtls_psa_rsa_generate_key( attributes,
5650 key_buffer,
5651 key_buffer_size,
5652 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005653 }
5654 else
John Durkop07cc04a2020-11-16 22:08:34 -08005655#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005656
John Durkop9814fa22020-11-04 12:28:15 -08005657#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005658 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005659 {
Ronald Cron7023db52020-11-20 18:17:42 +01005660 return( mbedtls_psa_ecp_generate_key( attributes,
5661 key_buffer,
5662 key_buffer_size,
5663 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005664 }
5665 else
John Durkop9814fa22020-11-04 12:28:15 -08005666#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005667 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005668 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005669 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005670 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005671
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005672 return( PSA_SUCCESS );
5673}
Darryl Green0c6575a2018-11-07 16:05:30 +00005674
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005675psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005676 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005677{
5678 psa_status_t status;
5679 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005680 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005681 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005682
Ronald Cron81709fc2020-11-14 12:10:32 +01005683 *key = MBEDTLS_SVC_KEY_ID_INIT;
5684
Gilles Peskine0f84d622019-09-12 19:03:13 +02005685 /* Reject any attempt to create a zero-length key so that we don't
5686 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5687 if( psa_get_key_bits( attributes ) == 0 )
5688 return( PSA_ERROR_INVALID_ARGUMENT );
5689
Ronald Cron81709fc2020-11-14 12:10:32 +01005690 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5691 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005692 if( status != PSA_SUCCESS )
5693 goto exit;
5694
Ronald Cron977c2472020-10-13 08:32:21 +02005695 /* In the case of a transparent key or an opaque key stored in local
5696 * storage (thus not in the case of generating a key in a secure element
5697 * or cryptoprocessor with storage), we have to allocate a buffer to
5698 * hold the generated key material. */
5699 if( slot->key.data == NULL )
5700 {
5701 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5702 PSA_KEY_LOCATION_LOCAL_STORAGE )
5703 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005704 status = psa_validate_key_type_and_size_for_key_generation(
5705 attributes->core.type, attributes->core.bits );
5706 if( status != PSA_SUCCESS )
5707 goto exit;
5708
5709 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5710 attributes->core.type,
5711 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005712 }
5713 else
5714 {
5715 status = psa_driver_wrapper_get_key_buffer_size(
5716 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005717 if( status != PSA_SUCCESS )
5718 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005719 }
Ronald Cron977c2472020-10-13 08:32:21 +02005720
5721 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5722 if( status != PSA_SUCCESS )
5723 goto exit;
5724 }
5725
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005726 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005727 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005728
Ronald Cron2b56bc82020-10-05 10:02:26 +02005729 if( status != PSA_SUCCESS )
5730 psa_remove_key_data_from_memory( slot );
5731
Gilles Peskine11792082019-08-06 18:36:36 +02005732exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005733 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005734 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005735 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005736 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005737
Darryl Green0c6575a2018-11-07 16:05:30 +00005738 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005739}
5740
Gilles Peskinee59236f2018-01-27 23:32:46 +01005741/****************************************************************/
5742/* Module setup */
5743/****************************************************************/
5744
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005745#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005746psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5747 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5748 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5749{
5750 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5751 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005752 global_data.rng.entropy_init = entropy_init;
5753 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005754 return( PSA_SUCCESS );
5755}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005756#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005757
Gilles Peskinee59236f2018-01-27 23:32:46 +01005758void mbedtls_psa_crypto_free( void )
5759{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005760 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005761 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5762 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005763 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005764 }
5765 /* Wipe all remaining data, including configuration.
5766 * In particular, this sets all state indicator to the value
5767 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005768 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005769#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005770 /* Unregister all secure element drivers, so that we restart from
5771 * a pristine state. */
5772 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005773#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005774}
5775
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005776#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5777/** Recover a transaction that was interrupted by a power failure.
5778 *
5779 * This function is called during initialization, before psa_crypto_init()
5780 * returns. If this function returns a failure status, the initialization
5781 * fails.
5782 */
5783static psa_status_t psa_crypto_recover_transaction(
5784 const psa_crypto_transaction_t *transaction )
5785{
5786 switch( transaction->unknown.type )
5787 {
5788 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5789 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005790 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005791 * is implemented.
5792 * https://github.com/ARMmbed/mbed-crypto/issues/218
5793 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005794 default:
5795 /* We found an unsupported transaction in the storage.
5796 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005797 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005798 }
5799}
5800#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5801
Gilles Peskinee59236f2018-01-27 23:32:46 +01005802psa_status_t psa_crypto_init( void )
5803{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005804 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005805
Gilles Peskinec6b69072018-11-20 21:42:52 +01005806 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005807 if( global_data.initialized != 0 )
5808 return( PSA_SUCCESS );
5809
Gilles Peskine30524eb2020-11-13 17:02:26 +01005810 /* Initialize and seed the random generator. */
5811 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005812 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005813 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005814 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005815 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005816 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005817
Gilles Peskine66fb1262018-12-10 16:29:04 +01005818 status = psa_initialize_key_slots( );
5819 if( status != PSA_SUCCESS )
5820 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005821
Gilles Peskined9348f22019-10-01 15:22:29 +02005822#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5823 status = psa_init_all_se_drivers( );
5824 if( status != PSA_SUCCESS )
5825 goto exit;
5826#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5827
Gilles Peskine4b734222019-07-24 15:56:31 +02005828#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005829 status = psa_crypto_load_transaction( );
5830 if( status == PSA_SUCCESS )
5831 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005832 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5833 if( status != PSA_SUCCESS )
5834 goto exit;
5835 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005836 }
5837 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5838 {
5839 /* There's no transaction to complete. It's all good. */
5840 status = PSA_SUCCESS;
5841 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005842#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005843
Gilles Peskinec6b69072018-11-20 21:42:52 +01005844 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005845 global_data.initialized = 1;
5846
5847exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005848 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005849 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005850 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005851}
5852
5853#endif /* MBEDTLS_PSA_CRYPTO_C */