blob: 8c61cb9683e746718b861a9fc18cb47ad385a941 [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"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010037#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010038#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020039#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020040#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010042#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010043/* Include internal declarations that are useful for implementing persistently
44 * stored keys. */
45#include "psa_crypto_storage.h"
46
Gilles Peskineb2b64d32020-12-14 16:43:58 +010047#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010048
Gilles Peskineb46bef22019-07-30 21:32:04 +020049#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010050#include <stdlib.h>
51#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020053#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#define mbedtls_calloc calloc
55#define mbedtls_free free
56#endif
57
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010058#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010059#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/blowfish.h"
64#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020065#include "mbedtls/chacha20.h"
66#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/cipher.h"
68#include "mbedtls/ccm.h"
69#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020071#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010073#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074#include "mbedtls/error.h"
75#include "mbedtls/gcm.h"
76#include "mbedtls/md2.h"
77#include "mbedtls/md4.h"
78#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010079#include "mbedtls/md.h"
80#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010082#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010083#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000084#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010086#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087#include "mbedtls/sha1.h"
88#include "mbedtls/sha256.h"
89#include "mbedtls/sha512.h"
90#include "mbedtls/xtea.h"
91
Gilles Peskine996deb12018-08-01 15:45:45 +020092#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
93
Gilles Peskine9ef733f2018-02-07 21:05:37 +010094/* constant-time buffer comparison */
95static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
96{
97 size_t i;
98 unsigned char diff = 0;
99
100 for( i = 0; i < n; i++ )
101 diff |= a[i] ^ b[i];
102
103 return( diff );
104}
105
106
107
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100108/****************************************************************/
109/* Global data, support functions and library management */
110/****************************************************************/
111
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200112static int key_type_is_raw_bytes( psa_key_type_t type )
113{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200114 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200115}
116
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100117/* Values for psa_global_data_t::rng_state */
118#define RNG_NOT_INITIALIZED 0
119#define RNG_INITIALIZED 1
120#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100121
Gilles Peskine2d277862018-06-18 15:41:12 +0200122typedef struct
123{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100124 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100125 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100126 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100127} psa_global_data_t;
128
129static psa_global_data_t global_data;
130
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100131#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
132mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
133 &global_data.rng.drbg;
134#endif
135
itayzafrir0adf0fc2018-09-06 16:24:41 +0300136#define GUARD_MODULE_INITIALIZED \
137 if( global_data.initialized == 0 ) \
138 return( PSA_ERROR_BAD_STATE );
139
Steven Cooreman01164162020-07-20 15:31:37 +0200140psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100141{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100142 /* Mbed TLS error codes can combine a high-level error code and a
143 * low-level error code. The low-level error usually reflects the
144 * root cause better, so dispatch on that preferably. */
145 int low_level_ret = - ( -ret & 0x007f );
146 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100147 {
148 case 0:
149 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100150
151 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
152 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
153 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
154 return( PSA_ERROR_NOT_SUPPORTED );
155 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
156 return( PSA_ERROR_HARDWARE_FAILURE );
157
158 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
159 return( PSA_ERROR_HARDWARE_FAILURE );
160
Gilles Peskine9a944802018-06-21 09:35:35 +0200161 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
162 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
163 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
164 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
165 case MBEDTLS_ERR_ASN1_INVALID_DATA:
166 return( PSA_ERROR_INVALID_ARGUMENT );
167 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
168 return( PSA_ERROR_INSUFFICIENT_MEMORY );
169 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
170 return( PSA_ERROR_BUFFER_TOO_SMALL );
171
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000173 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000174#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
175 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
176#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
178 return( PSA_ERROR_NOT_SUPPORTED );
179 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
180 return( PSA_ERROR_HARDWARE_FAILURE );
181
Jaeden Amero93e21112019-02-20 13:57:28 +0000182#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000183 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000184#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
185 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
186#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100187 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
188 return( PSA_ERROR_NOT_SUPPORTED );
189 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
190 return( PSA_ERROR_HARDWARE_FAILURE );
191
192 case MBEDTLS_ERR_CCM_BAD_INPUT:
193 return( PSA_ERROR_INVALID_ARGUMENT );
194 case MBEDTLS_ERR_CCM_AUTH_FAILED:
195 return( PSA_ERROR_INVALID_SIGNATURE );
196 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
197 return( PSA_ERROR_HARDWARE_FAILURE );
198
Gilles Peskine26869f22019-05-06 15:25:00 +0200199 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
200 return( PSA_ERROR_INVALID_ARGUMENT );
201
202 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
203 return( PSA_ERROR_BAD_STATE );
204 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
205 return( PSA_ERROR_INVALID_SIGNATURE );
206
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
208 return( PSA_ERROR_NOT_SUPPORTED );
209 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
210 return( PSA_ERROR_INVALID_ARGUMENT );
211 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_MEMORY );
213 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
214 return( PSA_ERROR_INVALID_PADDING );
215 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200216 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100217 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
218 return( PSA_ERROR_INVALID_SIGNATURE );
219 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200220 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100221 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
222 return( PSA_ERROR_HARDWARE_FAILURE );
223
224 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
225 return( PSA_ERROR_HARDWARE_FAILURE );
226
Gilles Peskine82e57d12020-11-13 21:31:17 +0100227#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
228 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100229 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
230 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100231 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
232 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
233 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
234 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
235 return( PSA_ERROR_NOT_SUPPORTED );
236 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
237 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100238#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100239
240 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
241 return( PSA_ERROR_NOT_SUPPORTED );
242 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
243 return( PSA_ERROR_HARDWARE_FAILURE );
244
Gilles Peskinee59236f2018-01-27 23:32:46 +0100245 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
246 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
247 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100249
250 case MBEDTLS_ERR_GCM_AUTH_FAILED:
251 return( PSA_ERROR_INVALID_SIGNATURE );
252 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200253 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100254 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
255 return( PSA_ERROR_HARDWARE_FAILURE );
256
Gilles Peskine82e57d12020-11-13 21:31:17 +0100257#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
258 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100259 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
260 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100261 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
262 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
263 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
264 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
265 return( PSA_ERROR_NOT_SUPPORTED );
266 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
267 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
268#endif
269
Gilles Peskinea5905292018-02-07 20:59:33 +0100270 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
271 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
272 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
273 return( PSA_ERROR_HARDWARE_FAILURE );
274
275 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
276 return( PSA_ERROR_NOT_SUPPORTED );
277 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_MD_ALLOC_FAILED:
280 return( PSA_ERROR_INSUFFICIENT_MEMORY );
281 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
282 return( PSA_ERROR_STORAGE_FAILURE );
283 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
284 return( PSA_ERROR_HARDWARE_FAILURE );
285
Gilles Peskinef76aa772018-10-29 19:24:33 +0100286 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
287 return( PSA_ERROR_STORAGE_FAILURE );
288 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
289 return( PSA_ERROR_INVALID_ARGUMENT );
290 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
291 return( PSA_ERROR_INVALID_ARGUMENT );
292 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
293 return( PSA_ERROR_BUFFER_TOO_SMALL );
294 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
295 return( PSA_ERROR_INVALID_ARGUMENT );
296 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
297 return( PSA_ERROR_INVALID_ARGUMENT );
298 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
299 return( PSA_ERROR_INVALID_ARGUMENT );
300 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
301 return( PSA_ERROR_INSUFFICIENT_MEMORY );
302
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100303 case MBEDTLS_ERR_PK_ALLOC_FAILED:
304 return( PSA_ERROR_INSUFFICIENT_MEMORY );
305 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
306 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
307 return( PSA_ERROR_INVALID_ARGUMENT );
308 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100309 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100310 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
311 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
312 return( PSA_ERROR_INVALID_ARGUMENT );
313 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
314 return( PSA_ERROR_NOT_SUPPORTED );
315 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
316 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
317 return( PSA_ERROR_NOT_PERMITTED );
318 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
319 return( PSA_ERROR_INVALID_ARGUMENT );
320 case MBEDTLS_ERR_PK_INVALID_ALG:
321 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
322 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
323 return( PSA_ERROR_NOT_SUPPORTED );
324 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
325 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100326 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
327 return( PSA_ERROR_HARDWARE_FAILURE );
328
Gilles Peskineff2d2002019-05-06 15:26:23 +0200329 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
332 return( PSA_ERROR_NOT_SUPPORTED );
333
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
335 return( PSA_ERROR_HARDWARE_FAILURE );
336
337 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
338 return( PSA_ERROR_INVALID_ARGUMENT );
339 case MBEDTLS_ERR_RSA_INVALID_PADDING:
340 return( PSA_ERROR_INVALID_PADDING );
341 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
342 return( PSA_ERROR_HARDWARE_FAILURE );
343 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
344 return( PSA_ERROR_INVALID_ARGUMENT );
345 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
346 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200347 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100348 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
349 return( PSA_ERROR_INVALID_SIGNATURE );
350 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
351 return( PSA_ERROR_BUFFER_TOO_SMALL );
352 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100353 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
355 return( PSA_ERROR_NOT_SUPPORTED );
356 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
357 return( PSA_ERROR_HARDWARE_FAILURE );
358
359 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
360 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
361 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
362 return( PSA_ERROR_HARDWARE_FAILURE );
363
364 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
365 return( PSA_ERROR_INVALID_ARGUMENT );
366 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
367 return( PSA_ERROR_HARDWARE_FAILURE );
368
itayzafrir5c753392018-05-08 11:18:38 +0300369 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300370 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300371 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300372 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
373 return( PSA_ERROR_BUFFER_TOO_SMALL );
374 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
375 return( PSA_ERROR_NOT_SUPPORTED );
376 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
377 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
378 return( PSA_ERROR_INVALID_SIGNATURE );
379 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
380 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100381 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
382 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300383 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
384 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100385
Janos Follatha13b9052019-11-22 12:48:59 +0000386 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
387 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300388
Gilles Peskinee59236f2018-01-27 23:32:46 +0100389 default:
David Saadab4ecc272019-02-14 13:48:10 +0200390 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100391 }
392}
393
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200394
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200395
396
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100397/****************************************************************/
398/* Key management */
399/****************************************************************/
400
Gilles Peskine73167e12019-07-12 23:44:37 +0200401#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
402static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
403{
Gilles Peskine8e338702019-07-30 20:06:31 +0200404 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200405}
406#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
407
John Durkop07cc04a2020-11-16 22:08:34 -0800408/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
409 * current test driver in key_management.c is using this function
410 * when accelerators are used for ECC key pair and public key.
411 * Once that dependency is resolved these guards can be removed.
412 */
John Durkop9814fa22020-11-04 12:28:15 -0800413#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800414 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
415 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
416 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100417mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 size_t bits,
419 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200420{
421 switch( curve )
422 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100423 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100425 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100427 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100428 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100429 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100430 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100431 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100432 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100433 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100435 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100436 case 528:
437 if( bits_is_sloppy )
438 return( MBEDTLS_ECP_DP_SECP521R1 );
439 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100440 }
441 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100442
Paul Elliott8ff510a2020-06-02 17:19:28 +0100443 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100445 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100446 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100447 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100448 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100449 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100450 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100451 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100452 }
453 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100454
Paul Elliott8ff510a2020-06-02 17:19:28 +0100455 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100456 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100457 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100458 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100459 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100460 case 256:
461 if( bits_is_sloppy )
462 return( MBEDTLS_ECP_DP_CURVE25519 );
463 break;
464 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100465 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100466 }
467 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100468
Paul Elliott8ff510a2020-06-02 17:19:28 +0100469 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100470 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100471 {
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100472 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100473 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100474 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100475 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100476 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100477 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskine228abc52019-12-03 17:24:19 +0100478 }
479 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200480 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100481
482 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200483}
John Durkop9814fa22020-11-04 12:28:15 -0800484#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800485 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
486 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
487 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200488
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200489static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
490 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491{
492 /* Check that the bit size is acceptable for the key type */
493 switch( type )
494 {
495 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200496 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200497 case PSA_KEY_TYPE_DERIVE:
498 break;
David Browne04acc22021-01-26 11:39:16 -0700499#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200500 case PSA_KEY_TYPE_AES:
501 if( bits != 128 && bits != 192 && bits != 256 )
502 return( PSA_ERROR_INVALID_ARGUMENT );
503 break;
504#endif
David Browne04acc22021-01-26 11:39:16 -0700505#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200506 case PSA_KEY_TYPE_CAMELLIA:
507 if( bits != 128 && bits != 192 && bits != 256 )
508 return( PSA_ERROR_INVALID_ARGUMENT );
509 break;
510#endif
David Browne04acc22021-01-26 11:39:16 -0700511#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200512 case PSA_KEY_TYPE_DES:
513 if( bits != 64 && bits != 128 && bits != 192 )
514 return( PSA_ERROR_INVALID_ARGUMENT );
515 break;
516#endif
David Browne04acc22021-01-26 11:39:16 -0700517#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200518 case PSA_KEY_TYPE_ARC4:
519 if( bits < 8 || bits > 2048 )
520 return( PSA_ERROR_INVALID_ARGUMENT );
521 break;
522#endif
David Brown1bfe4d72021-02-16 12:54:35 -0700523#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200524 case PSA_KEY_TYPE_CHACHA20:
525 if( bits != 256 )
526 return( PSA_ERROR_INVALID_ARGUMENT );
527 break;
528#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200529 default:
530 return( PSA_ERROR_NOT_SUPPORTED );
531 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200532 if( bits % 8 != 0 )
533 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200534
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200535 return( PSA_SUCCESS );
536}
537
Gilles Peskineb46bef22019-07-30 21:32:04 +0200538/** Return the size of the key in the given slot, in bits.
539 *
540 * \param[in] slot A key slot.
541 *
542 * \return The key size in bits, read from the metadata in the slot.
543 */
544static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
545{
546 return( slot->attr.bits );
547}
548
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100549/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100550 *
Steven Cooremancd640932021-03-08 12:00:27 +0100551 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
552 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100553 *
554 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100555 * \param[in] key_type The key type of the key to be used with the
556 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100557 *
558 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100559 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100560 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100561 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100562 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100563MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100564 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100565 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100566{
Steven Cooremancd640932021-03-08 12:00:27 +0100567 if( PSA_ALG_IS_HMAC( algorithm ) )
568 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100569 if( key_type == PSA_KEY_TYPE_HMAC )
570 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100571 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100572
573 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100574 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100575 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
576 * key. */
577 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
578 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
579 {
580 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
581 * the block length (larger than 1) for block ciphers. */
582 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
583 return( PSA_SUCCESS );
584 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100585 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100586
587 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100588}
589
Steven Cooreman75b74362020-07-28 14:30:13 +0200590/** Try to allocate a buffer to an empty key slot.
591 *
592 * \param[in,out] slot Key slot to attach buffer to.
593 * \param[in] buffer_length Requested size of the buffer.
594 *
595 * \retval #PSA_SUCCESS
596 * The buffer has been successfully allocated.
597 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
598 * Not enough memory was available for allocation.
599 * \retval #PSA_ERROR_ALREADY_EXISTS
600 * Trying to allocate a buffer to a non-empty key slot.
601 */
602static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
603 size_t buffer_length )
604{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100605 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200606 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200607
Ronald Cronea0f8a62020-11-25 17:52:23 +0100608 slot->key.data = mbedtls_calloc( 1, buffer_length );
609 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200610 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200611
Ronald Cronea0f8a62020-11-25 17:52:23 +0100612 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200613 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200614}
615
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200616psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
617 const uint8_t* data,
618 size_t data_length )
619{
620 psa_status_t status = psa_allocate_buffer_to_slot( slot,
621 data_length );
622 if( status != PSA_SUCCESS )
623 return( status );
624
Ronald Cronea0f8a62020-11-25 17:52:23 +0100625 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200626 return( PSA_SUCCESS );
627}
628
Ronald Crona0fe59f2020-11-29 11:14:53 +0100629psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100630 const psa_key_attributes_t *attributes,
631 const uint8_t *data, size_t data_length,
632 uint8_t *key_buffer, size_t key_buffer_size,
633 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100634{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
636 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100637
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200638 /* zero-length keys are never supported. */
639 if( data_length == 0 )
640 return( PSA_ERROR_NOT_SUPPORTED );
641
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100642 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100643 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100644 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200645
Steven Cooreman75b74362020-07-28 14:30:13 +0200646 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
647 if( data_length > SIZE_MAX / 8 )
648 return( PSA_ERROR_NOT_SUPPORTED );
649
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200650 /* Enforce a size limit, and in particular ensure that the bit
651 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100652 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200653 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200654
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100655 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200656 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200657 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200658
Ronald Crondd04d422020-11-28 15:14:42 +0100659 /* Copy the key material. */
660 memcpy( key_buffer, data, data_length );
661 *key_buffer_length = data_length;
662 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200663
Steven Cooreman40120f62020-10-29 11:42:22 +0100664 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100665 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100666 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200667 {
John Durkop9814fa22020-11-04 12:28:15 -0800668#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
669 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100670 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200671 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100672 return( mbedtls_psa_ecp_import_key( attributes,
673 data, data_length,
674 key_buffer, key_buffer_size,
675 key_buffer_length,
676 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100677 }
John Durkop9814fa22020-11-04 12:28:15 -0800678#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
679 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700680#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
681 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100682 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200683 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100684 return( mbedtls_psa_rsa_import_key( attributes,
685 data, data_length,
686 key_buffer, key_buffer_size,
687 key_buffer_length,
688 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200689 }
John Durkop9814fa22020-11-04 12:28:15 -0800690#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
691 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100692 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100693
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100694 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100695}
696
Gilles Peskinef603c712019-01-19 13:40:11 +0100697/** Calculate the intersection of two algorithm usage policies.
698 *
699 * Return 0 (which allows no operation) on incompatibility.
700 */
701static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100702 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100703 psa_algorithm_t alg1,
704 psa_algorithm_t alg2 )
705{
Gilles Peskine549ea862019-05-22 11:45:59 +0200706 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100707 if( alg1 == alg2 )
708 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100709 /* If the policies are from the same hash-and-sign family, check
710 * if one is a wildcard. If so the other has the specific algorithm. */
711 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
712 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
713 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100714 {
Steven Cooreman03488022021-02-18 12:07:20 +0100715 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
716 return( alg2 );
717 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
718 return( alg1 );
719 }
720 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100721 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100722 * restrictive tag length. */
723 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
724 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
725 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
726 {
727 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
728 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100729 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100730
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100731 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100732 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
733 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100734 {
Steven Cooremancd640932021-03-08 12:00:27 +0100735 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
736 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100737 }
738 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100739 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100740 ( alg1_len <= alg2_len ) )
741 {
742 return( alg2 );
743 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100744 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100745 ( alg2_len <= alg1_len ) )
746 {
747 return( alg1 );
748 }
749 }
750 /* If the policies are from the same MAC family, check whether one
751 * of them is a minimum-MAC-length policy. Calculate the most
752 * restrictive tag length. */
753 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
754 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
755 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
756 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100757 /* Validate the combination of key type and algorithm. Since the base
758 * algorithm of alg1 and alg2 are the same, we only need this once. */
759 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100760 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100761
Steven Cooreman31a876d2021-03-03 20:47:40 +0100762 /* Get the (exact or at-least) output lengths for both sides of the
763 * requested intersection. None of the currently supported algorithms
764 * have an output length dependent on the actual key size, so setting it
765 * to a bogus value of 0 is currently OK.
766 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100767 * Note that for at-least-this-length wildcard algorithms, the output
768 * length is set to the shortest allowed length, which allows us to
769 * calculate the most restrictive tag length for the intersection. */
770 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
771 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100772 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100773
Steven Cooremana1d83222021-02-25 10:20:29 +0100774 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100775 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
776 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100777 {
Steven Cooremancd640932021-03-08 12:00:27 +0100778 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100779 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100780
781 /* If only one is an at-least-this-length policy, the intersection would
782 * be the other (fixed-length) policy as long as said fixed length is
783 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100784 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100785 {
Steven Cooremancd640932021-03-08 12:00:27 +0100786 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100787 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100788 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100789 {
Steven Cooremancd640932021-03-08 12:00:27 +0100790 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100791 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100792
Steven Cooremancd640932021-03-08 12:00:27 +0100793 /* If none of them are wildcards, check whether they define the same tag
794 * length. This is still possible here when one is default-length and
795 * the other specific-length. Ensure to always return the
796 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100797 if( alg1_len == alg2_len )
798 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100799 }
800 /* If the policies are incompatible, allow nothing. */
801 return( 0 );
802}
803
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100804static int psa_key_algorithm_permits( psa_key_type_t key_type,
805 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200806 psa_algorithm_t requested_alg )
807{
Gilles Peskine549ea862019-05-22 11:45:59 +0200808 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200809 if( requested_alg == policy_alg )
810 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100811 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
812 * and requested_alg is the same hash-and-sign family with any hash,
813 * then requested_alg is compliant with policy_alg. */
814 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
815 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200816 {
Steven Cooreman03488022021-02-18 12:07:20 +0100817 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
818 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
819 }
820 /* If policy_alg is a wildcard AEAD algorithm of the same base as
821 * the requested algorithm, check the requested tag length to be
822 * equal-length or longer than the wildcard-specified length. */
823 if( PSA_ALG_IS_AEAD( policy_alg ) &&
824 PSA_ALG_IS_AEAD( requested_alg ) &&
825 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
826 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100827 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100828 {
829 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
830 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
831 }
Steven Cooremancd640932021-03-08 12:00:27 +0100832 /* If policy_alg is a MAC algorithm of the same base as the requested
833 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100834 if( PSA_ALG_IS_MAC( policy_alg ) &&
835 PSA_ALG_IS_MAC( requested_alg ) &&
836 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100837 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100838 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100839 /* Validate the combination of key type and algorithm. Since the policy
840 * and requested algorithms are the same, we only need this once. */
841 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100842 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100843
Steven Cooreman31a876d2021-03-03 20:47:40 +0100844 /* Get both the requested output length for the algorithm which is to be
845 * verified, and the default output length for the base algorithm.
846 * Note that none of the currently supported algorithms have an output
847 * length dependent on actual key size, so setting it to a bogus value
848 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100849 size_t requested_output_length = PSA_MAC_LENGTH(
850 key_type, 0, requested_alg );
851 size_t default_output_length = PSA_MAC_LENGTH(
852 key_type, 0,
853 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100854
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100855 /* If the policy is default-length, only allow an algorithm with
856 * a declared exact-length matching the default. */
857 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100858 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100859
860 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100861 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100862 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
863 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
864 {
865 return( 1 );
866 }
867
Steven Cooremancd640932021-03-08 12:00:27 +0100868 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
869 * check for the requested MAC length to be equal to or longer than the
870 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100871 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
872 {
873 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100874 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100875 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200876 }
Steven Cooremance48e852020-10-05 16:02:45 +0200877 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200878 * a key derivation with that key agreement should also be allowed. This
879 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200880 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
881 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
882 {
883 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
884 policy_alg );
885 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100886 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200887 return( 0 );
888}
889
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100890/** Test whether a policy permits an algorithm.
891 *
892 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100893 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100894 * \note This function requires providing the key type for which the policy is
895 * being validated, since some algorithm policy definitions (e.g. MAC)
896 * have different properties depending on what kind of cipher it is
897 * combined with.
898 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100899 * \retval PSA_SUCCESS When \p alg is a specific algorithm
900 * allowed by the \p policy.
901 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
902 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
903 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100904 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100905static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100906 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100907 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100908{
Steven Cooremand788fab2021-02-25 11:29:17 +0100909 /* '0' is not a valid algorithm */
910 if( alg == 0 )
911 return( PSA_ERROR_INVALID_ARGUMENT );
912
Steven Cooreman7e39f052021-02-23 14:18:32 +0100913 /* A requested algorithm cannot be a wildcard. */
914 if( PSA_ALG_IS_WILDCARD( alg ) )
915 return( PSA_ERROR_INVALID_ARGUMENT );
916
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100917 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
918 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100919 return( PSA_SUCCESS );
920 else
921 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100922}
923
Gilles Peskinef603c712019-01-19 13:40:11 +0100924/** Restrict a key policy based on a constraint.
925 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100926 * \note This function requires providing the key type for which the policy is
927 * being restricted, since some algorithm policy definitions (e.g. MAC)
928 * have different properties depending on what kind of cipher it is
929 * combined with.
930 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100931 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100932 * \param[in,out] policy The policy to restrict.
933 * \param[in] constraint The policy constraint to apply.
934 *
935 * \retval #PSA_SUCCESS
936 * \c *policy contains the intersection of the original value of
937 * \c *policy and \c *constraint.
938 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100939 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100940 * \c *policy is unchanged.
941 */
942static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100943 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100944 psa_key_policy_t *policy,
945 const psa_key_policy_t *constraint )
946{
947 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100948 psa_key_policy_algorithm_intersection( key_type, policy->alg,
949 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200950 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100951 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
952 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100953 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
954 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200955 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
956 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100957 policy->usage &= constraint->usage;
958 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200959 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100960 return( PSA_SUCCESS );
961}
962
Ronald Cron5c522922020-11-14 16:35:34 +0100963/** Get the description of a key given its identifier and policy constraints
964 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200965 *
Ronald Cron5c522922020-11-14 16:35:34 +0100966 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100967 * nonzero, the key must allow operations with this algorithm. If \p alg is
968 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100969 *
Ronald Cron5c522922020-11-14 16:35:34 +0100970 * In case of a persistent key, the function loads the description of the key
971 * into a key slot if not already done.
972 *
973 * On success, the returned key slot is locked. It is the responsibility of
974 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200975 */
Ronald Cron5c522922020-11-14 16:35:34 +0100976static psa_status_t psa_get_and_lock_key_slot_with_policy(
977 mbedtls_svc_key_id_t key,
978 psa_key_slot_t **p_slot,
979 psa_key_usage_t usage,
980 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100981{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200982 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
983 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100984
Ronald Cron5c522922020-11-14 16:35:34 +0100985 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100986 if( status != PSA_SUCCESS )
987 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200988 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100989
990 /* Enforce that usage policy for the key slot contains all the flags
991 * required by the usage parameter. There is one exception: public
992 * keys can always be exported, so we treat public key objects as
993 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200994 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100995 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200996
Gilles Peskine8e338702019-07-30 20:06:31 +0200997 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100998 {
999 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001000 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001001 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001002
1003 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001004 if( alg != 0 )
1005 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001006 status = psa_key_policy_permits( &slot->attr.policy,
1007 slot->attr.type,
1008 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001009 if( status != PSA_SUCCESS )
1010 goto error;
1011 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001012
Darryl Green06fd18d2018-07-16 11:21:11 +01001013 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001014
1015error:
1016 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001017 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001018
1019 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001020}
Darryl Green940d72c2018-07-13 13:18:51 +01001021
Ronald Cron5c522922020-11-14 16:35:34 +01001022/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001023 *
1024 * A transparent key is a key for which the key material is directly
1025 * available, as opposed to a key in a secure element.
1026 *
Ronald Cron5c522922020-11-14 16:35:34 +01001027 * This is a temporary function to use instead of
1028 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1029 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001030 *
Ronald Cron5c522922020-11-14 16:35:34 +01001031 * On success, the returned key slot is locked. It is the responsibility of the
1032 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001033 */
1034#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001035static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1036 mbedtls_svc_key_id_t key,
1037 psa_key_slot_t **p_slot,
1038 psa_key_usage_t usage,
1039 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001040{
Ronald Cron5c522922020-11-14 16:35:34 +01001041 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1042 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001043 if( status != PSA_SUCCESS )
1044 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001045
Gilles Peskineadad8132019-07-25 11:31:23 +02001046 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001047 {
Ronald Cron5c522922020-11-14 16:35:34 +01001048 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001049 *p_slot = NULL;
1050 return( PSA_ERROR_NOT_SUPPORTED );
1051 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001052
Gilles Peskine28f8f302019-07-24 13:30:31 +02001053 return( PSA_SUCCESS );
1054}
1055#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1056/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001057#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1058 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001059#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1060
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001061/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001062static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001063{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001064 /* Data pointer will always be either a valid pointer or NULL in an
1065 * initialized slot, so we can just free it. */
1066 if( slot->key.data != NULL )
1067 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1068
1069 mbedtls_free( slot->key.data );
1070 slot->key.data = NULL;
1071 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001072
1073 return( PSA_SUCCESS );
1074}
1075
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001076/** Completely wipe a slot in memory, including its policy.
1077 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001078psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001079{
1080 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001081
1082 /*
1083 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001084 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001085 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1086 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001087 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001088 */
Ronald Cron5c522922020-11-14 16:35:34 +01001089 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001090 {
1091#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001092 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001093#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001094 status = PSA_ERROR_CORRUPTION_DETECTED;
1095 }
1096
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001097 /* Multipart operations may still be using the key. This is safe
1098 * because all multipart operation objects are independent from
1099 * the key slot: if they need to access the key after the setup
1100 * phase, they have a copy of the key. Note that this means that
1101 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001102 /* At this point, key material and other type-specific content has
1103 * been wiped. Clear remaining metadata. We can call memset and not
1104 * zeroize because the metadata is not particularly sensitive. */
1105 memset( slot, 0, sizeof( *slot ) );
1106 return( status );
1107}
1108
Ronald Croncf56a0a2020-08-04 09:51:30 +02001109psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001110{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001111 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001112 psa_status_t status; /* status of the last operation */
1113 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001114#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1115 psa_se_drv_table_entry_t *driver;
1116#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001117
Ronald Croncf56a0a2020-08-04 09:51:30 +02001118 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001119 return( PSA_SUCCESS );
1120
Ronald Cronf2911112020-10-29 17:51:10 +01001121 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001122 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001123 * key, this will load the key description from persistent memory if not
1124 * done yet. We cannot avoid this loading as without it we don't know if
1125 * the key is operated by an SE or not and this information is needed by
1126 * the current implementation.
1127 */
Ronald Cron5c522922020-11-14 16:35:34 +01001128 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001129 if( status != PSA_SUCCESS )
1130 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001131
Ronald Cronf2911112020-10-29 17:51:10 +01001132 /*
1133 * If the key slot containing the key description is under access by the
1134 * library (apart from the present access), the key cannot be destroyed
1135 * yet. For the time being, just return in error. Eventually (to be
1136 * implemented), the key should be destroyed when all accesses have
1137 * stopped.
1138 */
Ronald Cron5c522922020-11-14 16:35:34 +01001139 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001140 {
Ronald Cron5c522922020-11-14 16:35:34 +01001141 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001142 return( PSA_ERROR_GENERIC_ERROR );
1143 }
1144
Gilles Peskine354f7672019-07-12 23:46:38 +02001145#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001146 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001147 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001148 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001149 /* For a key in a secure element, we need to do three things:
1150 * remove the key file in internal storage, destroy the
1151 * key inside the secure element, and update the driver's
1152 * persistent data. Start a transaction that will encompass these
1153 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001154 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001155 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001156 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001157 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001158 status = psa_crypto_save_transaction( );
1159 if( status != PSA_SUCCESS )
1160 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001161 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001162 /* We should still try to destroy the key in the secure
1163 * element and the key metadata in storage. This is especially
1164 * important if the error is that the storage is full.
1165 * But how to do it exactly without risking an inconsistent
1166 * state after a reset?
1167 * https://github.com/ARMmbed/mbed-crypto/issues/215
1168 */
1169 overall_status = status;
1170 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001171 }
1172
Ronald Cronea0f8a62020-11-25 17:52:23 +01001173 status = psa_destroy_se_key( driver,
1174 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001175 if( overall_status == PSA_SUCCESS )
1176 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001177 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001178#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1179
Darryl Greend49a4992018-06-18 17:27:26 +01001180#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001181 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001182 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001183 status = psa_destroy_persistent_key( slot->attr.id );
1184 if( overall_status == PSA_SUCCESS )
1185 overall_status = status;
1186
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001187 /* TODO: other slots may have a copy of the same key. We should
1188 * invalidate them.
1189 * https://github.com/ARMmbed/mbed-crypto/issues/214
1190 */
Darryl Greend49a4992018-06-18 17:27:26 +01001191 }
1192#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001193
Gilles Peskinefc762652019-07-22 19:30:34 +02001194#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1195 if( driver != NULL )
1196 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001197 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001198 if( overall_status == PSA_SUCCESS )
1199 overall_status = status;
1200 status = psa_crypto_stop_transaction( );
1201 if( overall_status == PSA_SUCCESS )
1202 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001203 }
1204#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1205
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001206#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1207exit:
1208#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001209 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001210 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1211 if( overall_status == PSA_SUCCESS )
1212 overall_status = status;
1213 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001214}
1215
John Durkop07cc04a2020-11-16 22:08:34 -08001216#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001217 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001218static psa_status_t psa_get_rsa_public_exponent(
1219 const mbedtls_rsa_context *rsa,
1220 psa_key_attributes_t *attributes )
1221{
1222 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001223 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001224 uint8_t *buffer = NULL;
1225 size_t buflen;
1226 mbedtls_mpi_init( &mpi );
1227
1228 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1229 if( ret != 0 )
1230 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001231 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1232 {
1233 /* It's the default value, which is reported as an empty string,
1234 * so there's nothing to do. */
1235 goto exit;
1236 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001237
1238 buflen = mbedtls_mpi_size( &mpi );
1239 buffer = mbedtls_calloc( 1, buflen );
1240 if( buffer == NULL )
1241 {
1242 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1243 goto exit;
1244 }
1245 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1246 if( ret != 0 )
1247 goto exit;
1248 attributes->domain_parameters = buffer;
1249 attributes->domain_parameters_size = buflen;
1250
1251exit:
1252 mbedtls_mpi_free( &mpi );
1253 if( ret != 0 )
1254 mbedtls_free( buffer );
1255 return( mbedtls_to_psa_error( ret ) );
1256}
John Durkop07cc04a2020-11-16 22:08:34 -08001257#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001258 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001259
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001260/** Retrieve all the publicly-accessible attributes of a key.
1261 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001262psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001263 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001264{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001266 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001267 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001268
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001269 psa_reset_key_attributes( attributes );
1270
Ronald Cron5c522922020-11-14 16:35:34 +01001271 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001272 if( status != PSA_SUCCESS )
1273 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001274
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001275 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001276 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1277 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1278
1279#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1280 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001281 psa_set_key_slot_number( attributes,
1282 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001283#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001284
Gilles Peskine8e338702019-07-30 20:06:31 +02001285 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001286 {
John Durkop07cc04a2020-11-16 22:08:34 -08001287#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001288 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001289 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001290 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001291#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001292 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001293 * is not yet implemented.
1294 * https://github.com/ARMmbed/mbed-crypto/issues/216
1295 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001296 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001297 break;
1298#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001299 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001300 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001301
Ronald Cron90857082020-11-25 14:58:33 +01001302 status = mbedtls_psa_rsa_load_representation(
1303 slot->attr.type,
1304 slot->key.data,
1305 slot->key.bytes,
1306 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001307 if( status != PSA_SUCCESS )
1308 break;
1309
Steven Cooremana2371e52020-07-28 14:30:39 +02001310 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001311 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001312 mbedtls_rsa_free( rsa );
1313 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001314 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001315 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001316#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001317 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001318 default:
1319 /* Nothing else to do. */
1320 break;
1321 }
1322
1323 if( status != PSA_SUCCESS )
1324 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001325
Ronald Cron5c522922020-11-14 16:35:34 +01001326 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001327
Ronald Cron5c522922020-11-14 16:35:34 +01001328 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001329}
1330
Gilles Peskinec8000c02019-08-02 20:15:51 +02001331#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1332psa_status_t psa_get_key_slot_number(
1333 const psa_key_attributes_t *attributes,
1334 psa_key_slot_number_t *slot_number )
1335{
1336 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1337 {
1338 *slot_number = attributes->slot_number;
1339 return( PSA_SUCCESS );
1340 }
1341 else
1342 return( PSA_ERROR_INVALID_ARGUMENT );
1343}
1344#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1345
Ronald Crond18b5f82020-11-25 16:46:05 +01001346static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1347 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001348 uint8_t *data,
1349 size_t data_size,
1350 size_t *data_length )
1351{
Ronald Crond18b5f82020-11-25 16:46:05 +01001352 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001353 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001354 memcpy( data, key_buffer, key_buffer_size );
1355 memset( data + key_buffer_size, 0,
1356 data_size - key_buffer_size );
1357 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001358 return( PSA_SUCCESS );
1359}
1360
Ronald Cron7285cda2020-11-26 14:46:37 +01001361psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001362 const psa_key_attributes_t *attributes,
1363 const uint8_t *key_buffer, size_t key_buffer_size,
1364 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001365{
Ronald Crond18b5f82020-11-25 16:46:05 +01001366 psa_key_type_t type = attributes->core.type;
1367
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 if( key_type_is_raw_bytes( type ) ||
1369 PSA_KEY_TYPE_IS_RSA( type ) ||
1370 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001371 {
1372 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001373 key_buffer, key_buffer_size,
1374 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001375 }
1376 else
1377 {
1378 /* This shouldn't happen in the reference implementation, but
1379 it is valid for a special-purpose implementation to omit
1380 support for exporting certain key types. */
1381 return( PSA_ERROR_NOT_SUPPORTED );
1382 }
1383}
1384
1385psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1386 uint8_t *data,
1387 size_t data_size,
1388 size_t *data_length )
1389{
1390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1391 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1392 psa_key_slot_t *slot;
1393
Ronald Crone907e552021-01-18 13:22:38 +01001394 /* Reject a zero-length output buffer now, since this can never be a
1395 * valid key representation. This way we know that data must be a valid
1396 * pointer and we can do things like memset(data, ..., data_size). */
1397 if( data_size == 0 )
1398 return( PSA_ERROR_BUFFER_TOO_SMALL );
1399
Ronald Cron9486f9d2020-11-26 13:36:23 +01001400 /* Set the key to empty now, so that even when there are errors, we always
1401 * set data_length to a value between 0 and data_size. On error, setting
1402 * the key to empty is a good choice because an empty key representation is
1403 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001404 *data_length = 0;
1405
Ronald Cron9486f9d2020-11-26 13:36:23 +01001406 /* Export requires the EXPORT flag. There is an exception for public keys,
1407 * which don't require any flag, but
1408 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1409 */
1410 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1411 PSA_KEY_USAGE_EXPORT, 0 );
1412 if( status != PSA_SUCCESS )
1413 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001414
Ronald Crond18b5f82020-11-25 16:46:05 +01001415 psa_key_attributes_t attributes = {
1416 .core = slot->attr
1417 };
Ronald Cron67227982020-11-26 15:16:05 +01001418 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001419 slot->key.data, slot->key.bytes,
1420 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421
Ronald Cron9486f9d2020-11-26 13:36:23 +01001422 unlock_status = psa_unlock_key_slot( slot );
1423
1424 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1425}
1426
Ronald Cron7285cda2020-11-26 14:46:37 +01001427psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001428 const psa_key_attributes_t *attributes,
1429 const uint8_t *key_buffer,
1430 size_t key_buffer_size,
1431 uint8_t *data,
1432 size_t data_size,
1433 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001434{
Ronald Crond18b5f82020-11-25 16:46:05 +01001435 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001436
Ronald Crond18b5f82020-11-25 16:46:05 +01001437 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001438 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001439 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001440 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001441 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001442 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001443 key_buffer, key_buffer_size,
1444 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001445 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001446
Ronald Crond18b5f82020-11-25 16:46:05 +01001447 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001448 {
John Durkop0e005192020-10-31 22:06:54 -07001449#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1450 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001451 return( mbedtls_psa_rsa_export_public_key( attributes,
1452 key_buffer,
1453 key_buffer_size,
1454 data,
1455 data_size,
1456 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001457#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001458 /* We don't know how to convert a private RSA key to public. */
1459 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001460#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1461 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001462 }
1463 else
Moran Pekera998bc62018-04-16 18:16:20 +03001464 {
John Durkop6ba40d12020-11-10 08:50:04 -08001465#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1466 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001467 return( mbedtls_psa_ecp_export_public_key( attributes,
1468 key_buffer,
1469 key_buffer_size,
1470 data,
1471 data_size,
1472 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001473#else
1474 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001475 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001476#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1477 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001478 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001479 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001480 else
1481 {
1482 /* This shouldn't happen in the reference implementation, but
1483 it is valid for a special-purpose implementation to omit
1484 support for exporting certain key types. */
1485 return( PSA_ERROR_NOT_SUPPORTED );
1486 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001487}
Ronald Crond18b5f82020-11-25 16:46:05 +01001488
Ronald Croncf56a0a2020-08-04 09:51:30 +02001489psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001490 uint8_t *data,
1491 size_t data_size,
1492 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001493{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001494 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001495 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001496 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001497
Ronald Crone907e552021-01-18 13:22:38 +01001498 /* Reject a zero-length output buffer now, since this can never be a
1499 * valid key representation. This way we know that data must be a valid
1500 * pointer and we can do things like memset(data, ..., data_size). */
1501 if( data_size == 0 )
1502 return( PSA_ERROR_BUFFER_TOO_SMALL );
1503
Darryl Greendd8fb772018-11-07 16:00:44 +00001504 /* Set the key to empty now, so that even when there are errors, we always
1505 * set data_length to a value between 0 and data_size. On error, setting
1506 * the key to empty is a good choice because an empty key representation is
1507 * unlikely to be accepted anywhere. */
1508 *data_length = 0;
1509
1510 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001511 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001512 if( status != PSA_SUCCESS )
1513 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001514
Ronald Cron9486f9d2020-11-26 13:36:23 +01001515 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1516 {
1517 status = PSA_ERROR_INVALID_ARGUMENT;
1518 goto exit;
1519 }
1520
Ronald Crond18b5f82020-11-25 16:46:05 +01001521 psa_key_attributes_t attributes = {
1522 .core = slot->attr
1523 };
Ronald Cron67227982020-11-26 15:16:05 +01001524 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001525 &attributes, slot->key.data, slot->key.bytes,
1526 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001527
1528exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001529 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001530
Ronald Cron5c522922020-11-14 16:35:34 +01001531 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001532}
1533
Gilles Peskine91e8c332019-08-02 19:19:39 +02001534#if defined(static_assert)
1535static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1536 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001537static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001538 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001539static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001540 "One or more key attribute flag is listed as both internal-only and external-only" );
1541#endif
1542
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001543/** Validate that a key policy is internally well-formed.
1544 *
1545 * This function only rejects invalid policies. It does not validate the
1546 * consistency of the policy with respect to other attributes of the key
1547 * such as the key type.
1548 */
1549static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001550{
1551 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001552 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001553 PSA_KEY_USAGE_ENCRYPT |
1554 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001555 PSA_KEY_USAGE_SIGN_HASH |
1556 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001557 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1558 return( PSA_ERROR_INVALID_ARGUMENT );
1559
Gilles Peskine4747d192019-04-17 15:05:45 +02001560 return( PSA_SUCCESS );
1561}
1562
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001563/** Validate the internal consistency of key attributes.
1564 *
1565 * This function only rejects invalid attribute values. If does not
1566 * validate the consistency of the attributes with any key data that may
1567 * be involved in the creation of the key.
1568 *
1569 * Call this function early in the key creation process.
1570 *
1571 * \param[in] attributes Key attributes for the new key.
1572 * \param[out] p_drv On any return, the driver for the key, if any.
1573 * NULL for a transparent key.
1574 *
1575 */
1576static psa_status_t psa_validate_key_attributes(
1577 const psa_key_attributes_t *attributes,
1578 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001579{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001580 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001581 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001582 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001583
Ronald Cron54b90082020-10-29 15:26:43 +01001584 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001585 if( status != PSA_SUCCESS )
1586 return( status );
1587
Ronald Crond2ed4812020-07-17 16:11:30 +02001588 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001589 if( status != PSA_SUCCESS )
1590 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001591
Ronald Cron65f38a32020-10-23 17:11:13 +02001592 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1593 {
1594 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1595 return( PSA_ERROR_INVALID_ARGUMENT );
1596 }
1597 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001598 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001599 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001600 if( status != PSA_SUCCESS )
1601 return( status );
1602 }
1603
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001604 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001605 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001606 return( status );
1607
1608 /* Refuse to create overly large keys.
1609 * Note that this doesn't trigger on import if the attributes don't
1610 * explicitly specify a size (so psa_get_key_bits returns 0), so
1611 * psa_import_key() needs its own checks. */
1612 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1613 return( PSA_ERROR_NOT_SUPPORTED );
1614
Gilles Peskine91e8c332019-08-02 19:19:39 +02001615 /* Reject invalid flags. These should not be reachable through the API. */
1616 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1617 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1618 return( PSA_ERROR_INVALID_ARGUMENT );
1619
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001620 return( PSA_SUCCESS );
1621}
1622
Gilles Peskine4747d192019-04-17 15:05:45 +02001623/** Prepare a key slot to receive key material.
1624 *
1625 * This function allocates a key slot and sets its metadata.
1626 *
1627 * If this function fails, call psa_fail_key_creation().
1628 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001629 * This function is intended to be used as follows:
1630 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001631 * it with the specified attributes, and in case of a volatile key assign it
1632 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001633 * -# Populate the slot with the key material.
1634 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1635 * In case of failure at any step, stop the sequence and call
1636 * psa_fail_key_creation().
1637 *
Ronald Cron5c522922020-11-14 16:35:34 +01001638 * On success, the key slot is locked. It is the responsibility of the caller
1639 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001640 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001641 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001642 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001643 * \param[out] p_slot On success, a pointer to the prepared slot.
1644 * \param[out] p_drv On any return, the driver for the key, if any.
1645 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001646 *
1647 * \retval #PSA_SUCCESS
1648 * The key slot is ready to receive key material.
1649 * \return If this function fails, the key slot is an invalid state.
1650 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001651 */
1652static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001653 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001654 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001655 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001656 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001657{
1658 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001659 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001660 psa_key_slot_t *slot;
1661
Gilles Peskinedf179142019-07-15 22:02:14 +02001662 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001663 *p_drv = NULL;
1664
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001665 status = psa_validate_key_attributes( attributes, p_drv );
1666 if( status != PSA_SUCCESS )
1667 return( status );
1668
Ronald Cronc4d1b512020-07-31 11:26:37 +02001669 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001670 if( status != PSA_SUCCESS )
1671 return( status );
1672 slot = *p_slot;
1673
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001674 /* We're storing the declared bit-size of the key. It's up to each
1675 * creation mechanism to verify that this information is correct.
1676 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001677 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001678 * is optional (import, copy). In case of a volatile key, assign it the
1679 * volatile key identifier associated to the slot returned to contain its
1680 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001681
1682 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001683 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1684 {
1685#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1686 slot->attr.id = volatile_key_id;
1687#else
1688 slot->attr.id.key_id = volatile_key_id;
1689#endif
1690 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001691
Gilles Peskine91e8c332019-08-02 19:19:39 +02001692 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001693 * external-only flags, query `attributes`. Thanks to the check
1694 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001695 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001696 * may have set. */
1697 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001698
Gilles Peskinecbaff462019-07-12 23:46:04 +02001699#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001700 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001701 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001702 * create the key file in internal storage, create the
1703 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001704 * persistent data. This is done by starting a transaction that will
1705 * encompass these three actions.
1706 * For registering a volatile key, we just need to find an appropriate
1707 * slot number inside the SE. Since the key is designated volatile, creating
1708 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001709 /* The first thing to do is to find a slot number for the new key.
1710 * We save the slot number in persistent storage as part of the
1711 * transaction data. It will be needed to recover if the power
1712 * fails during the key creation process, to clean up on the secure
1713 * element side after restarting. Obtaining a slot number from the
1714 * secure element driver updates its persistent state, but we do not yet
1715 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001716 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001717 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001718 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001719 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001720 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001722 if( status != PSA_SUCCESS )
1723 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001724
1725 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001726 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001727 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1728 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001730 psa_crypto_transaction.key.id = slot->attr.id;
1731 status = psa_crypto_save_transaction( );
1732 if( status != PSA_SUCCESS )
1733 {
1734 (void) psa_crypto_stop_transaction( );
1735 return( status );
1736 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001737 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738
1739 status = psa_copy_key_material_into_slot(
1740 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001741 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001742
1743 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1744 {
1745 /* Key registration only makes sense with a secure element. */
1746 return( PSA_ERROR_INVALID_ARGUMENT );
1747 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001748#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1749
Ronald Cronc4d1b512020-07-31 11:26:37 +02001750 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001751}
Gilles Peskine4747d192019-04-17 15:05:45 +02001752
1753/** Finalize the creation of a key once its key material has been set.
1754 *
1755 * This entails writing the key to persistent storage.
1756 *
1757 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001758 * See the documentation of psa_start_key_creation() for the intended use
1759 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001760 *
Ronald Cron5c522922020-11-14 16:35:34 +01001761 * If the finalization succeeds, the function unlocks the key slot (it was
1762 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1763 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001764 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001765 * \param[in,out] slot Pointer to the slot with key material.
1766 * \param[in] driver The secure element driver for the key,
1767 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001768 * \param[out] key On success, identifier of the key. Note that the
1769 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001770 *
1771 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001772 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001773 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1774 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1775 * \retval #PSA_ERROR_ALREADY_EXISTS
1776 * \retval #PSA_ERROR_DATA_INVALID
1777 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001778 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001779 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 * \return If this function fails, the key slot is an invalid state.
1781 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001782 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001783static psa_status_t psa_finish_key_creation(
1784 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001785 psa_se_drv_table_entry_t *driver,
1786 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001787{
1788 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001789 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001791
1792#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001793 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001795#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1796 if( driver != NULL )
1797 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001798 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001799 psa_key_slot_number_t slot_number =
1800 psa_key_slot_get_slot_number( slot ) ;
1801
Gilles Peskineb46bef22019-07-30 21:32:04 +02001802#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001803 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001804 sizeof( data.slot_number ),
1805 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001806#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001807 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001808 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001809 (uint8_t*) &data,
1810 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001811 }
1812 else
1813#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1814 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001815 /* Key material is saved in export representation in the slot, so
1816 * just pass the slot buffer for storage. */
1817 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001818 slot->key.data,
1819 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001820 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001822#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1823
Gilles Peskinecbaff462019-07-12 23:46:04 +02001824#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001825 /* Finish the transaction for a key creation. This does not
1826 * happen when registering an existing key. Detect this case
1827 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001828 * creation of a persistent key in a secure element requires a transaction,
1829 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001830 if( driver != NULL &&
1831 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001832 {
1833 status = psa_save_se_persistent_data( driver );
1834 if( status != PSA_SUCCESS )
1835 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001836 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001837 return( status );
1838 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001839 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001840 }
1841#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1842
Ronald Cron50972942020-11-14 11:28:25 +01001843 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001844 {
1845 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001846 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001847 if( status != PSA_SUCCESS )
1848 *key = MBEDTLS_SVC_KEY_ID_INIT;
1849 }
Ronald Cron50972942020-11-14 11:28:25 +01001850
Gilles Peskine4747d192019-04-17 15:05:45 +02001851 return( status );
1852}
1853
1854/** Abort the creation of a key.
1855 *
1856 * You may call this function after calling psa_start_key_creation(),
1857 * or after psa_finish_key_creation() fails. In other circumstances, this
1858 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001859 * See the documentation of psa_start_key_creation() for the intended use
1860 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001861 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001862 * \param[in,out] slot Pointer to the slot with key material.
1863 * \param[in] driver The secure element driver for the key,
1864 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001865 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001866static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001867 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001868{
Gilles Peskine011e4282019-06-26 18:34:38 +02001869 (void) driver;
1870
Gilles Peskine4747d192019-04-17 15:05:45 +02001871 if( slot == NULL )
1872 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001873
1874#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001875 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001876 * element, and the failure happened later (when saving metadata
1877 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001878 * element.
1879 * https://github.com/ARMmbed/mbed-crypto/issues/217
1880 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001881
Gilles Peskined7729582019-08-05 15:55:54 +02001882 /* Abort the ongoing transaction if any (there may not be one if
1883 * the creation process failed before starting one, or if the
1884 * key creation is a registration of a key in a secure element).
1885 * Earlier functions must already have done what it takes to undo any
1886 * partial creation. All that's left is to update the transaction data
1887 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001888 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001889#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1890
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 psa_wipe_key_slot( slot );
1892}
1893
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001894/** Validate optional attributes during key creation.
1895 *
1896 * Some key attributes are optional during key creation. If they are
1897 * specified in the attributes structure, check that they are consistent
1898 * with the data in the slot.
1899 *
1900 * This function should be called near the end of key creation, after
1901 * the slot in memory is fully populated but before saving persistent data.
1902 */
1903static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904 const psa_key_slot_t *slot,
1905 const psa_key_attributes_t *attributes )
1906{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001907 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001909 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 return( PSA_ERROR_INVALID_ARGUMENT );
1911 }
1912
1913 if( attributes->domain_parameters_size != 0 )
1914 {
John Durkop0e005192020-10-31 22:06:54 -07001915#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1916 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001917 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001918 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001919 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001920 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001922
Ronald Cron90857082020-11-25 14:58:33 +01001923 psa_status_t status = mbedtls_psa_rsa_load_representation(
1924 slot->attr.type,
1925 slot->key.data,
1926 slot->key.bytes,
1927 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001928 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001929 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001930
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001931 mbedtls_mpi_init( &actual );
1932 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001933 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001935 mbedtls_rsa_free( rsa );
1936 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001937 if( ret != 0 )
1938 goto rsa_exit;
1939 ret = mbedtls_mpi_read_binary( &required,
1940 attributes->domain_parameters,
1941 attributes->domain_parameters_size );
1942 if( ret != 0 )
1943 goto rsa_exit;
1944 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1945 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1946 rsa_exit:
1947 mbedtls_mpi_free( &actual );
1948 mbedtls_mpi_free( &required );
1949 if( ret != 0)
1950 return( mbedtls_to_psa_error( ret ) );
1951 }
1952 else
John Durkop9814fa22020-11-04 12:28:15 -08001953#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1954 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955 {
1956 return( PSA_ERROR_INVALID_ARGUMENT );
1957 }
1958 }
1959
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001960 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001961 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001962 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001963 return( PSA_ERROR_INVALID_ARGUMENT );
1964 }
1965
1966 return( PSA_SUCCESS );
1967}
1968
Gilles Peskine4747d192019-04-17 15:05:45 +02001969psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001970 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001971 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001972 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001973{
1974 psa_status_t status;
1975 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001976 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001977 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001978
Ronald Cron81709fc2020-11-14 12:10:32 +01001979 *key = MBEDTLS_SVC_KEY_ID_INIT;
1980
Gilles Peskine0f84d622019-09-12 19:03:13 +02001981 /* Reject zero-length symmetric keys (including raw data key objects).
1982 * This also rejects any key which might be encoded as an empty string,
1983 * which is never valid. */
1984 if( data_length == 0 )
1985 return( PSA_ERROR_INVALID_ARGUMENT );
1986
Gilles Peskinedf179142019-07-15 22:02:14 +02001987 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001988 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001989 if( status != PSA_SUCCESS )
1990 goto exit;
1991
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001992 /* In the case of a transparent key or an opaque key stored in local
1993 * storage (thus not in the case of generating a key in a secure element
1994 * or cryptoprocessor with storage), we have to allocate a buffer to
1995 * hold the generated key material. */
1996 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001997 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001998 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001999 if( status != PSA_SUCCESS )
2000 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002001 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002002
2003 bits = slot->attr.bits;
2004 status = psa_driver_wrapper_import_key( attributes,
2005 data, data_length,
2006 slot->key.data,
2007 slot->key.bytes,
2008 &slot->key.bytes, &bits );
2009 if( status != PSA_SUCCESS )
2010 goto exit;
2011
2012 if( slot->attr.bits == 0 )
2013 slot->attr.bits = (psa_key_bits_t) bits;
2014 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002015 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002016 status = PSA_ERROR_INVALID_ARGUMENT;
2017 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002018 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002019
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002020 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002021 if( status != PSA_SUCCESS )
2022 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023
Ronald Cron81709fc2020-11-14 12:10:32 +01002024 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002025exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002026 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002027 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002028
Gilles Peskine4747d192019-04-17 15:05:45 +02002029 return( status );
2030}
2031
Gilles Peskined7729582019-08-05 15:55:54 +02002032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2033psa_status_t mbedtls_psa_register_se_key(
2034 const psa_key_attributes_t *attributes )
2035{
2036 psa_status_t status;
2037 psa_key_slot_t *slot = NULL;
2038 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002039 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002040
2041 /* Leaving attributes unspecified is not currently supported.
2042 * It could make sense to query the key type and size from the
2043 * secure element, but not all secure elements support this
2044 * and the driver HAL doesn't currently support it. */
2045 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2046 return( PSA_ERROR_NOT_SUPPORTED );
2047 if( psa_get_key_bits( attributes ) == 0 )
2048 return( PSA_ERROR_NOT_SUPPORTED );
2049
2050 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002051 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002052 if( status != PSA_SUCCESS )
2053 goto exit;
2054
Ronald Cron81709fc2020-11-14 12:10:32 +01002055 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002056
2057exit:
2058 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002059 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002060
Gilles Peskined7729582019-08-05 15:55:54 +02002061 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002062 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002063 return( status );
2064}
2065#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2066
Gilles Peskinef603c712019-01-19 13:40:11 +01002067static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002069{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002070 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002071 source->key.data,
2072 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002073 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002074 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002075
Steven Cooreman398aee52020-10-13 14:35:45 +02002076 target->attr.type = source->attr.type;
2077 target->attr.bits = source->attr.bits;
2078
2079 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002080}
2081
Ronald Croncf56a0a2020-08-04 09:51:30 +02002082psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002083 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002084 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002085{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002087 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002088 psa_key_slot_t *source_slot = NULL;
2089 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002090 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002091 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002092
Ronald Cron81709fc2020-11-14 12:10:32 +01002093 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2094
Ronald Cron5c522922020-11-14 16:35:34 +01002095 status = psa_get_and_lock_transparent_key_slot_with_policy(
2096 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002097 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002098 goto exit;
2099
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002100 status = psa_validate_optional_attributes( source_slot,
2101 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002102 if( status != PSA_SUCCESS )
2103 goto exit;
2104
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002105 status = psa_restrict_key_policy( source_slot->attr.type,
2106 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002107 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002108 if( status != PSA_SUCCESS )
2109 goto exit;
2110
Ronald Cron81709fc2020-11-14 12:10:32 +01002111 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2112 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002113 if( status != PSA_SUCCESS )
2114 goto exit;
2115
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002116#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2117 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002118 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002119 /* Copying to a secure element is not implemented yet. */
2120 status = PSA_ERROR_NOT_SUPPORTED;
2121 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002122 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002124
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002125 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002126 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002127 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002128
Ronald Cron81709fc2020-11-14 12:10:32 +01002129 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002130exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002131 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002132 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002133
Ronald Cron5c522922020-11-14 16:35:34 +01002134 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002135
Ronald Cron5c522922020-11-14 16:35:34 +01002136 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002137}
2138
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002139
2140
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002141/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002142/* Message digests */
2143/****************************************************************/
2144
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002145psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2146{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 /* Aborting a non-active operation is allowed */
2148 if( operation->id == 0 )
2149 return( PSA_SUCCESS );
2150
2151 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2152 operation->id = 0;
2153
2154 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155}
2156
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002157psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002158 psa_algorithm_t alg )
2159{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002160 /* A context must be freshly initialized before it can be set up. */
2161 if( operation->id != 0 )
2162 return( PSA_ERROR_BAD_STATE );
2163
2164 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002165 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002166
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002167 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2168 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002169 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2170
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002171 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172}
2173
2174psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2175 const uint8_t *input,
2176 size_t input_length )
2177{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002178 if( operation->id == 0 )
2179 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002180
Steven Cooremanc8288352021-03-04 14:02:19 +01002181 /* Don't require hash implementations to behave correctly on a
2182 * zero-length input, which may have an invalid pointer. */
2183 if( input_length == 0 )
2184 return( PSA_SUCCESS );
2185
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002186 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2187 input, input_length );
2188 if( status != PSA_SUCCESS )
2189 psa_hash_abort( operation );
2190
2191 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192}
2193
2194psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2195 uint8_t *hash,
2196 size_t hash_size,
2197 size_t *hash_length )
2198{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002199 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002200 if( operation->id == 0 )
2201 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002202
Steven Cooreman1e582352021-02-18 17:24:37 +01002203 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002204 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002205 psa_hash_abort( operation );
2206 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207}
2208
Gilles Peskine2d277862018-06-18 15:41:12 +02002209psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2210 const uint8_t *hash,
2211 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212{
2213 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2214 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002215 psa_status_t status = psa_hash_finish(
2216 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002217 actual_hash, sizeof( actual_hash ),
2218 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219 if( status != PSA_SUCCESS )
2220 return( status );
2221 if( actual_hash_length != hash_length )
2222 return( PSA_ERROR_INVALID_SIGNATURE );
2223 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2224 return( PSA_ERROR_INVALID_SIGNATURE );
2225 return( PSA_SUCCESS );
2226}
2227
Gilles Peskine0a749c82019-11-28 19:33:58 +01002228psa_status_t psa_hash_compute( psa_algorithm_t alg,
2229 const uint8_t *input, size_t input_length,
2230 uint8_t *hash, size_t hash_size,
2231 size_t *hash_length )
2232{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002233 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002234 if( !PSA_ALG_IS_HASH( alg ) )
2235 return( PSA_ERROR_INVALID_ARGUMENT );
2236
Steven Cooreman1e582352021-02-18 17:24:37 +01002237 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2238 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002239}
2240
2241psa_status_t psa_hash_compare( psa_algorithm_t alg,
2242 const uint8_t *input, size_t input_length,
2243 const uint8_t *hash, size_t hash_length )
2244{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002245 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2246 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002247
2248 if( !PSA_ALG_IS_HASH( alg ) )
2249 return( PSA_ERROR_INVALID_ARGUMENT );
2250
Steven Cooreman1e582352021-02-18 17:24:37 +01002251 psa_status_t status = psa_driver_wrapper_hash_compute(
2252 alg, input, input_length,
2253 actual_hash, sizeof(actual_hash),
2254 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002255 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002256 return( status );
2257 if( actual_hash_length != hash_length )
2258 return( PSA_ERROR_INVALID_SIGNATURE );
2259 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2260 return( PSA_ERROR_INVALID_SIGNATURE );
2261 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002262}
2263
Gilles Peskineeb35d782019-01-22 17:56:16 +01002264psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2265 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002266{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002267 if( source_operation->id == 0 ||
2268 target_operation->id != 0 )
2269 {
2270 return( PSA_ERROR_BAD_STATE );
2271 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002272
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002273 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2274 target_operation );
2275 if( status != PSA_SUCCESS )
2276 psa_hash_abort( target_operation );
2277
2278 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002279}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002280
2281
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002282/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002283/* MAC */
2284/****************************************************************/
2285
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002286static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002287 psa_algorithm_t alg,
2288 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002289 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002290 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002291{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002292 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002293 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002294
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002295 if( PSA_ALG_IS_AEAD( alg ) )
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002296 alg = PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002297
Gilles Peskine8c9def32018-02-08 10:02:12 +01002298 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2299 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002300 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002301 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002302 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002303 mode = MBEDTLS_MODE_STREAM;
2304 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002305 case PSA_ALG_CTR:
2306 mode = MBEDTLS_MODE_CTR;
2307 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002308 case PSA_ALG_CFB:
2309 mode = MBEDTLS_MODE_CFB;
2310 break;
2311 case PSA_ALG_OFB:
2312 mode = MBEDTLS_MODE_OFB;
2313 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002314 case PSA_ALG_ECB_NO_PADDING:
2315 mode = MBEDTLS_MODE_ECB;
2316 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002317 case PSA_ALG_CBC_NO_PADDING:
2318 mode = MBEDTLS_MODE_CBC;
2319 break;
2320 case PSA_ALG_CBC_PKCS7:
2321 mode = MBEDTLS_MODE_CBC;
2322 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002323 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002324 mode = MBEDTLS_MODE_CCM;
2325 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002326 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002327 mode = MBEDTLS_MODE_GCM;
2328 break;
Bence Szépkútia63b20d2020-12-16 11:36:46 +01002329 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02002330 mode = MBEDTLS_MODE_CHACHAPOLY;
2331 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002332 default:
2333 return( NULL );
2334 }
2335 }
2336 else if( alg == PSA_ALG_CMAC )
2337 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002338 else
2339 return( NULL );
2340
2341 switch( key_type )
2342 {
2343 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002344 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002345 break;
2346 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002347 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2348 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002349 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002350 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002352 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002353 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2354 * but two-key Triple-DES is functionally three-key Triple-DES
2355 * with K1=K3, so that's how we present it to mbedtls. */
2356 if( key_bits == 128 )
2357 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358 break;
2359 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002360 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361 break;
2362 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002363 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002364 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002365 case PSA_KEY_TYPE_CHACHA20:
2366 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2367 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002368 default:
2369 return( NULL );
2370 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002371 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002372 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373
Jaeden Amero23bbb752018-06-26 14:16:54 +01002374 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2375 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002376}
2377
John Durkop6ba40d12020-11-10 08:50:04 -08002378#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002379static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002380{
Gilles Peskine2d277862018-06-18 15:41:12 +02002381 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002382 {
2383 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002384 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002385 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002386 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002387 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002388 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002389 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002390 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002391 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002392 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002393 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002394 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002395 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002396 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002397 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002398 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002399 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002400 return( 128 );
2401 default:
2402 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002403 }
2404}
John Durkop07cc04a2020-11-16 22:08:34 -08002405#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002406
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002407/* Initialize the MAC operation structure. Once this function has been
2408 * called, psa_mac_abort can run and will do the right thing. */
2409static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2410 psa_algorithm_t alg )
2411{
2412 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2413
Steven Cooreman15472f82021-03-02 16:16:22 +01002414 operation->alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002415 operation->key_set = 0;
2416 operation->iv_set = 0;
2417 operation->iv_required = 0;
2418 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002419 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002420
2421#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002422 if( operation->alg == PSA_ALG_CMAC )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002423 {
2424 operation->iv_required = 0;
2425 mbedtls_cipher_init( &operation->ctx.cmac );
2426 status = PSA_SUCCESS;
2427 }
2428 else
2429#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002430#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002431 if( PSA_ALG_IS_HMAC( operation->alg ) )
2432 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002433 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
Steven Cooreman0e307642021-02-18 16:18:32 +01002434 operation->ctx.hmac.alg = 0;
Gilles Peskineff94abd2018-07-12 17:07:52 +02002435 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002436 }
2437 else
John Durkopd0321952020-10-29 21:37:36 -07002438#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002439 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002440 if( ! PSA_ALG_IS_MAC( alg ) )
2441 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002442 }
2443
2444 if( status != PSA_SUCCESS )
2445 memset( operation, 0, sizeof( *operation ) );
2446 return( status );
2447}
2448
John Durkop6ba40d12020-11-10 08:50:04 -08002449#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002450static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2451{
Gilles Peskine3f108122018-12-07 18:14:53 +01002452 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002453 return( psa_hash_abort( &hmac->hash_ctx ) );
2454}
John Durkop6ba40d12020-11-10 08:50:04 -08002455#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002456
Gilles Peskine8c9def32018-02-08 10:02:12 +01002457psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2458{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002459 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002460 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002461 /* The object has (apparently) been initialized but it is not
2462 * in use. It's ok to call abort on such an object, and there's
2463 * nothing to do. */
2464 return( PSA_SUCCESS );
2465 }
2466 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002467#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002468 if( operation->alg == PSA_ALG_CMAC )
2469 {
2470 mbedtls_cipher_free( &operation->ctx.cmac );
2471 }
2472 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002473#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002474#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002475 if( PSA_ALG_IS_HMAC( operation->alg ) )
2476 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002477 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002478 }
2479 else
John Durkopd0321952020-10-29 21:37:36 -07002480#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002481 {
2482 /* Sanity check (shouldn't happen: operation->alg should
2483 * always have been initialized to a valid value). */
2484 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485 }
Moran Peker41deec42018-04-04 15:43:05 +03002486
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487 operation->alg = 0;
2488 operation->key_set = 0;
2489 operation->iv_set = 0;
2490 operation->iv_required = 0;
2491 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002492 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002493
Gilles Peskine8c9def32018-02-08 10:02:12 +01002494 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002495
2496bad_state:
2497 /* If abort is called on an uninitialized object, we can't trust
2498 * anything. Wipe the object in case it contains confidential data.
2499 * This may result in a memory leak if a pointer gets overwritten,
2500 * but it's too late to do anything about this. */
2501 memset( operation, 0, sizeof( *operation ) );
2502 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002503}
2504
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002505#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002506static psa_status_t psa_cmac_setup( psa_mac_operation_t *operation,
2507 psa_key_slot_t *slot )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002508{
Janos Follath24eed8d2019-11-22 13:21:35 +00002509 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002510 const mbedtls_cipher_info_t *cipher_info =
2511 mbedtls_cipher_info_from_psa( PSA_ALG_CMAC,
2512 slot->attr.type, slot->attr.bits,
2513 NULL );
2514 if( cipher_info == NULL )
2515 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002516
2517 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2518 if( ret != 0 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002519 goto exit;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002520
2521 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002522 slot->key.data,
Steven Cooreman15472f82021-03-02 16:16:22 +01002523 slot->attr.bits );
2524exit:
2525 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002526}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002527#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002528
John Durkop6ba40d12020-11-10 08:50:04 -08002529#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002530static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2531 const uint8_t *key,
2532 size_t key_length,
2533 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002534{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002535 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002536 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002537 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002538 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002539 psa_status_t status;
2540
Steven Cooreman0e307642021-02-18 16:18:32 +01002541 hmac->alg = hash_alg;
2542
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002543 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2544 * overflow below. This should never trigger if the hash algorithm
2545 * is implemented correctly. */
2546 /* The size checks against the ipad and opad buffers cannot be written
2547 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2548 * because that triggers -Wlogical-op on GCC 7.3. */
2549 if( block_size > sizeof( ipad ) )
2550 return( PSA_ERROR_NOT_SUPPORTED );
2551 if( block_size > sizeof( hmac->opad ) )
2552 return( PSA_ERROR_NOT_SUPPORTED );
2553 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002554 return( PSA_ERROR_NOT_SUPPORTED );
2555
Gilles Peskined223b522018-06-11 18:12:58 +02002556 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002557 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002558 status = psa_hash_compute( hash_alg, key, key_length,
2559 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002560 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002561 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002562 }
Gilles Peskine96889972018-07-12 17:07:03 +02002563 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2564 * but it is permitted. It is common when HMAC is used in HKDF, for
2565 * example. Don't call `memcpy` in the 0-length because `key` could be
2566 * an invalid pointer which would make the behavior undefined. */
2567 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002568 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002569
Gilles Peskined223b522018-06-11 18:12:58 +02002570 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2571 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002572 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002573 ipad[i] ^= 0x36;
2574 memset( ipad + key_length, 0x36, block_size - key_length );
2575
2576 /* Copy the key material from ipad to opad, flipping the requisite bits,
2577 * and filling the rest of opad with the requisite constant. */
2578 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002579 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2580 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002581
Gilles Peskine01126fa2018-07-12 17:04:55 +02002582 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002583 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002584 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002585
Gilles Peskine01126fa2018-07-12 17:04:55 +02002586 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002587
2588cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002589 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002590
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002591 return( status );
2592}
John Durkop6ba40d12020-11-10 08:50:04 -08002593#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002594
Gilles Peskine89167cb2018-07-08 20:12:23 +02002595static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002596 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002597 psa_algorithm_t alg,
2598 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002599{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002600 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002601 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002602 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002603 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002604 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002606 /* A context must be freshly initialized before it can be set up. */
2607 if( operation->alg != 0 )
2608 {
2609 return( PSA_ERROR_BAD_STATE );
2610 }
2611
Steven Cooreman15472f82021-03-02 16:16:22 +01002612 status = psa_mac_init( operation, alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002613 if( status != PSA_SUCCESS )
2614 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002615 if( is_sign )
2616 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002617
Ronald Cron5c522922020-11-14 16:35:34 +01002618 status = psa_get_and_lock_transparent_key_slot_with_policy(
2619 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002620 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002621 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002622
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002623 /* Validate the combination of key type and algorithm */
2624 status = psa_mac_key_can_do( alg, slot->attr.type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002625 if( status != PSA_SUCCESS )
2626 goto exit;
2627
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002628 /* Get the output length for the algorithm and key combination. None of the
2629 * currently supported algorithms have an output length dependent on actual
2630 * key size, so setting it to a bogus value is currently OK. */
2631 operation->mac_size = PSA_MAC_LENGTH( slot->attr.type, 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002632
2633 if( operation->mac_size < 4 )
2634 {
2635 /* A very short MAC is too short for security since it can be
2636 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2637 * so we make this our minimum, even though 32 bits is still
2638 * too small for security. */
2639 status = PSA_ERROR_NOT_SUPPORTED;
2640 goto exit;
2641 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002642
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002643 if( operation->mac_size >
2644 PSA_MAC_LENGTH( slot->attr.type, 0, PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
2645 {
2646 /* It's impossible to "truncate" to a larger length than the full length
2647 * of the algorithm. */
2648 status = PSA_ERROR_INVALID_ARGUMENT;
2649 goto exit;
2650 }
2651
Gilles Peskine8c9def32018-02-08 10:02:12 +01002652#if defined(MBEDTLS_CMAC_C)
Steven Cooreman15472f82021-03-02 16:16:22 +01002653 if( PSA_ALG_FULL_LENGTH_MAC( alg ) == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002654 {
Steven Cooreman15472f82021-03-02 16:16:22 +01002655 status = psa_cmac_setup( operation, slot );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002656 }
2657 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002659#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Steven Cooreman15472f82021-03-02 16:16:22 +01002660 if( PSA_ALG_IS_HMAC( alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002661 {
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002662 /* Sanity check. This shouldn't fail on a valid configuration. */
Steven Cooreman1fb691a2021-03-08 12:01:55 +01002663 if( operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002664 {
2665 status = PSA_ERROR_NOT_SUPPORTED;
2666 goto exit;
2667 }
2668
Gilles Peskine8e338702019-07-30 20:06:31 +02002669 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002670 {
2671 status = PSA_ERROR_INVALID_ARGUMENT;
2672 goto exit;
2673 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002674
Gilles Peskine01126fa2018-07-12 17:04:55 +02002675 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002676 slot->key.data,
2677 slot->key.bytes,
Steven Cooreman15472f82021-03-02 16:16:22 +01002678 PSA_ALG_HMAC_GET_HASH( alg ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002679 }
2680 else
John Durkopd0321952020-10-29 21:37:36 -07002681#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002682 {
2683 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002684 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002685
Gilles Peskinefbfac682018-07-08 20:51:54 +02002686exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002687 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002688 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002689 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002690 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002691 else
2692 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002693 operation->key_set = 1;
2694 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002695
Ronald Cron5c522922020-11-14 16:35:34 +01002696 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002697
Ronald Cron5c522922020-11-14 16:35:34 +01002698 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002699}
2700
Gilles Peskine89167cb2018-07-08 20:12:23 +02002701psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002702 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002703 psa_algorithm_t alg )
2704{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002705 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002706}
2707
2708psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002709 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002710 psa_algorithm_t alg )
2711{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002712 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002713}
2714
Gilles Peskine8c9def32018-02-08 10:02:12 +01002715psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2716 const uint8_t *input,
2717 size_t input_length )
2718{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002719 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002720 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002721 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002722 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002723 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002724 operation->has_input = 1;
2725
Gilles Peskine8c9def32018-02-08 10:02:12 +01002726#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002727 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002728 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002729 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2730 input, input_length );
2731 status = mbedtls_to_psa_error( ret );
2732 }
2733 else
2734#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002735#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002736 if( PSA_ALG_IS_HMAC( operation->alg ) )
2737 {
2738 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2739 input_length );
2740 }
2741 else
John Durkopd0321952020-10-29 21:37:36 -07002742#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002743 {
2744 /* This shouldn't happen if `operation` was initialized by
2745 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002746 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002747 }
2748
Gilles Peskinefbfac682018-07-08 20:51:54 +02002749 if( status != PSA_SUCCESS )
2750 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002751 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002752}
2753
John Durkop6ba40d12020-11-10 08:50:04 -08002754#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002755static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2756 uint8_t *mac,
2757 size_t mac_size )
2758{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002759 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Steven Cooreman0e307642021-02-18 16:18:32 +01002760 psa_algorithm_t hash_alg = hmac->alg;
Gilles Peskine01126fa2018-07-12 17:04:55 +02002761 size_t hash_size = 0;
2762 size_t block_size = psa_get_hash_block_size( hash_alg );
2763 psa_status_t status;
2764
Gilles Peskine01126fa2018-07-12 17:04:55 +02002765 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2766 if( status != PSA_SUCCESS )
2767 return( status );
2768 /* From here on, tmp needs to be wiped. */
2769
2770 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2771 if( status != PSA_SUCCESS )
2772 goto exit;
2773
2774 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2775 if( status != PSA_SUCCESS )
2776 goto exit;
2777
2778 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2779 if( status != PSA_SUCCESS )
2780 goto exit;
2781
Gilles Peskined911eb72018-08-14 15:18:45 +02002782 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2783 if( status != PSA_SUCCESS )
2784 goto exit;
2785
2786 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002787
2788exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002789 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002790 return( status );
2791}
John Durkop6ba40d12020-11-10 08:50:04 -08002792#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002793
mohammad16036df908f2018-04-02 08:34:15 -07002794static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002795 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002796 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002797{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002798 if( ! operation->key_set )
2799 return( PSA_ERROR_BAD_STATE );
2800 if( operation->iv_required && ! operation->iv_set )
2801 return( PSA_ERROR_BAD_STATE );
2802
Gilles Peskine8c9def32018-02-08 10:02:12 +01002803 if( mac_size < operation->mac_size )
2804 return( PSA_ERROR_BUFFER_TOO_SMALL );
2805
Gilles Peskine8c9def32018-02-08 10:02:12 +01002806#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002807 if( operation->alg == PSA_ALG_CMAC )
2808 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002809 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02002810 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
2811 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02002812 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01002813 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002814 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002815 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02002816 else
2817#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002818#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002819 if( PSA_ALG_IS_HMAC( operation->alg ) )
2820 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002821 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02002822 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002823 }
2824 else
John Durkopd0321952020-10-29 21:37:36 -07002825#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002826 {
2827 /* This shouldn't happen if `operation` was initialized by
2828 * a setup function. */
2829 return( PSA_ERROR_BAD_STATE );
2830 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002831}
2832
Gilles Peskineacd4be32018-07-08 19:56:25 +02002833psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
2834 uint8_t *mac,
2835 size_t mac_size,
2836 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002837{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002838 psa_status_t status;
2839
Jaeden Amero252ef282019-02-15 14:05:35 +00002840 if( operation->alg == 0 )
2841 {
2842 return( PSA_ERROR_BAD_STATE );
2843 }
2844
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002845 /* Fill the output buffer with something that isn't a valid mac
2846 * (barring an attack on the mac and deliberately-crafted input),
2847 * in case the caller doesn't check the return status properly. */
2848 *mac_length = mac_size;
2849 /* If mac_size is 0 then mac may be NULL and then the
2850 * call to memset would have undefined behavior. */
2851 if( mac_size != 0 )
2852 memset( mac, '!', mac_size );
2853
Gilles Peskine89167cb2018-07-08 20:12:23 +02002854 if( ! operation->is_sign )
2855 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002856 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002857 }
mohammad16036df908f2018-04-02 08:34:15 -07002858
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002859 status = psa_mac_finish_internal( operation, mac, mac_size );
2860
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002861 if( status == PSA_SUCCESS )
2862 {
2863 status = psa_mac_abort( operation );
2864 if( status == PSA_SUCCESS )
2865 *mac_length = operation->mac_size;
2866 else
2867 memset( mac, '!', mac_size );
2868 }
2869 else
2870 psa_mac_abort( operation );
2871 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07002872}
2873
Gilles Peskineacd4be32018-07-08 19:56:25 +02002874psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
2875 const uint8_t *mac,
2876 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002877{
Gilles Peskine828ed142018-06-18 23:25:51 +02002878 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07002879 psa_status_t status;
2880
Jaeden Amero252ef282019-02-15 14:05:35 +00002881 if( operation->alg == 0 )
2882 {
2883 return( PSA_ERROR_BAD_STATE );
2884 }
2885
Gilles Peskine89167cb2018-07-08 20:12:23 +02002886 if( operation->is_sign )
2887 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002888 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002889 }
2890 if( operation->mac_size != mac_length )
2891 {
2892 status = PSA_ERROR_INVALID_SIGNATURE;
2893 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002894 }
mohammad16036df908f2018-04-02 08:34:15 -07002895
2896 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002897 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01002898 if( status != PSA_SUCCESS )
2899 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002900
2901 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
2902 status = PSA_ERROR_INVALID_SIGNATURE;
2903
2904cleanup:
2905 if( status == PSA_SUCCESS )
2906 status = psa_mac_abort( operation );
2907 else
2908 psa_mac_abort( operation );
2909
Gilles Peskine3f108122018-12-07 18:14:53 +01002910 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02002911
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002912 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002913}
2914
2915
Gilles Peskine20035e32018-02-03 22:44:14 +01002916
Gilles Peskine20035e32018-02-03 22:44:14 +01002917/****************************************************************/
2918/* Asymmetric cryptography */
2919/****************************************************************/
2920
Ronald Cron67b1eb32020-12-08 17:37:27 +01002921psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002922 const psa_key_attributes_t *attributes,
2923 const uint8_t *key_buffer, size_t key_buffer_size,
2924 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2925 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002926{
Gilles Peskine20035e32018-02-03 22:44:14 +01002927#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2928 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01002929 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002930 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01002931 return( mbedtls_psa_rsa_sign_hash(
2932 attributes,
2933 key_buffer, key_buffer_size,
2934 alg, hash, hash_length,
2935 signature, signature_size, signature_length ) );
Gilles Peskine20035e32018-02-03 22:44:14 +01002936 }
2937 else
Gilles Peskine20035e32018-02-03 22:44:14 +01002938#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2939 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002940#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2941 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Ronald Cronbb9cbc72021-03-04 17:09:00 +01002942 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01002943 {
Ronald Cron9103d492021-03-04 11:26:03 +01002944 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002945 {
Ronald Cron072722c2020-12-09 16:36:19 +01002946 return( mbedtls_psa_ecdsa_sign_hash(
2947 attributes,
2948 key_buffer, key_buffer_size,
2949 alg, hash, hash_length,
2950 signature, signature_size, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02002951 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002952 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002953 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002954 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002955 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002956 }
2957 else
Gilles Peskinee59236f2018-01-27 23:32:46 +01002958#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2959 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
itayzafrir5c753392018-05-08 11:18:38 +03002960 {
Ronald Cronbb9cbc72021-03-04 17:09:00 +01002961 (void)attributes;
Ronald Cron8a494f32021-02-17 09:49:51 +01002962 (void)key_buffer;
2963 (void)key_buffer_size;
2964 (void)alg;
2965 (void)hash;
2966 (void)hash_length;
2967 (void)signature;
2968 (void)signature_size;
2969 (void)signature_length;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002970
Ronald Cron8a494f32021-02-17 09:49:51 +01002971 return( PSA_ERROR_NOT_SUPPORTED );
2972 }
Ronald Cron18659932020-12-08 16:32:23 +01002973}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002974
2975psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2976 psa_algorithm_t alg,
2977 const uint8_t *hash,
2978 size_t hash_length,
2979 uint8_t *signature,
2980 size_t signature_size,
2981 size_t *signature_length )
2982{
2983 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2984 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2985 psa_key_slot_t *slot;
2986
2987 *signature_length = signature_size;
2988 /* Immediately reject a zero-length signature buffer. This guarantees
2989 * that signature must be a valid pointer. (On the other hand, the hash
2990 * buffer can in principle be empty since it doesn't actually have
2991 * to be a hash.) */
2992 if( signature_size == 0 )
2993 return( PSA_ERROR_BUFFER_TOO_SMALL );
2994
2995 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
2996 PSA_KEY_USAGE_SIGN_HASH,
2997 alg );
2998 if( status != PSA_SUCCESS )
2999 goto exit;
3000 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
3001 {
3002 status = PSA_ERROR_INVALID_ARGUMENT;
3003 goto exit;
3004 }
3005
Ronald Cron9f17aa42020-12-08 17:07:25 +01003006 psa_key_attributes_t attributes = {
3007 .core = slot->attr
3008 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003009
Ronald Cron9f17aa42020-12-08 17:07:25 +01003010 status = psa_driver_wrapper_sign_hash(
3011 &attributes, slot->key.data, slot->key.bytes,
3012 alg, hash, hash_length,
3013 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003014
3015exit:
3016 /* Fill the unused part of the output buffer (the whole buffer on error,
3017 * the trailing part on success) with something that isn't a valid mac
3018 * (barring an attack on the mac and deliberately-crafted input),
3019 * in case the caller doesn't check the return status properly. */
3020 if( status == PSA_SUCCESS )
3021 memset( signature + *signature_length, '!',
3022 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003023 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003024 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003025 /* If signature_size is 0 then we have nothing to do. We must not call
3026 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003027
Ronald Cron5c522922020-11-14 16:35:34 +01003028 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003029
Ronald Cron5c522922020-11-14 16:35:34 +01003030 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003031}
3032
Ronald Cron67b1eb32020-12-08 17:37:27 +01003033psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01003034 const psa_key_attributes_t *attributes,
3035 const uint8_t *key_buffer, size_t key_buffer_size,
3036 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3037 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003038{
John Durkop6ba40d12020-11-10 08:50:04 -08003039#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3040 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Ronald Cron99b8ed72021-02-17 10:33:32 +01003041 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003042 {
Ronald Cron7bdbca32020-12-09 13:34:54 +01003043 return( mbedtls_psa_rsa_verify_hash(
3044 attributes,
3045 key_buffer, key_buffer_size,
3046 alg, hash, hash_length,
3047 signature, signature_length ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003048 }
3049 else
John Durkop6ba40d12020-11-10 08:50:04 -08003050#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3051 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Ronald Cron99b8ed72021-02-17 10:33:32 +01003052 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003053 {
John Durkop9814fa22020-11-04 12:28:15 -08003054#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3055 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003056 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003057 {
Ronald Cron072722c2020-12-09 16:36:19 +01003058 return( mbedtls_psa_ecdsa_verify_hash(
3059 attributes,
3060 key_buffer, key_buffer_size,
3061 alg, hash, hash_length,
3062 signature, signature_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003063 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003064 else
John Durkop9814fa22020-11-04 12:28:15 -08003065#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3066 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003067 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003068 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003069 }
itayzafrir5c753392018-05-08 11:18:38 +03003070 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003071 else
Gilles Peskinee59236f2018-01-27 23:32:46 +01003072 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003073 (void)key_buffer;
3074 (void)key_buffer_size;
3075 (void)alg;
3076 (void)hash;
3077 (void)hash_length;
3078 (void)signature;
3079 (void)signature_length;
Ronald Cronf95a2b12020-10-22 15:24:49 +02003080
Ronald Cron8a494f32021-02-17 09:49:51 +01003081 return( PSA_ERROR_NOT_SUPPORTED );
3082 }
Ronald Cron18659932020-12-08 16:32:23 +01003083}
3084
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003085psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3086 psa_algorithm_t alg,
3087 const uint8_t *hash,
3088 size_t hash_length,
3089 const uint8_t *signature,
3090 size_t signature_length )
3091{
3092 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3093 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003094 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003095
3096 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003098 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003099 if( status != PSA_SUCCESS )
3100 return( status );
3101
Ronald Cron9f17aa42020-12-08 17:07:25 +01003102 psa_key_attributes_t attributes = {
3103 .core = slot->attr
3104 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01003105
Ronald Cron9f17aa42020-12-08 17:07:25 +01003106 status = psa_driver_wrapper_verify_hash(
3107 &attributes, slot->key.data, slot->key.bytes,
3108 alg, hash, hash_length,
3109 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003110
Ronald Cron5c522922020-11-14 16:35:34 +01003111 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112
Ronald Cron5c522922020-11-14 16:35:34 +01003113 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003114}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115
John Durkop0e005192020-10-31 22:06:54 -07003116#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003117static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3118 mbedtls_rsa_context *rsa )
3119{
3120 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3121 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3122 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3123 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3124}
John Durkop0e005192020-10-31 22:06:54 -07003125#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003126
Ronald Croncf56a0a2020-08-04 09:51:30 +02003127psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003128 psa_algorithm_t alg,
3129 const uint8_t *input,
3130 size_t input_length,
3131 const uint8_t *salt,
3132 size_t salt_length,
3133 uint8_t *output,
3134 size_t output_size,
3135 size_t *output_length )
3136{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003137 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003138 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003139 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003140
Darryl Green5cc689a2018-07-24 15:34:10 +01003141 (void) input;
3142 (void) input_length;
3143 (void) salt;
3144 (void) output;
3145 (void) output_size;
3146
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003147 *output_length = 0;
3148
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003149 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3150 return( PSA_ERROR_INVALID_ARGUMENT );
3151
Ronald Cron5c522922020-11-14 16:35:34 +01003152 status = psa_get_and_lock_transparent_key_slot_with_policy(
3153 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003154 if( status != PSA_SUCCESS )
3155 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003156 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3157 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003158 {
3159 status = PSA_ERROR_INVALID_ARGUMENT;
3160 goto exit;
3161 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162
John Durkop6ba40d12020-11-10 08:50:04 -08003163#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3164 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003165 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003167 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003168 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3169 slot->key.data,
3170 slot->key.bytes,
3171 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003172 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003173 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003174
3175 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003176 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003177 status = PSA_ERROR_BUFFER_TOO_SMALL;
3178 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003179 }
John Durkop0e005192020-10-31 22:06:54 -07003180#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3182 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003183 status = mbedtls_to_psa_error(
3184 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003185 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003186 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003187 MBEDTLS_RSA_PUBLIC,
3188 input_length,
3189 input,
3190 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003191 }
3192 else
John Durkop0e005192020-10-31 22:06:54 -07003193#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3194#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003195 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3196 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003197 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003198 status = mbedtls_to_psa_error(
3199 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003200 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003201 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003202 MBEDTLS_RSA_PUBLIC,
3203 salt, salt_length,
3204 input_length,
3205 input,
3206 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003207 }
3208 else
John Durkop0e005192020-10-31 22:06:54 -07003209#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003211 status = PSA_ERROR_INVALID_ARGUMENT;
3212 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003213 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003214rsa_exit:
3215 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003216 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003217
Steven Cooremana2371e52020-07-28 14:30:39 +02003218 mbedtls_rsa_free( rsa );
3219 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003220 }
3221 else
John Durkop9814fa22020-11-04 12:28:15 -08003222#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003223 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003224 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003225 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003226 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003227
3228exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003229 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003230
Ronald Cron5c522922020-11-14 16:35:34 +01003231 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003232}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003233
Ronald Croncf56a0a2020-08-04 09:51:30 +02003234psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003235 psa_algorithm_t alg,
3236 const uint8_t *input,
3237 size_t input_length,
3238 const uint8_t *salt,
3239 size_t salt_length,
3240 uint8_t *output,
3241 size_t output_size,
3242 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003243{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003245 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003246 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003247
Darryl Green5cc689a2018-07-24 15:34:10 +01003248 (void) input;
3249 (void) input_length;
3250 (void) salt;
3251 (void) output;
3252 (void) output_size;
3253
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003254 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003255
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003256 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3257 return( PSA_ERROR_INVALID_ARGUMENT );
3258
Ronald Cron5c522922020-11-14 16:35:34 +01003259 status = psa_get_and_lock_transparent_key_slot_with_policy(
3260 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003261 if( status != PSA_SUCCESS )
3262 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003263 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003264 {
3265 status = PSA_ERROR_INVALID_ARGUMENT;
3266 goto exit;
3267 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003268
John Durkop6ba40d12020-11-10 08:50:04 -08003269#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3270 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003271 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003272 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003273 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003274 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3275 slot->key.data,
3276 slot->key.bytes,
3277 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003278 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003279 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003280
Steven Cooremana2371e52020-07-28 14:30:39 +02003281 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003282 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003283 status = PSA_ERROR_INVALID_ARGUMENT;
3284 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003285 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003286
John Durkop0e005192020-10-31 22:06:54 -07003287#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003288 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003289 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003290 status = mbedtls_to_psa_error(
3291 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003292 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003293 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003294 MBEDTLS_RSA_PRIVATE,
3295 output_length,
3296 input,
3297 output,
3298 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003299 }
3300 else
John Durkop0e005192020-10-31 22:06:54 -07003301#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3302#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003303 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003304 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003305 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003306 status = mbedtls_to_psa_error(
3307 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003308 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003309 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003310 MBEDTLS_RSA_PRIVATE,
3311 salt, salt_length,
3312 output_length,
3313 input,
3314 output,
3315 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003316 }
3317 else
John Durkop0e005192020-10-31 22:06:54 -07003318#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003319 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003320 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003321 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003322
Steven Cooreman4fed4552020-08-03 14:46:03 +02003323rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003324 mbedtls_rsa_free( rsa );
3325 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003326 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003327 else
John Durkop6ba40d12020-11-10 08:50:04 -08003328#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3329 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003330 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003331 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003332 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003333
3334exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003335 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003336
Ronald Cron5c522922020-11-14 16:35:34 +01003337 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003338}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003339
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003340
3341
mohammad1603503973b2018-03-12 15:59:30 +02003342/****************************************************************/
3343/* Symmetric cryptography */
3344/****************************************************************/
3345
Gilles Peskinee553c652018-06-04 16:22:46 +02003346static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003347 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003348 psa_algorithm_t alg,
3349 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003350{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003352 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003353 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003354 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003355 size_t key_bits;
3356 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003357 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3358 PSA_KEY_USAGE_ENCRYPT :
3359 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003360
Steven Cooremand3feccd2020-09-01 15:56:14 +02003361 /* A context must be freshly initialized before it can be set up. */
3362 if( operation->alg != 0 )
3363 return( PSA_ERROR_BAD_STATE );
3364
Steven Cooremana07b9972020-09-10 14:54:14 +02003365 /* The requested algorithm must be one that can be processed by cipher. */
3366 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003367 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003368
Steven Cooremanef8575e2020-09-11 11:44:50 +02003369 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003370 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003371 if( status != PSA_SUCCESS )
3372 goto exit;
3373
3374 /* Initialize the operation struct members, except for alg. The alg member
3375 * is used to indicate to psa_cipher_abort that there are resources to free,
3376 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003377 operation->key_set = 0;
3378 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003379 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003380 operation->iv_size = 0;
3381 operation->block_size = 0;
3382 if( alg == PSA_ALG_ECB_NO_PADDING )
3383 operation->iv_required = 0;
3384 else
3385 operation->iv_required = 1;
3386
Steven Cooremana07b9972020-09-10 14:54:14 +02003387 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003388 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003389 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003390 slot,
3391 alg );
3392 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003393 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003394 slot,
3395 alg );
3396
Steven Cooremanef8575e2020-09-11 11:44:50 +02003397 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003398 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003399 /* Once the driver context is initialised, it needs to be freed using
3400 * psa_cipher_abort. Indicate this through setting alg. */
3401 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003402 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003403
Steven Cooremand3feccd2020-09-01 15:56:14 +02003404 if( status != PSA_ERROR_NOT_SUPPORTED ||
3405 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3406 goto exit;
3407
Steven Cooremana07b9972020-09-10 14:54:14 +02003408 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003409 * available for the given algorithm & key. */
3410 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003411
Steven Cooremana07b9972020-09-10 14:54:14 +02003412 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003413 * psa_cipher_abort. Indicate there is something to be freed through setting
3414 * alg, and indicate the operation is being done using mbedtls crypto through
3415 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003416 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003417 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02003418
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003419 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02003420 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003421 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003422 {
3423 status = PSA_ERROR_NOT_SUPPORTED;
3424 goto exit;
3425 }
mohammad1603503973b2018-03-12 15:59:30 +02003426
mohammad1603503973b2018-03-12 15:59:30 +02003427 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003428 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003429 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003430
David Brown12ca5032021-02-11 11:02:00 -07003431#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003432 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003433 {
3434 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003435 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01003436 memcpy( keys, slot->key.data, 16 );
3437 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003438 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3439 keys,
3440 192, cipher_operation );
3441 }
3442 else
3443#endif
3444 {
3445 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003446 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003447 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003448 }
Moran Peker41deec42018-04-04 15:43:05 +03003449 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003450 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003451
David Brown63ca2602021-01-26 11:51:12 -07003452#if defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
3453 defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003454 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003455 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003456 case PSA_ALG_CBC_NO_PADDING:
3457 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3458 MBEDTLS_PADDING_NONE );
3459 break;
3460 case PSA_ALG_CBC_PKCS7:
3461 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3462 MBEDTLS_PADDING_PKCS7 );
3463 break;
3464 default:
3465 /* The algorithm doesn't involve padding. */
3466 ret = 0;
3467 break;
3468 }
3469 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003470 goto exit;
David Brown288a96e2021-02-09 16:27:55 -07003471#endif /* MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING || MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7 */
mohammad16038481e742018-03-18 13:57:31 +02003472
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003473 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003474 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02003475 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
3476 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02003477 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003478 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003479 }
David Brown1bfe4d72021-02-16 12:54:35 -07003480#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +02003481 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01003482 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02003483 operation->iv_size = 12;
3484#endif
mohammad1603503973b2018-03-12 15:59:30 +02003485
Steven Cooreman7df02922020-09-09 15:28:49 +02003486 status = PSA_SUCCESS;
3487
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003488exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003489 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003490 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02003491 if( status == PSA_SUCCESS )
3492 {
3493 /* Update operation flags for both driver and software implementations */
3494 operation->key_set = 1;
3495 }
3496 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003497 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003498
Ronald Cron5c522922020-11-14 16:35:34 +01003499 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003500
Ronald Cron5c522922020-11-14 16:35:34 +01003501 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003502}
3503
Gilles Peskinefe119512018-07-08 21:39:34 +02003504psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003505 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003506 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003507{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003508 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003509}
3510
Gilles Peskinefe119512018-07-08 21:39:34 +02003511psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003512 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003513 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003514{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003515 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003516}
3517
Gilles Peskinefe119512018-07-08 21:39:34 +02003518psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003519 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003520 size_t iv_size,
3521 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003522{
itayzafrir534bd7c2018-08-02 13:56:32 +03003523 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003524 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003525 if( operation->iv_set || ! operation->iv_required )
3526 {
3527 return( PSA_ERROR_BAD_STATE );
3528 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003529
Steven Cooremanef8575e2020-09-11 11:44:50 +02003530 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003531 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003532 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003533 iv,
3534 iv_size,
3535 iv_length );
3536 goto exit;
3537 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003538
Moran Peker41deec42018-04-04 15:43:05 +03003539 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02003540 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003541 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03003542 goto exit;
3543 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003544 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003545 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03003546 if( ret != 0 )
3547 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003548 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02003549 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003550 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003551
mohammad16038481e742018-03-18 13:57:31 +02003552 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03003553 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03003554
Moran Peker395db872018-05-31 14:07:14 +03003555exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003556 if( status == PSA_SUCCESS )
3557 operation->iv_set = 1;
3558 else
Moran Peker395db872018-05-31 14:07:14 +03003559 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003560 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003561}
3562
Gilles Peskinefe119512018-07-08 21:39:34 +02003563psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003564 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003565 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003566{
itayzafrir534bd7c2018-08-02 13:56:32 +03003567 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003568 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02003569 if( operation->iv_set || ! operation->iv_required )
3570 {
3571 return( PSA_ERROR_BAD_STATE );
3572 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003573
Steven Cooremanef8575e2020-09-11 11:44:50 +02003574 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003575 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003576 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003577 iv,
3578 iv_length );
3579 goto exit;
3580 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003581
Moran Pekera28258c2018-05-29 16:25:04 +03003582 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03003583 {
itayzafrir534bd7c2018-08-02 13:56:32 +03003584 status = PSA_ERROR_INVALID_ARGUMENT;
3585 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03003586 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003587 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
3588 status = mbedtls_to_psa_error( ret );
3589exit:
3590 if( status == PSA_SUCCESS )
3591 operation->iv_set = 1;
3592 else
mohammad1603503973b2018-03-12 15:59:30 +02003593 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003594 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003595}
3596
Steven Cooreman177deba2020-09-07 17:14:14 +02003597/* Process input for which the algorithm is set to ECB mode. This requires
3598 * manual processing, since the PSA API is defined as being able to process
3599 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
3600 * underlying mbedtls_cipher_update only takes full blocks. */
3601static psa_status_t psa_cipher_update_ecb_internal(
3602 mbedtls_cipher_context_t *ctx,
3603 const uint8_t *input,
3604 size_t input_length,
3605 uint8_t *output,
3606 size_t output_size,
3607 size_t *output_length )
3608{
3609 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3610 size_t block_size = ctx->cipher_info->block_size;
3611 size_t internal_output_length = 0;
3612 *output_length = 0;
3613
3614 if( input_length == 0 )
3615 {
3616 status = PSA_SUCCESS;
3617 goto exit;
3618 }
3619
3620 if( ctx->unprocessed_len > 0 )
3621 {
3622 /* Fill up to block size, and run the block if there's a full one. */
3623 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
3624
3625 if( input_length < bytes_to_copy )
3626 bytes_to_copy = input_length;
3627
3628 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3629 input, bytes_to_copy );
3630 input_length -= bytes_to_copy;
3631 input += bytes_to_copy;
3632 ctx->unprocessed_len += bytes_to_copy;
3633
3634 if( ctx->unprocessed_len == block_size )
3635 {
3636 status = mbedtls_to_psa_error(
3637 mbedtls_cipher_update( ctx,
3638 ctx->unprocessed_data,
3639 block_size,
3640 output, &internal_output_length ) );
3641
3642 if( status != PSA_SUCCESS )
3643 goto exit;
3644
3645 output += internal_output_length;
3646 output_size -= internal_output_length;
3647 *output_length += internal_output_length;
3648 ctx->unprocessed_len = 0;
3649 }
3650 }
3651
3652 while( input_length >= block_size )
3653 {
3654 /* Run all full blocks we have, one by one */
3655 status = mbedtls_to_psa_error(
3656 mbedtls_cipher_update( ctx, input,
3657 block_size,
3658 output, &internal_output_length ) );
3659
3660 if( status != PSA_SUCCESS )
3661 goto exit;
3662
3663 input_length -= block_size;
3664 input += block_size;
3665
3666 output += internal_output_length;
3667 output_size -= internal_output_length;
3668 *output_length += internal_output_length;
3669 }
3670
3671 if( input_length > 0 )
3672 {
3673 /* Save unprocessed bytes for later processing */
3674 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
3675 input, input_length );
3676 ctx->unprocessed_len += input_length;
3677 }
3678
3679 status = PSA_SUCCESS;
3680
3681exit:
3682 return( status );
3683}
3684
Gilles Peskinee553c652018-06-04 16:22:46 +02003685psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3686 const uint8_t *input,
3687 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003688 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003689 size_t output_size,
3690 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003691{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003692 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02003693 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02003694 if( operation->alg == 0 )
3695 {
3696 return( PSA_ERROR_BAD_STATE );
3697 }
3698 if( operation->iv_required && ! operation->iv_set )
3699 {
3700 return( PSA_ERROR_BAD_STATE );
3701 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003702
Steven Cooremanef8575e2020-09-11 11:44:50 +02003703 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003704 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003705 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003706 input,
3707 input_length,
3708 output,
3709 output_size,
3710 output_length );
3711 goto exit;
3712 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003713
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003714 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02003715 {
3716 /* Take the unprocessed partial block left over from previous
3717 * update calls, if any, plus the input to this call. Remove
3718 * the last partial block, if any. You get the data that will be
3719 * output in this call. */
3720 expected_output_size =
3721 ( operation->ctx.cipher.unprocessed_len + input_length )
3722 / operation->block_size * operation->block_size;
3723 }
3724 else
3725 {
3726 expected_output_size = input_length;
3727 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003728
Gilles Peskine89d789c2018-06-04 17:17:16 +02003729 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03003730 {
3731 status = PSA_ERROR_BUFFER_TOO_SMALL;
3732 goto exit;
3733 }
mohammad160382759612018-03-12 18:16:40 +02003734
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003735 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
3736 {
3737 /* mbedtls_cipher_update has an API inconsistency: it will only
3738 * process a single block at a time in ECB mode. Abstract away that
3739 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02003740 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
3741 input,
3742 input_length,
3743 output,
3744 output_size,
3745 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003746 }
3747 else
3748 {
3749 status = mbedtls_to_psa_error(
3750 mbedtls_cipher_update( &operation->ctx.cipher, input,
3751 input_length, output, output_length ) );
3752 }
itayzafrir534bd7c2018-08-02 13:56:32 +03003753exit:
3754 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003755 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003756 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003757}
3758
Gilles Peskinee553c652018-06-04 16:22:46 +02003759psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3760 uint8_t *output,
3761 size_t output_size,
3762 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003763{
David Saadab4ecc272019-02-14 13:48:10 +02003764 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02003765 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02003766 if( operation->alg == 0 )
3767 {
3768 return( PSA_ERROR_BAD_STATE );
3769 }
3770 if( operation->iv_required && ! operation->iv_set )
3771 {
3772 return( PSA_ERROR_BAD_STATE );
3773 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003774
Steven Cooremanef8575e2020-09-11 11:44:50 +02003775 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02003776 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003777 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02003778 output,
3779 output_size,
3780 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003781 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02003782 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003783
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003784 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03003785 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003786 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02003787 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02003788 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003789 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003790 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02003791 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003792 }
3793
Steven Cooremanef8575e2020-09-11 11:44:50 +02003794 status = mbedtls_to_psa_error(
3795 mbedtls_cipher_finish( &operation->ctx.cipher,
3796 temp_output_buffer,
3797 output_length ) );
3798 if( status != PSA_SUCCESS )
3799 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01003800
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003801 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01003802 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003803 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03003804 memcpy( output, temp_output_buffer, *output_length );
3805 else
Janos Follath315b51c2018-07-09 16:04:51 +01003806 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02003807
Steven Cooremanef8575e2020-09-11 11:44:50 +02003808exit:
3809 if( operation->mbedtls_in_use == 1 )
3810 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01003811
Steven Cooremanef8575e2020-09-11 11:44:50 +02003812 if( status == PSA_SUCCESS )
3813 return( psa_cipher_abort( operation ) );
3814 else
3815 {
3816 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003817 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003818
Steven Cooremanef8575e2020-09-11 11:44:50 +02003819 return( status );
3820 }
mohammad1603503973b2018-03-12 15:59:30 +02003821}
3822
Gilles Peskinee553c652018-06-04 16:22:46 +02003823psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3824{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003825 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003826 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003827 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003828 * in use. It's ok to call abort on such an object, and there's
3829 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003830 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003831 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003832
Gilles Peskinef9c2c092018-06-21 16:57:07 +02003833 /* Sanity check (shouldn't happen: operation->alg should
3834 * always have been initialized to a valid value). */
3835 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
3836 return( PSA_ERROR_BAD_STATE );
3837
Steven Cooremanef8575e2020-09-11 11:44:50 +02003838 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003839 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003840 else
3841 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02003842
Moran Peker41deec42018-04-04 15:43:05 +03003843 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003844 operation->key_set = 0;
3845 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003846 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003847 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003848 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003849 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003850
Moran Peker395db872018-05-31 14:07:14 +03003851 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003852}
3853
Gilles Peskinea0655c32018-04-30 17:06:50 +02003854
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003855
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003856
mohammad16035955c982018-04-26 00:53:03 +03003857/****************************************************************/
3858/* AEAD */
3859/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003860
Gilles Peskineedf9a652018-08-17 18:11:56 +02003861typedef struct
3862{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003863 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003864 const mbedtls_cipher_info_t *cipher_info;
3865 union
3866 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003867 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003868#if defined(MBEDTLS_CCM_C)
3869 mbedtls_ccm_context ccm;
3870#endif /* MBEDTLS_CCM_C */
3871#if defined(MBEDTLS_GCM_C)
3872 mbedtls_gcm_context gcm;
3873#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02003874#if defined(MBEDTLS_CHACHAPOLY_C)
3875 mbedtls_chachapoly_context chachapoly;
3876#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02003877 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003878 psa_algorithm_t core_alg;
3879 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003880 uint8_t tag_length;
3881} aead_operation_t;
3882
Ronald Cronf95a2b12020-10-22 15:24:49 +02003883#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
3884
Gilles Peskine30a9e412019-01-14 18:36:12 +01003885static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003886{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02003887 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003888 {
3889#if defined(MBEDTLS_CCM_C)
3890 case PSA_ALG_CCM:
3891 mbedtls_ccm_free( &operation->ctx.ccm );
3892 break;
3893#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01003894#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02003895 case PSA_ALG_GCM:
3896 mbedtls_gcm_free( &operation->ctx.gcm );
3897 break;
3898#endif /* MBEDTLS_GCM_C */
3899 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003900
Ronald Cron5c522922020-11-14 16:35:34 +01003901 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003902}
3903
3904static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003905 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003906 psa_key_usage_t usage,
3907 psa_algorithm_t alg )
3908{
3909 psa_status_t status;
3910 size_t key_bits;
3911 mbedtls_cipher_id_t cipher_id;
3912
Ronald Cron5c522922020-11-14 16:35:34 +01003913 status = psa_get_and_lock_transparent_key_slot_with_policy(
3914 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003915 if( status != PSA_SUCCESS )
3916 return( status );
3917
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003918 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02003919
3920 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02003921 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003922 &cipher_id );
3923 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003924 {
3925 status = PSA_ERROR_NOT_SUPPORTED;
3926 goto cleanup;
3927 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003928
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003929 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02003930 {
3931#if defined(MBEDTLS_CCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003932 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003933 operation->core_alg = PSA_ALG_CCM;
3934 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003935 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
3936 * The call to mbedtls_ccm_encrypt_and_tag or
3937 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003938 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003939 {
3940 status = PSA_ERROR_INVALID_ARGUMENT;
3941 goto cleanup;
3942 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003943 mbedtls_ccm_init( &operation->ctx.ccm );
3944 status = mbedtls_to_psa_error(
3945 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003946 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003947 (unsigned int) key_bits ) );
3948 if( status != 0 )
3949 goto cleanup;
3950 break;
3951#endif /* MBEDTLS_CCM_C */
3952
3953#if defined(MBEDTLS_GCM_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003954 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003955 operation->core_alg = PSA_ALG_GCM;
3956 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003957 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
3958 * The call to mbedtls_gcm_crypt_and_tag or
3959 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003960 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003961 {
3962 status = PSA_ERROR_INVALID_ARGUMENT;
3963 goto cleanup;
3964 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02003965 mbedtls_gcm_init( &operation->ctx.gcm );
3966 status = mbedtls_to_psa_error(
3967 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003968 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02003969 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003970 if( status != 0 )
3971 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003972 break;
3973#endif /* MBEDTLS_GCM_C */
3974
Gilles Peskine26869f22019-05-06 15:25:00 +02003975#if defined(MBEDTLS_CHACHAPOLY_C)
Bence Szépkútia63b20d2020-12-16 11:36:46 +01003976 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
Gilles Peskine26869f22019-05-06 15:25:00 +02003977 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
3978 operation->full_tag_length = 16;
3979 /* We only support the default tag length. */
3980 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003981 {
3982 status = PSA_ERROR_NOT_SUPPORTED;
3983 goto cleanup;
3984 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003985 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
3986 status = mbedtls_to_psa_error(
3987 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003988 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02003989 if( status != 0 )
3990 goto cleanup;
3991 break;
3992#endif /* MBEDTLS_CHACHAPOLY_C */
3993
Gilles Peskineedf9a652018-08-17 18:11:56 +02003994 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02003995 status = PSA_ERROR_NOT_SUPPORTED;
3996 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02003997 }
3998
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02003999 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4000 {
4001 status = PSA_ERROR_INVALID_ARGUMENT;
4002 goto cleanup;
4003 }
4004 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004005
Gilles Peskineedf9a652018-08-17 18:11:56 +02004006 return( PSA_SUCCESS );
4007
4008cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004009 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004010 return( status );
4011}
4012
Ronald Croncf56a0a2020-08-04 09:51:30 +02004013psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004014 psa_algorithm_t alg,
4015 const uint8_t *nonce,
4016 size_t nonce_length,
4017 const uint8_t *additional_data,
4018 size_t additional_data_length,
4019 const uint8_t *plaintext,
4020 size_t plaintext_length,
4021 uint8_t *ciphertext,
4022 size_t ciphertext_size,
4023 size_t *ciphertext_length )
4024{
mohammad16035955c982018-04-26 00:53:03 +03004025 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004026 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004027 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004028
mohammad1603f08a5502018-06-03 15:05:47 +03004029 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004030
Ronald Croncf56a0a2020-08-04 09:51:30 +02004031 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004032 if( status != PSA_SUCCESS )
4033 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004034
Gilles Peskineedf9a652018-08-17 18:11:56 +02004035 /* For all currently supported modes, the tag is at the end of the
4036 * ciphertext. */
4037 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4038 {
4039 status = PSA_ERROR_BUFFER_TOO_SMALL;
4040 goto exit;
4041 }
4042 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004043
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004044#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004045 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004046 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004047 status = mbedtls_to_psa_error(
4048 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4049 MBEDTLS_GCM_ENCRYPT,
4050 plaintext_length,
4051 nonce, nonce_length,
4052 additional_data, additional_data_length,
4053 plaintext, ciphertext,
4054 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004055 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004056 else
4057#endif /* MBEDTLS_GCM_C */
4058#if defined(MBEDTLS_CCM_C)
4059 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004060 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004061 status = mbedtls_to_psa_error(
4062 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4063 plaintext_length,
4064 nonce, nonce_length,
4065 additional_data,
4066 additional_data_length,
4067 plaintext, ciphertext,
4068 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004069 }
mohammad16035c8845f2018-05-09 05:40:09 -07004070 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004071#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004072#if defined(MBEDTLS_CHACHAPOLY_C)
4073 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4074 {
4075 if( nonce_length != 12 || operation.tag_length != 16 )
4076 {
4077 status = PSA_ERROR_NOT_SUPPORTED;
4078 goto exit;
4079 }
4080 status = mbedtls_to_psa_error(
4081 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4082 plaintext_length,
4083 nonce,
4084 additional_data,
4085 additional_data_length,
4086 plaintext,
4087 ciphertext,
4088 tag ) );
4089 }
4090 else
4091#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004092 {
Steven Cooreman7196fef2021-02-10 17:13:28 +01004093 (void) tag;
mohammad1603554faad2018-06-03 15:07:38 +03004094 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004095 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004096
Gilles Peskineedf9a652018-08-17 18:11:56 +02004097 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4098 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004099
Gilles Peskineedf9a652018-08-17 18:11:56 +02004100exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004101 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004102 if( status == PSA_SUCCESS )
4103 *ciphertext_length = plaintext_length + operation.tag_length;
4104 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004105}
4106
Gilles Peskineee652a32018-06-01 19:23:52 +02004107/* Locate the tag in a ciphertext buffer containing the encrypted data
4108 * followed by the tag. Return the length of the part preceding the tag in
4109 * *plaintext_length. This is the size of the plaintext in modes where
4110 * the encrypted data has the same size as the plaintext, such as
4111 * CCM and GCM. */
4112static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4113 const uint8_t *ciphertext,
4114 size_t ciphertext_length,
4115 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004116 const uint8_t **p_tag )
4117{
4118 size_t payload_length;
4119 if( tag_length > ciphertext_length )
4120 return( PSA_ERROR_INVALID_ARGUMENT );
4121 payload_length = ciphertext_length - tag_length;
4122 if( payload_length > plaintext_size )
4123 return( PSA_ERROR_BUFFER_TOO_SMALL );
4124 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004125 return( PSA_SUCCESS );
4126}
4127
Ronald Croncf56a0a2020-08-04 09:51:30 +02004128psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004129 psa_algorithm_t alg,
4130 const uint8_t *nonce,
4131 size_t nonce_length,
4132 const uint8_t *additional_data,
4133 size_t additional_data_length,
4134 const uint8_t *ciphertext,
4135 size_t ciphertext_length,
4136 uint8_t *plaintext,
4137 size_t plaintext_size,
4138 size_t *plaintext_length )
4139{
mohammad16035955c982018-04-26 00:53:03 +03004140 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004141 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004142 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004143
Gilles Peskineee652a32018-06-01 19:23:52 +02004144 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004145
Ronald Croncf56a0a2020-08-04 09:51:30 +02004146 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004147 if( status != PSA_SUCCESS )
4148 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004149
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004150 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4151 ciphertext, ciphertext_length,
4152 plaintext_size, &tag );
4153 if( status != PSA_SUCCESS )
4154 goto exit;
4155
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004156#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004157 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004158 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004159 status = mbedtls_to_psa_error(
4160 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4161 ciphertext_length - operation.tag_length,
4162 nonce, nonce_length,
4163 additional_data,
4164 additional_data_length,
4165 tag, operation.tag_length,
4166 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004167 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004168 else
4169#endif /* MBEDTLS_GCM_C */
4170#if defined(MBEDTLS_CCM_C)
4171 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004172 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004173 status = mbedtls_to_psa_error(
4174 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4175 ciphertext_length - operation.tag_length,
4176 nonce, nonce_length,
4177 additional_data,
4178 additional_data_length,
4179 ciphertext, plaintext,
4180 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004181 }
mohammad160339574652018-06-01 04:39:53 -07004182 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004183#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004184#if defined(MBEDTLS_CHACHAPOLY_C)
4185 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4186 {
4187 if( nonce_length != 12 || operation.tag_length != 16 )
4188 {
4189 status = PSA_ERROR_NOT_SUPPORTED;
4190 goto exit;
4191 }
4192 status = mbedtls_to_psa_error(
4193 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4194 ciphertext_length - operation.tag_length,
4195 nonce,
4196 additional_data,
4197 additional_data_length,
4198 tag,
4199 ciphertext,
4200 plaintext ) );
4201 }
4202 else
4203#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004204 {
mohammad1603554faad2018-06-03 15:07:38 +03004205 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004206 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004207
Gilles Peskineedf9a652018-08-17 18:11:56 +02004208 if( status != PSA_SUCCESS && plaintext_size != 0 )
4209 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004210
Gilles Peskineedf9a652018-08-17 18:11:56 +02004211exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004212 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004213 if( status == PSA_SUCCESS )
4214 *plaintext_length = ciphertext_length - operation.tag_length;
4215 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004216}
4217
Gilles Peskinea0655c32018-04-30 17:06:50 +02004218
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004219
Gilles Peskinee59236f2018-01-27 23:32:46 +01004220/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004221/* Generators */
4222/****************************************************************/
4223
John Durkop07cc04a2020-11-16 22:08:34 -08004224#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4225 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4226 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4227#define AT_LEAST_ONE_BUILTIN_KDF
4228#endif
4229
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004230#define HKDF_STATE_INIT 0 /* no input yet */
4231#define HKDF_STATE_STARTED 1 /* got salt */
4232#define HKDF_STATE_KEYED 2 /* got key */
4233#define HKDF_STATE_OUTPUT 3 /* output started */
4234
Gilles Peskinecbe66502019-05-16 16:59:18 +02004235static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004236 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004237{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004238 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4239 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004240 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004241 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004242}
4243
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004244psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004245{
4246 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004247 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004248 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004249 {
4250 /* The object has (apparently) been initialized but it is not
4251 * in use. It's ok to call abort on such an object, and there's
4252 * nothing to do. */
4253 }
4254 else
John Durkopd0321952020-10-29 21:37:36 -07004255#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004256 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004257 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004258 mbedtls_free( operation->ctx.hkdf.info );
4259 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004260 }
John Durkop07cc04a2020-11-16 22:08:34 -08004261 else
4262#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4263#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4264 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4265 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004266 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004267 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004268 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004269 if( operation->ctx.tls12_prf.seed != NULL )
4270 {
4271 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4272 operation->ctx.tls12_prf.seed_length );
4273 mbedtls_free( operation->ctx.tls12_prf.seed );
4274 }
4275
4276 if( operation->ctx.tls12_prf.label != NULL )
4277 {
4278 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4279 operation->ctx.tls12_prf.label_length );
4280 mbedtls_free( operation->ctx.tls12_prf.label );
4281 }
4282
4283 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4284
4285 /* We leave the fields Ai and output_block to be erased safely by the
4286 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004287 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004288 else
John Durkop07cc04a2020-11-16 22:08:34 -08004289#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4290 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004291 {
4292 status = PSA_ERROR_BAD_STATE;
4293 }
Janos Follath083036a2019-06-11 10:22:26 +01004294 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004295 return( status );
4296}
4297
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004298psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004299 size_t *capacity)
4300{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004301 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004302 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004303 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004304 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004305 }
4306
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004307 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004308 return( PSA_SUCCESS );
4309}
4310
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004311psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004312 size_t capacity )
4313{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004314 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004315 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004316 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004317 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004318 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004319 return( PSA_SUCCESS );
4320}
4321
John Durkopd0321952020-10-29 21:37:36 -07004322#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004323/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004324 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004325static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004326 psa_algorithm_t hash_alg,
4327 uint8_t *output,
4328 size_t output_length )
4329{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004330 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004331 psa_status_t status;
4332
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004333 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4334 return( PSA_ERROR_BAD_STATE );
4335 hkdf->state = HKDF_STATE_OUTPUT;
4336
Gilles Peskinebef7f142018-07-12 17:22:21 +02004337 while( output_length != 0 )
4338 {
4339 /* Copy what remains of the current block */
4340 uint8_t n = hash_length - hkdf->offset_in_block;
4341 if( n > output_length )
4342 n = (uint8_t) output_length;
4343 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4344 output += n;
4345 output_length -= n;
4346 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004347 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004348 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004349 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004350 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004351 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004352 * object was corrupted or if this function is called directly
4353 * inside the library. */
4354 if( hkdf->block_number == 0xff )
4355 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004356
4357 /* We need a new block */
4358 ++hkdf->block_number;
4359 hkdf->offset_in_block = 0;
4360 status = psa_hmac_setup_internal( &hkdf->hmac,
4361 hkdf->prk, hash_length,
4362 hash_alg );
4363 if( status != PSA_SUCCESS )
4364 return( status );
4365 if( hkdf->block_number != 1 )
4366 {
4367 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4368 hkdf->output_block,
4369 hash_length );
4370 if( status != PSA_SUCCESS )
4371 return( status );
4372 }
4373 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4374 hkdf->info,
4375 hkdf->info_length );
4376 if( status != PSA_SUCCESS )
4377 return( status );
4378 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4379 &hkdf->block_number, 1 );
4380 if( status != PSA_SUCCESS )
4381 return( status );
4382 status = psa_hmac_finish_internal( &hkdf->hmac,
4383 hkdf->output_block,
4384 sizeof( hkdf->output_block ) );
4385 if( status != PSA_SUCCESS )
4386 return( status );
4387 }
4388
4389 return( PSA_SUCCESS );
4390}
John Durkop07cc04a2020-11-16 22:08:34 -08004391#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004392
John Durkop07cc04a2020-11-16 22:08:34 -08004393#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4394 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004395static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4396 psa_tls12_prf_key_derivation_t *tls12_prf,
4397 psa_algorithm_t alg )
4398{
4399 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004400 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004401 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4402 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004403
Janos Follath7742fee2019-06-17 12:58:10 +01004404 /* We can't be wanting more output after block 0xff, otherwise
4405 * the capacity check in psa_key_derivation_output_bytes() would have
4406 * prevented this call. It could happen only if the operation
4407 * object was corrupted or if this function is called directly
4408 * inside the library. */
4409 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004410 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004411
4412 /* We need a new block */
4413 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004414 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004415
4416 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4417 *
4418 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4419 *
4420 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4421 * HMAC_hash(secret, A(2) + seed) +
4422 * HMAC_hash(secret, A(3) + seed) + ...
4423 *
4424 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004425 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004426 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004427 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004428 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004429 * is currently extracted as `output_block` and where i is
4430 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004431 */
4432
Janos Follathea29bfb2019-06-19 12:21:20 +01004433 /* Save the hash context before using it, to preserve the hash state with
4434 * only the inner padding in it. We need this, because inner padding depends
4435 * on the key (secret in the RFC's terminology). */
4436 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4437 if( status != PSA_SUCCESS )
4438 goto cleanup;
4439
4440 /* Calculate A(i) where i = tls12_prf->block_number. */
4441 if( tls12_prf->block_number == 1 )
4442 {
4443 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4444 * the variable seed and in this instance means it in the context of the
4445 * P_hash function, where seed = label + seed.) */
4446 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4447 tls12_prf->label, tls12_prf->label_length );
4448 if( status != PSA_SUCCESS )
4449 goto cleanup;
4450 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4451 tls12_prf->seed, tls12_prf->seed_length );
4452 if( status != PSA_SUCCESS )
4453 goto cleanup;
4454 }
4455 else
4456 {
4457 /* A(i) = HMAC_hash(secret, A(i-1)) */
4458 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4459 tls12_prf->Ai, hash_length );
4460 if( status != PSA_SUCCESS )
4461 goto cleanup;
4462 }
4463
4464 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4465 tls12_prf->Ai, hash_length );
4466 if( status != PSA_SUCCESS )
4467 goto cleanup;
4468 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4469 if( status != PSA_SUCCESS )
4470 goto cleanup;
4471
4472 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4473 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4474 tls12_prf->Ai, hash_length );
4475 if( status != PSA_SUCCESS )
4476 goto cleanup;
4477 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4478 tls12_prf->label, tls12_prf->label_length );
4479 if( status != PSA_SUCCESS )
4480 goto cleanup;
4481 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4482 tls12_prf->seed, tls12_prf->seed_length );
4483 if( status != PSA_SUCCESS )
4484 goto cleanup;
4485 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4486 tls12_prf->output_block, hash_length );
4487 if( status != PSA_SUCCESS )
4488 goto cleanup;
4489 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4490 if( status != PSA_SUCCESS )
4491 goto cleanup;
4492
Janos Follath7742fee2019-06-17 12:58:10 +01004493
4494cleanup:
4495
Janos Follathea29bfb2019-06-19 12:21:20 +01004496 cleanup_status = psa_hash_abort( &backup );
4497 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4498 status = cleanup_status;
4499
4500 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004501}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004502
Janos Follath844eb0e2019-06-19 12:10:49 +01004503static psa_status_t psa_key_derivation_tls12_prf_read(
4504 psa_tls12_prf_key_derivation_t *tls12_prf,
4505 psa_algorithm_t alg,
4506 uint8_t *output,
4507 size_t output_length )
4508{
4509 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004510 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004511 psa_status_t status;
4512 uint8_t offset, length;
4513
4514 while( output_length != 0 )
4515 {
4516 /* Check if we have fully processed the current block. */
4517 if( tls12_prf->left_in_block == 0 )
4518 {
4519 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4520 alg );
4521 if( status != PSA_SUCCESS )
4522 return( status );
4523
4524 continue;
4525 }
4526
4527 if( tls12_prf->left_in_block > output_length )
4528 length = (uint8_t) output_length;
4529 else
4530 length = tls12_prf->left_in_block;
4531
4532 offset = hash_length - tls12_prf->left_in_block;
4533 memcpy( output, tls12_prf->output_block + offset, length );
4534 output += length;
4535 output_length -= length;
4536 tls12_prf->left_in_block -= length;
4537 }
4538
4539 return( PSA_SUCCESS );
4540}
John Durkop07cc04a2020-11-16 22:08:34 -08004541#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4542 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004543
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004544psa_status_t psa_key_derivation_output_bytes(
4545 psa_key_derivation_operation_t *operation,
4546 uint8_t *output,
4547 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004548{
4549 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004550 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004551
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004552 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004553 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004554 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004555 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004556 }
4557
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004558 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004559 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004560 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004561 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004562 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004563 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004564 goto exit;
4565 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004566 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004567 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004568 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004569 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004570 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4571 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004572 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004573 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004574 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004575 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004576 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004577
John Durkopd0321952020-10-29 21:37:36 -07004578#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004579 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004580 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004581 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004582 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004583 output, output_length );
4584 }
Janos Follathadbec812019-06-14 11:05:39 +01004585 else
John Durkop07cc04a2020-11-16 22:08:34 -08004586#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4587#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4588 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004589 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004590 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004591 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004592 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004593 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004594 output_length );
4595 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004596 else
John Durkop07cc04a2020-11-16 22:08:34 -08004597#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4598 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004599 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004600 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004601 return( PSA_ERROR_BAD_STATE );
4602 }
4603
4604exit:
4605 if( status != PSA_SUCCESS )
4606 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004607 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004608 * This allows us to differentiate between exhausted operations and
4609 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4610 * operations. */
4611 psa_algorithm_t alg = operation->alg;
4612 psa_key_derivation_abort( operation );
4613 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004614 memset( output, '!', output_length );
4615 }
4616 return( status );
4617}
4618
David Brown7807bf72021-02-09 16:28:23 -07004619#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004620static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4621{
4622 if( data_size >= 8 )
4623 mbedtls_des_key_set_parity( data );
4624 if( data_size >= 16 )
4625 mbedtls_des_key_set_parity( data + 8 );
4626 if( data_size >= 24 )
4627 mbedtls_des_key_set_parity( data + 16 );
4628}
David Brown7807bf72021-02-09 16:28:23 -07004629#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004630
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004631static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004632 psa_key_slot_t *slot,
4633 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004634 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004635{
4636 uint8_t *data = NULL;
4637 size_t bytes = PSA_BITS_TO_BYTES( bits );
4638 psa_status_t status;
4639
Gilles Peskine8e338702019-07-30 20:06:31 +02004640 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004641 return( PSA_ERROR_INVALID_ARGUMENT );
4642 if( bits % 8 != 0 )
4643 return( PSA_ERROR_INVALID_ARGUMENT );
4644 data = mbedtls_calloc( 1, bytes );
4645 if( data == NULL )
4646 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4647
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004648 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004649 if( status != PSA_SUCCESS )
4650 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004651#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004652 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004653 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004654#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004655
4656 status = psa_allocate_buffer_to_slot( slot, bytes );
4657 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004658 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004659
Ronald Cronbf33c932020-11-28 18:06:53 +01004660 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004661 psa_key_attributes_t attributes = {
4662 .core = slot->attr
4663 };
4664
Ronald Cronbf33c932020-11-28 18:06:53 +01004665 status = psa_driver_wrapper_import_key( &attributes,
4666 data, bytes,
4667 slot->key.data,
4668 slot->key.bytes,
4669 &slot->key.bytes, &bits );
4670 if( bits != slot->attr.bits )
4671 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004672
4673exit:
4674 mbedtls_free( data );
4675 return( status );
4676}
4677
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004678psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004679 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004680 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004681{
4682 psa_status_t status;
4683 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004684 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004685
Ronald Cron81709fc2020-11-14 12:10:32 +01004686 *key = MBEDTLS_SVC_KEY_ID_INIT;
4687
Gilles Peskine0f84d622019-09-12 19:03:13 +02004688 /* Reject any attempt to create a zero-length key so that we don't
4689 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4690 if( psa_get_key_bits( attributes ) == 0 )
4691 return( PSA_ERROR_INVALID_ARGUMENT );
4692
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004693 if( ! operation->can_output_key )
4694 return( PSA_ERROR_NOT_PERMITTED );
4695
Ronald Cron81709fc2020-11-14 12:10:32 +01004696 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4697 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004698#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4699 if( driver != NULL )
4700 {
4701 /* Deriving a key in a secure element is not implemented yet. */
4702 status = PSA_ERROR_NOT_SUPPORTED;
4703 }
4704#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004705 if( status == PSA_SUCCESS )
4706 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004707 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004708 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004709 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004710 }
4711 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004712 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004713 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004714 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004715
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004716 return( status );
4717}
4718
Gilles Peskineeab56e42018-07-12 17:12:33 +02004719
4720
4721/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004722/* Key derivation */
4723/****************************************************************/
4724
Steven Cooreman932ffb72021-02-15 12:14:32 +01004725#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004726static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004727 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004728 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004729{
John Durkop07cc04a2020-11-16 22:08:34 -08004730 int is_kdf_alg_supported;
4731
Janos Follath5fe19732019-06-20 15:09:30 +01004732 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4733 * initialisers for this union leave some bytes unspecified.) */
4734 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4735
Gilles Peskine969c5d62019-01-16 15:53:06 +01004736 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004737#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004738 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4739 is_kdf_alg_supported = 1;
4740 else
4741#endif
4742#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4743 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4744 is_kdf_alg_supported = 1;
4745 else
4746#endif
4747#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4748 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4749 is_kdf_alg_supported = 1;
4750 else
4751#endif
4752 is_kdf_alg_supported = 0;
4753
4754 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004755 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004756 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004757 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004758 if( hash_size == 0 )
4759 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004760 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4761 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004762 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004763 {
4764 return( PSA_ERROR_NOT_SUPPORTED );
4765 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004766 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004767 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004768 }
John Durkop07cc04a2020-11-16 22:08:34 -08004769
4770 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004771}
John Durkop07cc04a2020-11-16 22:08:34 -08004772#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004773
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004774psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004775 psa_algorithm_t alg )
4776{
4777 psa_status_t status;
4778
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004779 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004780 return( PSA_ERROR_BAD_STATE );
4781
Gilles Peskine6843c292019-01-18 16:44:49 +01004782 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4783 return( PSA_ERROR_INVALID_ARGUMENT );
4784 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004785 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004786#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004787 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004788 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004789#else
4790 return( PSA_ERROR_NOT_SUPPORTED );
4791#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004792 }
4793 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4794 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004795#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004796 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004797#else
4798 return( PSA_ERROR_NOT_SUPPORTED );
4799#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004800 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004801 else
4802 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004803
4804 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004805 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004806 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004807}
4808
John Durkopd0321952020-10-29 21:37:36 -07004809#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004810static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004811 psa_algorithm_t hash_alg,
4812 psa_key_derivation_step_t step,
4813 const uint8_t *data,
4814 size_t data_length )
4815{
4816 psa_status_t status;
4817 switch( step )
4818 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004819 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004820 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004821 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004822 status = psa_hmac_setup_internal( &hkdf->hmac,
4823 data, data_length,
4824 hash_alg );
4825 if( status != PSA_SUCCESS )
4826 return( status );
4827 hkdf->state = HKDF_STATE_STARTED;
4828 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004829 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004830 /* If no salt was provided, use an empty salt. */
4831 if( hkdf->state == HKDF_STATE_INIT )
4832 {
4833 status = psa_hmac_setup_internal( &hkdf->hmac,
4834 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02004835 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004836 if( status != PSA_SUCCESS )
4837 return( status );
4838 hkdf->state = HKDF_STATE_STARTED;
4839 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004840 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004841 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004842 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4843 data, data_length );
4844 if( status != PSA_SUCCESS )
4845 return( status );
4846 status = psa_hmac_finish_internal( &hkdf->hmac,
4847 hkdf->prk,
4848 sizeof( hkdf->prk ) );
4849 if( status != PSA_SUCCESS )
4850 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004851 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004852 hkdf->block_number = 0;
4853 hkdf->state = HKDF_STATE_KEYED;
4854 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004855 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004856 if( hkdf->state == HKDF_STATE_OUTPUT )
4857 return( PSA_ERROR_BAD_STATE );
4858 if( hkdf->info_set )
4859 return( PSA_ERROR_BAD_STATE );
4860 hkdf->info_length = data_length;
4861 if( data_length != 0 )
4862 {
4863 hkdf->info = mbedtls_calloc( 1, data_length );
4864 if( hkdf->info == NULL )
4865 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4866 memcpy( hkdf->info, data, data_length );
4867 }
4868 hkdf->info_set = 1;
4869 return( PSA_SUCCESS );
4870 default:
4871 return( PSA_ERROR_INVALID_ARGUMENT );
4872 }
4873}
John Durkop07cc04a2020-11-16 22:08:34 -08004874#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004875
John Durkop07cc04a2020-11-16 22:08:34 -08004876#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4877 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004878static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4879 const uint8_t *data,
4880 size_t data_length )
4881{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004882 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004883 return( PSA_ERROR_BAD_STATE );
4884
Janos Follathd6dce9f2019-07-04 09:11:38 +01004885 if( data_length != 0 )
4886 {
4887 prf->seed = mbedtls_calloc( 1, data_length );
4888 if( prf->seed == NULL )
4889 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004890
Janos Follathd6dce9f2019-07-04 09:11:38 +01004891 memcpy( prf->seed, data, data_length );
4892 prf->seed_length = data_length;
4893 }
Janos Follathf08e2652019-06-13 09:05:41 +01004894
Gilles Peskine43f958b2020-12-13 14:55:14 +01004895 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004896
4897 return( PSA_SUCCESS );
4898}
4899
Janos Follath81550542019-06-13 14:26:34 +01004900static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
4901 psa_algorithm_t hash_alg,
4902 const uint8_t *data,
4903 size_t data_length )
4904{
4905 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01004906 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004907 return( PSA_ERROR_BAD_STATE );
4908
4909 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
4910 if( status != PSA_SUCCESS )
4911 return( status );
4912
Gilles Peskine43f958b2020-12-13 14:55:14 +01004913 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004914
4915 return( PSA_SUCCESS );
4916}
4917
Janos Follath63028dd2019-06-13 09:15:47 +01004918static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4919 const uint8_t *data,
4920 size_t data_length )
4921{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004922 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004923 return( PSA_ERROR_BAD_STATE );
4924
Janos Follathd6dce9f2019-07-04 09:11:38 +01004925 if( data_length != 0 )
4926 {
4927 prf->label = mbedtls_calloc( 1, data_length );
4928 if( prf->label == NULL )
4929 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004930
Janos Follathd6dce9f2019-07-04 09:11:38 +01004931 memcpy( prf->label, data, data_length );
4932 prf->label_length = data_length;
4933 }
Janos Follath63028dd2019-06-13 09:15:47 +01004934
Gilles Peskine43f958b2020-12-13 14:55:14 +01004935 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004936
4937 return( PSA_SUCCESS );
4938}
4939
Janos Follathb03233e2019-06-11 15:30:30 +01004940static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
4941 psa_algorithm_t hash_alg,
4942 psa_key_derivation_step_t step,
4943 const uint8_t *data,
4944 size_t data_length )
4945{
Janos Follathb03233e2019-06-11 15:30:30 +01004946 switch( step )
4947 {
Janos Follathf08e2652019-06-13 09:05:41 +01004948 case PSA_KEY_DERIVATION_INPUT_SEED:
4949 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004950 case PSA_KEY_DERIVATION_INPUT_SECRET:
4951 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004952 case PSA_KEY_DERIVATION_INPUT_LABEL:
4953 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004954 default:
4955 return( PSA_ERROR_INVALID_ARGUMENT );
4956 }
4957}
John Durkop07cc04a2020-11-16 22:08:34 -08004958#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4959 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4960
4961#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4962static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4963 psa_tls12_prf_key_derivation_t *prf,
4964 psa_algorithm_t hash_alg,
4965 const uint8_t *data,
4966 size_t data_length )
4967{
4968 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004969 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004970 uint8_t *cur = pms;
4971
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004972 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004973 return( PSA_ERROR_INVALID_ARGUMENT );
4974
4975 /* Quoting RFC 4279, Section 2:
4976 *
4977 * The premaster secret is formed as follows: if the PSK is N octets
4978 * long, concatenate a uint16 with the value N, N zero octets, a second
4979 * uint16 with the value N, and the PSK itself.
4980 */
4981
4982 *cur++ = ( data_length >> 8 ) & 0xff;
4983 *cur++ = ( data_length >> 0 ) & 0xff;
4984 memset( cur, 0, data_length );
4985 cur += data_length;
4986 *cur++ = pms[0];
4987 *cur++ = pms[1];
4988 memcpy( cur, data, data_length );
4989 cur += data_length;
4990
4991 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
4992
4993 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4994 return( status );
4995}
Janos Follath6660f0e2019-06-17 08:44:03 +01004996
4997static psa_status_t psa_tls12_prf_psk_to_ms_input(
4998 psa_tls12_prf_key_derivation_t *prf,
4999 psa_algorithm_t hash_alg,
5000 psa_key_derivation_step_t step,
5001 const uint8_t *data,
5002 size_t data_length )
5003{
5004 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005005 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005006 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5007 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005008 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005009
5010 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5011}
John Durkop07cc04a2020-11-16 22:08:34 -08005012#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005013
Gilles Peskineb8965192019-09-24 16:21:10 +02005014/** Check whether the given key type is acceptable for the given
5015 * input step of a key derivation.
5016 *
5017 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5018 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5019 * Both secret and non-secret inputs can alternatively have the type
5020 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5021 * that the input was passed as a buffer rather than via a key object.
5022 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005023static int psa_key_derivation_check_input_type(
5024 psa_key_derivation_step_t step,
5025 psa_key_type_t key_type )
5026{
5027 switch( step )
5028 {
5029 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005030 if( key_type == PSA_KEY_TYPE_DERIVE )
5031 return( PSA_SUCCESS );
5032 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005033 return( PSA_SUCCESS );
5034 break;
5035 case PSA_KEY_DERIVATION_INPUT_LABEL:
5036 case PSA_KEY_DERIVATION_INPUT_SALT:
5037 case PSA_KEY_DERIVATION_INPUT_INFO:
5038 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005039 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5040 return( PSA_SUCCESS );
5041 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005042 return( PSA_SUCCESS );
5043 break;
5044 }
5045 return( PSA_ERROR_INVALID_ARGUMENT );
5046}
5047
Janos Follathb80a94e2019-06-12 15:54:46 +01005048static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005049 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005050 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005051 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005052 const uint8_t *data,
5053 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005054{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005055 psa_status_t status;
5056 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5057
5058 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005059 if( status != PSA_SUCCESS )
5060 goto exit;
5061
John Durkopd0321952020-10-29 21:37:36 -07005062#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005063 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005064 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005065 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005066 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005067 step, data, data_length );
5068 }
John Durkop07cc04a2020-11-16 22:08:34 -08005069 else
5070#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5071#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5072 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005073 {
Janos Follathb03233e2019-06-11 15:30:30 +01005074 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5075 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5076 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005077 }
John Durkop07cc04a2020-11-16 22:08:34 -08005078 else
5079#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5080#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5081 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005082 {
5083 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5084 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5085 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005086 }
5087 else
John Durkop07cc04a2020-11-16 22:08:34 -08005088#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005089 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005090 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005091 (void) data;
5092 (void) data_length;
5093 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005094 return( PSA_ERROR_BAD_STATE );
5095 }
5096
Gilles Peskine224b0d62019-09-23 18:13:17 +02005097exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005098 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005099 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005100 return( status );
5101}
5102
Janos Follath51f4a0f2019-06-14 11:35:55 +01005103psa_status_t psa_key_derivation_input_bytes(
5104 psa_key_derivation_operation_t *operation,
5105 psa_key_derivation_step_t step,
5106 const uint8_t *data,
5107 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005108{
Gilles Peskineb8965192019-09-24 16:21:10 +02005109 return( psa_key_derivation_input_internal( operation, step,
5110 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005111 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005112}
5113
Janos Follath51f4a0f2019-06-14 11:35:55 +01005114psa_status_t psa_key_derivation_input_key(
5115 psa_key_derivation_operation_t *operation,
5116 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005117 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005118{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005119 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005120 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005121 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005122
Ronald Cron5c522922020-11-14 16:35:34 +01005123 status = psa_get_and_lock_transparent_key_slot_with_policy(
5124 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005125 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005126 {
5127 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005128 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005129 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005130
5131 /* Passing a key object as a SECRET input unlocks the permission
5132 * to output to a key object. */
5133 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5134 operation->can_output_key = 1;
5135
Ronald Cronf95a2b12020-10-22 15:24:49 +02005136 status = psa_key_derivation_input_internal( operation,
5137 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005138 slot->key.data,
5139 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005140
Ronald Cron5c522922020-11-14 16:35:34 +01005141 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005142
Ronald Cron5c522922020-11-14 16:35:34 +01005143 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005144}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005145
5146
5147
5148/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005149/* Key agreement */
5150/****************************************************************/
5151
John Durkop6ba40d12020-11-10 08:50:04 -08005152#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005153static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5154 size_t peer_key_length,
5155 const mbedtls_ecp_keypair *our_key,
5156 uint8_t *shared_secret,
5157 size_t shared_secret_size,
5158 size_t *shared_secret_length )
5159{
Steven Cooremand4867872020-08-05 16:31:39 +02005160 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005161 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005162 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005163 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005164 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005165 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005166
Ronald Cron90857082020-11-25 14:58:33 +01005167 status = mbedtls_psa_ecp_load_representation(
5168 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005169 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005170 peer_key,
5171 peer_key_length,
5172 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005173 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005174 goto exit;
5175
Jaeden Amero97271b32019-01-10 19:38:51 +00005176 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005177 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005178 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005179 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005180 status = mbedtls_to_psa_error(
5181 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5182 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005183 goto exit;
5184
Jaeden Amero97271b32019-01-10 19:38:51 +00005185 status = mbedtls_to_psa_error(
5186 mbedtls_ecdh_calc_secret( &ecdh,
5187 shared_secret_length,
5188 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005189 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005190 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005191 if( status != PSA_SUCCESS )
5192 goto exit;
5193 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5194 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005195
5196exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005197 if( status != PSA_SUCCESS )
5198 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005199 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005200 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005201 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005202
Jaeden Amero97271b32019-01-10 19:38:51 +00005203 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005204}
John Durkop6ba40d12020-11-10 08:50:04 -08005205#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005206
Gilles Peskine01d718c2018-09-18 12:01:02 +02005207#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5208
Gilles Peskine0216fe12019-04-11 21:23:21 +02005209static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5210 psa_key_slot_t *private_key,
5211 const uint8_t *peer_key,
5212 size_t peer_key_length,
5213 uint8_t *shared_secret,
5214 size_t shared_secret_size,
5215 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005216{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005217 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005218 {
John Durkop6ba40d12020-11-10 08:50:04 -08005219#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005220 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005221 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005222 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005223 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005224 psa_status_t status = mbedtls_psa_ecp_load_representation(
5225 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005226 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005227 private_key->key.data,
5228 private_key->key.bytes,
5229 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005230 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005231 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005232 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005233 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005234 shared_secret, shared_secret_size,
5235 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005236 mbedtls_ecp_keypair_free( ecp );
5237 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005238 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005239#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005240 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005241 (void) private_key;
5242 (void) peer_key;
5243 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005244 (void) shared_secret;
5245 (void) shared_secret_size;
5246 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005247 return( PSA_ERROR_NOT_SUPPORTED );
5248 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005249}
5250
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005251/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005252 * to potentially free embedded data structures and wipe confidential data.
5253 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005254static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005255 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005256 psa_key_slot_t *private_key,
5257 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005258 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005259{
5260 psa_status_t status;
5261 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5262 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005263 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005264
5265 /* Step 1: run the secret agreement algorithm to generate the shared
5266 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005267 status = psa_key_agreement_raw_internal( ka_alg,
5268 private_key,
5269 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005270 shared_secret,
5271 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005272 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005273 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005274 goto exit;
5275
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005276 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005277 * the shared secret. A shared secret is permitted wherever a key
5278 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005279 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005280 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005281 shared_secret,
5282 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005283exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005284 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005285 return( status );
5286}
5287
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005288psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005289 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005290 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005291 const uint8_t *peer_key,
5292 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005293{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005294 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005295 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005296 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005297
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005298 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005299 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005300 status = psa_get_and_lock_transparent_key_slot_with_policy(
5301 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005302 if( status != PSA_SUCCESS )
5303 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005304 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005305 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005306 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005307 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005308 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005309 else
5310 {
5311 /* If a private key has been added as SECRET, we allow the derived
5312 * key material to be used as a key in PSA Crypto. */
5313 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5314 operation->can_output_key = 1;
5315 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005316
Ronald Cron5c522922020-11-14 16:35:34 +01005317 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005318
Ronald Cron5c522922020-11-14 16:35:34 +01005319 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005320}
5321
Gilles Peskinebe697d82019-05-16 18:00:41 +02005322psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005323 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005324 const uint8_t *peer_key,
5325 size_t peer_key_length,
5326 uint8_t *output,
5327 size_t output_size,
5328 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005329{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005331 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005332 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005333
5334 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5335 {
5336 status = PSA_ERROR_INVALID_ARGUMENT;
5337 goto exit;
5338 }
Ronald Cron5c522922020-11-14 16:35:34 +01005339 status = psa_get_and_lock_transparent_key_slot_with_policy(
5340 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005341 if( status != PSA_SUCCESS )
5342 goto exit;
5343
5344 status = psa_key_agreement_raw_internal( alg, slot,
5345 peer_key, peer_key_length,
5346 output, output_size,
5347 output_length );
5348
5349exit:
5350 if( status != PSA_SUCCESS )
5351 {
5352 /* If an error happens and is not handled properly, the output
5353 * may be used as a key to protect sensitive data. Arrange for such
5354 * a key to be random, which is likely to result in decryption or
5355 * verification errors. This is better than filling the buffer with
5356 * some constant data such as zeros, which would result in the data
5357 * being protected with a reproducible, easily knowable key.
5358 */
5359 psa_generate_random( output, output_size );
5360 *output_length = output_size;
5361 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005362
Ronald Cron5c522922020-11-14 16:35:34 +01005363 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005364
Ronald Cron5c522922020-11-14 16:35:34 +01005365 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005366}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005367
5368
Gilles Peskine30524eb2020-11-13 17:02:26 +01005369
Gilles Peskine86a440b2018-11-12 18:39:40 +01005370/****************************************************************/
5371/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005372/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005373
Gilles Peskine30524eb2020-11-13 17:02:26 +01005374/** Initialize the PSA random generator.
5375 */
5376static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5377{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005378#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5379 memset( rng, 0, sizeof( *rng ) );
5380#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5381
Gilles Peskine30524eb2020-11-13 17:02:26 +01005382 /* Set default configuration if
5383 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5384 if( rng->entropy_init == NULL )
5385 rng->entropy_init = mbedtls_entropy_init;
5386 if( rng->entropy_free == NULL )
5387 rng->entropy_free = mbedtls_entropy_free;
5388
5389 rng->entropy_init( &rng->entropy );
5390#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5391 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5392 /* The PSA entropy injection feature depends on using NV seed as an entropy
5393 * source. Add NV seed as an entropy source for PSA entropy injection. */
5394 mbedtls_entropy_add_source( &rng->entropy,
5395 mbedtls_nv_seed_poll, NULL,
5396 MBEDTLS_ENTROPY_BLOCK_SIZE,
5397 MBEDTLS_ENTROPY_SOURCE_STRONG );
5398#endif
5399
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005400 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005401#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005402}
5403
5404/** Deinitialize the PSA random generator.
5405 */
5406static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5407{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005408#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5409 memset( rng, 0, sizeof( *rng ) );
5410#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005411 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005412 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005413#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005414}
5415
5416/** Seed the PSA random generator.
5417 */
5418static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5419{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005420#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5421 /* Do nothing: the external RNG seeds itself. */
5422 (void) rng;
5423 return( PSA_SUCCESS );
5424#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005425 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005426 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5427 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005428 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005429#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005430}
5431
Gilles Peskinee59236f2018-01-27 23:32:46 +01005432psa_status_t psa_generate_random( uint8_t *output,
5433 size_t output_size )
5434{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005435 GUARD_MODULE_INITIALIZED;
5436
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005437#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5438
5439 size_t output_length = 0;
5440 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5441 output, output_size,
5442 &output_length );
5443 if( status != PSA_SUCCESS )
5444 return( status );
5445 /* Breaking up a request into smaller chunks is currently not supported
5446 * for the extrernal RNG interface. */
5447 if( output_length != output_size )
5448 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5449 return( PSA_SUCCESS );
5450
5451#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5452
Gilles Peskine71ddab92021-01-04 21:01:07 +01005453 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005454 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005455 size_t request_size =
5456 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5457 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5458 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005459 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5460 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005461 if( ret != 0 )
5462 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005463 output_size -= request_size;
5464 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005465 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005466 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005467#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005468}
5469
Gilles Peskine8814fc42020-12-14 15:33:44 +01005470/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005471 *
5472 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5473 * `psa_generate_random(...)`. The state parameter is ignored since the
5474 * PSA API doesn't support passing an explicit state.
5475 *
5476 * In the non-external case, psa_generate_random() calls an
5477 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5478 * and semantics as mbedtls_psa_get_random(). As an optimization,
5479 * instead of doing this back-and-forth between the PSA API and the
5480 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5481 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005482 */
5483#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5484int mbedtls_psa_get_random( void *p_rng,
5485 unsigned char *output,
5486 size_t output_size )
5487{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005488 /* This function takes a pointer to the RNG state because that's what
5489 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5490 * its own state internally and doesn't let the caller access that state.
5491 * So we just ignore the state parameter, and in practice we'll pass
5492 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005493 (void) p_rng;
5494 psa_status_t status = psa_generate_random( output, output_size );
5495 if( status == PSA_SUCCESS )
5496 return( 0 );
5497 else
5498 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5499}
5500#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5501
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005502#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5503#include "mbedtls/entropy_poll.h"
5504
Gilles Peskine7228da22019-07-15 11:06:15 +02005505psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005506 size_t seed_size )
5507{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005508 if( global_data.initialized )
5509 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005510
5511 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5512 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5513 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5514 return( PSA_ERROR_INVALID_ARGUMENT );
5515
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005516 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005517}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005518#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005519
Ronald Cron3772afe2021-02-08 16:10:05 +01005520/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005521 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005522 * \param type The key type
5523 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005524 *
5525 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005526 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005527 * \retval #PSA_ERROR_INVALID_ARGUMENT
5528 * The size in bits of the key is not valid.
5529 * \retval #PSA_ERROR_NOT_SUPPORTED
5530 * The type and/or the size in bits of the key or the combination of
5531 * the two is not supported.
5532 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005533static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5534 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005535{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005537
Gilles Peskinee59236f2018-01-27 23:32:46 +01005538 if( key_type_is_raw_bytes( type ) )
5539 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005540 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005541 if( status != PSA_SUCCESS )
5542 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005543 }
5544 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005545#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005546 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5547 {
5548 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5549 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005550
Ronald Cron01b2aba2020-10-05 09:42:02 +02005551 /* Accept only byte-aligned keys, for the same reasons as
5552 * in psa_import_rsa_key(). */
5553 if( bits % 8 != 0 )
5554 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005555 }
5556 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005557#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005558
Ronald Cron5c4d3862020-12-07 11:07:24 +01005559#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005560 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5561 {
Ronald Crond81ab562021-02-16 09:01:16 +01005562 /* To avoid empty block, return successfully here. */
5563 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005564 }
5565 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005566#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005567 {
5568 return( PSA_ERROR_NOT_SUPPORTED );
5569 }
5570
5571 return( PSA_SUCCESS );
5572}
5573
Ronald Cron55ed0592020-10-05 10:30:40 +02005574psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005575 const psa_key_attributes_t *attributes,
5576 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005577{
5578 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005579 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005580
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005581 if( ( attributes->domain_parameters == NULL ) &&
5582 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005583 return( PSA_ERROR_INVALID_ARGUMENT );
5584
Ronald Cron01b2aba2020-10-05 09:42:02 +02005585 if( key_type_is_raw_bytes( type ) )
5586 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005587 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005588 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005589 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005590
David Brown12ca5032021-02-11 11:02:00 -07005591#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005592 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005593 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005594#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005595 }
5596 else
5597
John Durkop07cc04a2020-11-16 22:08:34 -08005598#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005599 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005600 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005601 return( mbedtls_psa_rsa_generate_key( attributes,
5602 key_buffer,
5603 key_buffer_size,
5604 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005605 }
5606 else
John Durkop07cc04a2020-11-16 22:08:34 -08005607#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005608
John Durkop9814fa22020-11-04 12:28:15 -08005609#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005610 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005611 {
Ronald Cron7023db52020-11-20 18:17:42 +01005612 return( mbedtls_psa_ecp_generate_key( attributes,
5613 key_buffer,
5614 key_buffer_size,
5615 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005616 }
5617 else
John Durkop9814fa22020-11-04 12:28:15 -08005618#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005619 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005620 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005621 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005622 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005623
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005624 return( PSA_SUCCESS );
5625}
Darryl Green0c6575a2018-11-07 16:05:30 +00005626
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005627psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005628 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005629{
5630 psa_status_t status;
5631 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005632 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005633 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005634
Ronald Cron81709fc2020-11-14 12:10:32 +01005635 *key = MBEDTLS_SVC_KEY_ID_INIT;
5636
Gilles Peskine0f84d622019-09-12 19:03:13 +02005637 /* Reject any attempt to create a zero-length key so that we don't
5638 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5639 if( psa_get_key_bits( attributes ) == 0 )
5640 return( PSA_ERROR_INVALID_ARGUMENT );
5641
Ronald Cron81709fc2020-11-14 12:10:32 +01005642 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5643 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005644 if( status != PSA_SUCCESS )
5645 goto exit;
5646
Ronald Cron977c2472020-10-13 08:32:21 +02005647 /* In the case of a transparent key or an opaque key stored in local
5648 * storage (thus not in the case of generating a key in a secure element
5649 * or cryptoprocessor with storage), we have to allocate a buffer to
5650 * hold the generated key material. */
5651 if( slot->key.data == NULL )
5652 {
5653 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5654 PSA_KEY_LOCATION_LOCAL_STORAGE )
5655 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005656 status = psa_validate_key_type_and_size_for_key_generation(
5657 attributes->core.type, attributes->core.bits );
5658 if( status != PSA_SUCCESS )
5659 goto exit;
5660
5661 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5662 attributes->core.type,
5663 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005664 }
5665 else
5666 {
5667 status = psa_driver_wrapper_get_key_buffer_size(
5668 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005669 if( status != PSA_SUCCESS )
5670 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005671 }
Ronald Cron977c2472020-10-13 08:32:21 +02005672
5673 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5674 if( status != PSA_SUCCESS )
5675 goto exit;
5676 }
5677
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005678 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005679 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005680
Ronald Cron2b56bc82020-10-05 10:02:26 +02005681 if( status != PSA_SUCCESS )
5682 psa_remove_key_data_from_memory( slot );
5683
Gilles Peskine11792082019-08-06 18:36:36 +02005684exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005685 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005686 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005687 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005688 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005689
Darryl Green0c6575a2018-11-07 16:05:30 +00005690 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005691}
5692
Gilles Peskinee59236f2018-01-27 23:32:46 +01005693/****************************************************************/
5694/* Module setup */
5695/****************************************************************/
5696
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005697#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005698psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5699 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5700 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5701{
5702 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5703 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005704 global_data.rng.entropy_init = entropy_init;
5705 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005706 return( PSA_SUCCESS );
5707}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005708#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005709
Gilles Peskinee59236f2018-01-27 23:32:46 +01005710void mbedtls_psa_crypto_free( void )
5711{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005712 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005713 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5714 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005715 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005716 }
5717 /* Wipe all remaining data, including configuration.
5718 * In particular, this sets all state indicator to the value
5719 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005720 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005721#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005722 /* Unregister all secure element drivers, so that we restart from
5723 * a pristine state. */
5724 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005725#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005726}
5727
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005728#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5729/** Recover a transaction that was interrupted by a power failure.
5730 *
5731 * This function is called during initialization, before psa_crypto_init()
5732 * returns. If this function returns a failure status, the initialization
5733 * fails.
5734 */
5735static psa_status_t psa_crypto_recover_transaction(
5736 const psa_crypto_transaction_t *transaction )
5737{
5738 switch( transaction->unknown.type )
5739 {
5740 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5741 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005742 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005743 * is implemented.
5744 * https://github.com/ARMmbed/mbed-crypto/issues/218
5745 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005746 default:
5747 /* We found an unsupported transaction in the storage.
5748 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005749 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005750 }
5751}
5752#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5753
Gilles Peskinee59236f2018-01-27 23:32:46 +01005754psa_status_t psa_crypto_init( void )
5755{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005756 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005757
Gilles Peskinec6b69072018-11-20 21:42:52 +01005758 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005759 if( global_data.initialized != 0 )
5760 return( PSA_SUCCESS );
5761
Gilles Peskine30524eb2020-11-13 17:02:26 +01005762 /* Initialize and seed the random generator. */
5763 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005764 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005765 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005766 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005767 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005768 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005769
Gilles Peskine66fb1262018-12-10 16:29:04 +01005770 status = psa_initialize_key_slots( );
5771 if( status != PSA_SUCCESS )
5772 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005773
Gilles Peskined9348f22019-10-01 15:22:29 +02005774#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5775 status = psa_init_all_se_drivers( );
5776 if( status != PSA_SUCCESS )
5777 goto exit;
5778#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5779
Gilles Peskine4b734222019-07-24 15:56:31 +02005780#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005781 status = psa_crypto_load_transaction( );
5782 if( status == PSA_SUCCESS )
5783 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005784 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5785 if( status != PSA_SUCCESS )
5786 goto exit;
5787 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005788 }
5789 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5790 {
5791 /* There's no transaction to complete. It's all good. */
5792 status = PSA_SUCCESS;
5793 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005794#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005795
Gilles Peskinec6b69072018-11-20 21:42:52 +01005796 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005797 global_data.initialized = 1;
5798
5799exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005800 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005801 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005802 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005803}
5804
5805#endif /* MBEDTLS_PSA_CRYPTO_C */