blob: bc1619cc1fe66fccd7a7c9098a95887fe0f0e001 [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/*
5 * Copyright (C) 2018, ARM Limited, All Rights Reserved
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.
19 *
20 * This file is part of mbed TLS (https://tls.mbed.org)
21 */
22
Gilles Peskinedb09ef62020-06-03 01:43:33 +020023#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010024
25#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030026
itayzafrir7723ab12019-02-14 10:28:02 +020027#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010028#include "psa/crypto.h"
29
Gilles Peskine039b90c2018-12-07 18:24:41 +010030#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010031#include "psa_crypto_invasive.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb46bef22019-07-30 21:32:04 +020040#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010041#include <stdlib.h>
42#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010043#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020044#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045#define mbedtls_calloc calloc
46#define mbedtls_free free
47#endif
48
Gilles Peskinea5905292018-02-07 20:59:33 +010049#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020050#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000051#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020052#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/blowfish.h"
54#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020055#include "mbedtls/chacha20.h"
56#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/cipher.h"
58#include "mbedtls/ccm.h"
59#include "mbedtls/cmac.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/ctr_drbg.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020062#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010063#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010064#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/error.h"
66#include "mbedtls/gcm.h"
67#include "mbedtls/md2.h"
68#include "mbedtls/md4.h"
69#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010070#include "mbedtls/md.h"
71#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010072#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010073#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010074#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000075#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010077#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010078#include "mbedtls/sha1.h"
79#include "mbedtls/sha256.h"
80#include "mbedtls/sha512.h"
81#include "mbedtls/xtea.h"
82
Gilles Peskine996deb12018-08-01 15:45:45 +020083#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
84
Gilles Peskine9ef733f2018-02-07 21:05:37 +010085/* constant-time buffer comparison */
86static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
87{
88 size_t i;
89 unsigned char diff = 0;
90
91 for( i = 0; i < n; i++ )
92 diff |= a[i] ^ b[i];
93
94 return( diff );
95}
96
97
98
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010099/****************************************************************/
100/* Global data, support functions and library management */
101/****************************************************************/
102
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200103static int key_type_is_raw_bytes( psa_key_type_t type )
104{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200105 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200106}
107
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108/* Values for psa_global_data_t::rng_state */
109#define RNG_NOT_INITIALIZED 0
110#define RNG_INITIALIZED 1
111#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100112
Gilles Peskine2d277862018-06-18 15:41:12 +0200113typedef struct
114{
Gilles Peskine5e769522018-11-20 21:59:56 +0100115 void (* entropy_init )( mbedtls_entropy_context *ctx );
116 void (* entropy_free )( mbedtls_entropy_context *ctx );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100117 mbedtls_entropy_context entropy;
118 mbedtls_ctr_drbg_context ctr_drbg;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100119 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100120 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100121} psa_global_data_t;
122
123static psa_global_data_t global_data;
124
itayzafrir0adf0fc2018-09-06 16:24:41 +0300125#define GUARD_MODULE_INITIALIZED \
126 if( global_data.initialized == 0 ) \
127 return( PSA_ERROR_BAD_STATE );
128
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129static psa_status_t mbedtls_to_psa_error( int ret )
130{
Gilles Peskinea5905292018-02-07 20:59:33 +0100131 /* If there's both a high-level code and low-level code, dispatch on
132 * the high-level code. */
133 switch( ret < -0x7f ? - ( -ret & 0x7f80 ) : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100134 {
135 case 0:
136 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100137
138 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
139 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
140 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
141 return( PSA_ERROR_NOT_SUPPORTED );
142 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
143 return( PSA_ERROR_HARDWARE_FAILURE );
144
145 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
146 return( PSA_ERROR_HARDWARE_FAILURE );
147
Gilles Peskine9a944802018-06-21 09:35:35 +0200148 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
149 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
150 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
151 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
152 case MBEDTLS_ERR_ASN1_INVALID_DATA:
153 return( PSA_ERROR_INVALID_ARGUMENT );
154 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
155 return( PSA_ERROR_INSUFFICIENT_MEMORY );
156 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
157 return( PSA_ERROR_BUFFER_TOO_SMALL );
158
Jaeden Amero93e21112019-02-20 13:57:28 +0000159#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000160 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
162 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
163#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100164 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
165 return( PSA_ERROR_NOT_SUPPORTED );
166 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
167 return( PSA_ERROR_HARDWARE_FAILURE );
168
Jaeden Amero93e21112019-02-20 13:57:28 +0000169#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000170 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
172 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
173#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
175 return( PSA_ERROR_NOT_SUPPORTED );
176 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
177 return( PSA_ERROR_HARDWARE_FAILURE );
178
179 case MBEDTLS_ERR_CCM_BAD_INPUT:
180 return( PSA_ERROR_INVALID_ARGUMENT );
181 case MBEDTLS_ERR_CCM_AUTH_FAILED:
182 return( PSA_ERROR_INVALID_SIGNATURE );
183 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
184 return( PSA_ERROR_HARDWARE_FAILURE );
185
Gilles Peskine26869f22019-05-06 15:25:00 +0200186 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
187 return( PSA_ERROR_INVALID_ARGUMENT );
188
189 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
190 return( PSA_ERROR_BAD_STATE );
191 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
192 return( PSA_ERROR_INVALID_SIGNATURE );
193
Gilles Peskinea5905292018-02-07 20:59:33 +0100194 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
195 return( PSA_ERROR_NOT_SUPPORTED );
196 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
197 return( PSA_ERROR_INVALID_ARGUMENT );
198 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
199 return( PSA_ERROR_INSUFFICIENT_MEMORY );
200 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
201 return( PSA_ERROR_INVALID_PADDING );
202 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
203 return( PSA_ERROR_BAD_STATE );
204 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
205 return( PSA_ERROR_INVALID_SIGNATURE );
206 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200207 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
209 return( PSA_ERROR_HARDWARE_FAILURE );
210
211 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
214 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
215 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
216 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
217 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
218 return( PSA_ERROR_NOT_SUPPORTED );
219 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
220 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
221
222 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
223 return( PSA_ERROR_NOT_SUPPORTED );
224 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
225 return( PSA_ERROR_HARDWARE_FAILURE );
226
Gilles Peskinee59236f2018-01-27 23:32:46 +0100227 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
228 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
229 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
230 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100231
232 case MBEDTLS_ERR_GCM_AUTH_FAILED:
233 return( PSA_ERROR_INVALID_SIGNATURE );
234 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200235 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100236 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
237 return( PSA_ERROR_HARDWARE_FAILURE );
238
239 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
240 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
241 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
242 return( PSA_ERROR_HARDWARE_FAILURE );
243
244 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
245 return( PSA_ERROR_NOT_SUPPORTED );
246 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
247 return( PSA_ERROR_INVALID_ARGUMENT );
248 case MBEDTLS_ERR_MD_ALLOC_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_MEMORY );
250 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
251 return( PSA_ERROR_STORAGE_FAILURE );
252 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
253 return( PSA_ERROR_HARDWARE_FAILURE );
254
Gilles Peskinef76aa772018-10-29 19:24:33 +0100255 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
256 return( PSA_ERROR_STORAGE_FAILURE );
257 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
258 return( PSA_ERROR_INVALID_ARGUMENT );
259 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
262 return( PSA_ERROR_BUFFER_TOO_SMALL );
263 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
264 return( PSA_ERROR_INVALID_ARGUMENT );
265 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
268 return( PSA_ERROR_INVALID_ARGUMENT );
269 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
270 return( PSA_ERROR_INSUFFICIENT_MEMORY );
271
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100272 case MBEDTLS_ERR_PK_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
275 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100278 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100279 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
280 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
281 return( PSA_ERROR_INVALID_ARGUMENT );
282 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
283 return( PSA_ERROR_NOT_SUPPORTED );
284 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
285 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
286 return( PSA_ERROR_NOT_PERMITTED );
287 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_PK_INVALID_ALG:
290 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
291 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
292 return( PSA_ERROR_NOT_SUPPORTED );
293 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
294 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100295 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
296 return( PSA_ERROR_HARDWARE_FAILURE );
297
Gilles Peskineff2d2002019-05-06 15:26:23 +0200298 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
299 return( PSA_ERROR_HARDWARE_FAILURE );
300 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
301 return( PSA_ERROR_NOT_SUPPORTED );
302
Gilles Peskinea5905292018-02-07 20:59:33 +0100303 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
304 return( PSA_ERROR_HARDWARE_FAILURE );
305
306 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
307 return( PSA_ERROR_INVALID_ARGUMENT );
308 case MBEDTLS_ERR_RSA_INVALID_PADDING:
309 return( PSA_ERROR_INVALID_PADDING );
310 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
311 return( PSA_ERROR_HARDWARE_FAILURE );
312 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
313 return( PSA_ERROR_INVALID_ARGUMENT );
314 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
315 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200316 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100317 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
318 return( PSA_ERROR_INVALID_SIGNATURE );
319 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
320 return( PSA_ERROR_BUFFER_TOO_SMALL );
321 case MBEDTLS_ERR_RSA_RNG_FAILED:
322 return( PSA_ERROR_INSUFFICIENT_MEMORY );
323 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
324 return( PSA_ERROR_NOT_SUPPORTED );
325 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
326 return( PSA_ERROR_HARDWARE_FAILURE );
327
328 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
329 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
330 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
331 return( PSA_ERROR_HARDWARE_FAILURE );
332
333 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
334 return( PSA_ERROR_INVALID_ARGUMENT );
335 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
336 return( PSA_ERROR_HARDWARE_FAILURE );
337
itayzafrir5c753392018-05-08 11:18:38 +0300338 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300339 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300340 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300341 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
342 return( PSA_ERROR_BUFFER_TOO_SMALL );
343 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
344 return( PSA_ERROR_NOT_SUPPORTED );
345 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
346 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
347 return( PSA_ERROR_INVALID_SIGNATURE );
348 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
349 return( PSA_ERROR_INSUFFICIENT_MEMORY );
350 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
351 return( PSA_ERROR_HARDWARE_FAILURE );
Janos Follatha13b9052019-11-22 12:48:59 +0000352 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
353 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300354
Gilles Peskinee59236f2018-01-27 23:32:46 +0100355 default:
David Saadab4ecc272019-02-14 13:48:10 +0200356 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100357 }
358}
359
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200360
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200361
362
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100363/****************************************************************/
364/* Key management */
365/****************************************************************/
366
Gilles Peskine73167e12019-07-12 23:44:37 +0200367#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
368static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
369{
Gilles Peskine8e338702019-07-30 20:06:31 +0200370 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200371}
372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
373
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100374#if defined(MBEDTLS_ECP_C)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100375mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100376 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200377{
378 switch( curve )
379 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100380 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 switch( byte_length )
382 {
383 case PSA_BITS_TO_BYTES( 192 ):
384 return( MBEDTLS_ECP_DP_SECP192R1 );
385 case PSA_BITS_TO_BYTES( 224 ):
386 return( MBEDTLS_ECP_DP_SECP224R1 );
387 case PSA_BITS_TO_BYTES( 256 ):
388 return( MBEDTLS_ECP_DP_SECP256R1 );
389 case PSA_BITS_TO_BYTES( 384 ):
390 return( MBEDTLS_ECP_DP_SECP384R1 );
391 case PSA_BITS_TO_BYTES( 521 ):
392 return( MBEDTLS_ECP_DP_SECP521R1 );
393 default:
394 return( MBEDTLS_ECP_DP_NONE );
395 }
396 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100397
Paul Elliott8ff510a2020-06-02 17:19:28 +0100398 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100399 switch( byte_length )
400 {
401 case PSA_BITS_TO_BYTES( 256 ):
402 return( MBEDTLS_ECP_DP_BP256R1 );
403 case PSA_BITS_TO_BYTES( 384 ):
404 return( MBEDTLS_ECP_DP_BP384R1 );
405 case PSA_BITS_TO_BYTES( 512 ):
406 return( MBEDTLS_ECP_DP_BP512R1 );
407 default:
408 return( MBEDTLS_ECP_DP_NONE );
409 }
410 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100411
Paul Elliott8ff510a2020-06-02 17:19:28 +0100412 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 switch( byte_length )
414 {
415 case PSA_BITS_TO_BYTES( 255 ):
416 return( MBEDTLS_ECP_DP_CURVE25519 );
417 case PSA_BITS_TO_BYTES( 448 ):
418 return( MBEDTLS_ECP_DP_CURVE448 );
419 default:
420 return( MBEDTLS_ECP_DP_NONE );
421 }
422 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100423
Paul Elliott8ff510a2020-06-02 17:19:28 +0100424 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100425 switch( byte_length )
426 {
427 case PSA_BITS_TO_BYTES( 192 ):
428 return( MBEDTLS_ECP_DP_SECP192K1 );
429 case PSA_BITS_TO_BYTES( 224 ):
430 return( MBEDTLS_ECP_DP_SECP224K1 );
431 case PSA_BITS_TO_BYTES( 256 ):
432 return( MBEDTLS_ECP_DP_SECP256K1 );
433 default:
434 return( MBEDTLS_ECP_DP_NONE );
435 }
436 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100437
Gilles Peskine12313cd2018-06-20 00:20:32 +0200438 default:
439 return( MBEDTLS_ECP_DP_NONE );
440 }
441}
Darryl Green8f8aa8f2018-07-24 15:44:51 +0100442#endif /* defined(MBEDTLS_ECP_C) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200443
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200444static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
445 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446{
447 /* Check that the bit size is acceptable for the key type */
448 switch( type )
449 {
450 case PSA_KEY_TYPE_RAW_DATA:
451#if defined(MBEDTLS_MD_C)
452 case PSA_KEY_TYPE_HMAC:
Gilles Peskine46f1fd72018-06-28 19:31:31 +0200453#endif
Gilles Peskineea0fb492018-07-12 17:17:20 +0200454 case PSA_KEY_TYPE_DERIVE:
455 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456#if defined(MBEDTLS_AES_C)
457 case PSA_KEY_TYPE_AES:
458 if( bits != 128 && bits != 192 && bits != 256 )
459 return( PSA_ERROR_INVALID_ARGUMENT );
460 break;
461#endif
462#if defined(MBEDTLS_CAMELLIA_C)
463 case PSA_KEY_TYPE_CAMELLIA:
464 if( bits != 128 && bits != 192 && bits != 256 )
465 return( PSA_ERROR_INVALID_ARGUMENT );
466 break;
467#endif
468#if defined(MBEDTLS_DES_C)
469 case PSA_KEY_TYPE_DES:
470 if( bits != 64 && bits != 128 && bits != 192 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
474#if defined(MBEDTLS_ARC4_C)
475 case PSA_KEY_TYPE_ARC4:
476 if( bits < 8 || bits > 2048 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
478 break;
479#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200480#if defined(MBEDTLS_CHACHA20_C)
481 case PSA_KEY_TYPE_CHACHA20:
482 if( bits != 256 )
483 return( PSA_ERROR_INVALID_ARGUMENT );
484 break;
485#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200486 default:
487 return( PSA_ERROR_NOT_SUPPORTED );
488 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200489 if( bits % 8 != 0 )
490 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200491
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200492 return( PSA_SUCCESS );
493}
494
Steven Cooremana01795d2020-07-24 22:48:15 +0200495#if defined(MBEDTLS_RSA_C)
496
497#if defined(MBEDTLS_PK_PARSE_C)
Gilles Peskine86a440b2018-11-12 18:39:40 +0100498/* Mbed TLS doesn't support non-byte-aligned key sizes (i.e. key sizes
499 * that are not a multiple of 8) well. For example, there is only
500 * mbedtls_rsa_get_len(), which returns a number of bytes, and no
501 * way to return the exact bit size of a key.
502 * To keep things simple, reject non-byte-aligned key sizes. */
503static psa_status_t psa_check_rsa_key_byte_aligned(
504 const mbedtls_rsa_context *rsa )
505{
506 mbedtls_mpi n;
507 psa_status_t status;
508 mbedtls_mpi_init( &n );
509 status = mbedtls_to_psa_error(
510 mbedtls_rsa_export( rsa, &n, NULL, NULL, NULL, NULL ) );
511 if( status == PSA_SUCCESS )
512 {
513 if( mbedtls_mpi_bitlen( &n ) % 8 != 0 )
514 status = PSA_ERROR_NOT_SUPPORTED;
515 }
516 mbedtls_mpi_free( &n );
517 return( status );
518}
Steven Cooremana01795d2020-07-24 22:48:15 +0200519#endif /* MBEDTLS_PK_PARSE_C */
Gilles Peskine86a440b2018-11-12 18:39:40 +0100520
Steven Cooreman7f391872020-07-30 14:57:44 +0200521/** Load the contents of a key buffer into an internal RSA representation
Steven Cooremana01795d2020-07-24 22:48:15 +0200522 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200523 * \param[in] type The type of key contained in \p data.
524 * \param[in] data The buffer from which to load the representation.
525 * \param[in] data_length The size in bytes of \p data.
526 * \param[out] p_rsa Returns a pointer to an RSA context on success.
527 * The caller is responsible for freeing both the
528 * contents of the context and the context itself
529 * when done.
Steven Cooremana01795d2020-07-24 22:48:15 +0200530 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200531static psa_status_t psa_load_rsa_representation( psa_key_type_t type,
532 const uint8_t *data,
533 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200534 mbedtls_rsa_context **p_rsa )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200535{
Steven Cooremana01795d2020-07-24 22:48:15 +0200536#if defined(MBEDTLS_PK_PARSE_C)
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000537 psa_status_t status;
Steven Cooremana01795d2020-07-24 22:48:15 +0200538 mbedtls_pk_context ctx;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000539 size_t bits;
Steven Cooremana01795d2020-07-24 22:48:15 +0200540 mbedtls_pk_init( &ctx );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000541
542 /* Parse the data. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200543 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000544 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200545 mbedtls_pk_parse_key( &ctx, data, data_length, NULL, 0 ) );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200546 else
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000547 status = mbedtls_to_psa_error(
Steven Cooreman4fed4552020-08-03 14:46:03 +0200548 mbedtls_pk_parse_public_key( &ctx, data, data_length ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000549 if( status != PSA_SUCCESS )
550 goto exit;
551
552 /* We have something that the pkparse module recognizes. If it is a
553 * valid RSA key, store it. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200554 if( mbedtls_pk_get_type( &ctx ) != MBEDTLS_PK_RSA )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200555 {
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000556 status = PSA_ERROR_INVALID_ARGUMENT;
557 goto exit;
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200558 }
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000559
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000560 /* The size of an RSA key doesn't have to be a multiple of 8. Mbed TLS
561 * supports non-byte-aligned key sizes, but not well. For example,
562 * mbedtls_rsa_get_len() returns the key size in bytes, not in bits. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200563 bits = PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( mbedtls_pk_rsa( ctx ) ) );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000564 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
565 {
566 status = PSA_ERROR_NOT_SUPPORTED;
567 goto exit;
568 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200569 status = psa_check_rsa_key_byte_aligned( mbedtls_pk_rsa( ctx ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200570 if( status != PSA_SUCCESS )
571 goto exit;
572
Steven Cooremana2371e52020-07-28 14:30:39 +0200573 /* Copy out the pointer to the RSA context, and reset the PK context
574 * such that pk_free doesn't free the RSA context we just grabbed. */
575 *p_rsa = mbedtls_pk_rsa( ctx );
576 ctx.pk_info = NULL;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000577
578exit:
Steven Cooremana01795d2020-07-24 22:48:15 +0200579 mbedtls_pk_free( &ctx );
580 return( status );
581#else
Steven Cooreman4fed4552020-08-03 14:46:03 +0200582 (void) data;
583 (void) data_length;
Steven Cooreman7f391872020-07-30 14:57:44 +0200584 (void) type;
Steven Cooremana01795d2020-07-24 22:48:15 +0200585 (void) rsa;
586 return( PSA_ERROR_NOT_SUPPORTED );
587#endif /* MBEDTLS_PK_PARSE_C */
588}
589
590/** Export an RSA key to export representation
591 *
592 * \param[in] type The type of key (public/private) to export
593 * \param[in] rsa The internal RSA representation from which to export
594 * \param[out] data The buffer to export to
595 * \param[in] data_size The length of the buffer to export to
596 * \param[out] data_length The amount of bytes written to \p data
597 */
598static psa_status_t psa_export_rsa_key( psa_key_type_t type,
599 mbedtls_rsa_context *rsa,
600 uint8_t *data,
601 size_t data_size,
602 size_t *data_length )
603{
604#if defined(MBEDTLS_PK_WRITE_C)
605 int ret;
606 mbedtls_pk_context pk;
607 uint8_t *pos = data + data_size;
608
609 mbedtls_pk_init( &pk );
610 pk.pk_info = &mbedtls_rsa_info;
611 pk.pk_ctx = rsa;
612
613 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200614 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
615 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200616 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
617 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
618 else
619 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
620
621 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200622 {
623 /* Clean up in case pk_write failed halfway through. */
624 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200625 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200626 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200627
628 /* The mbedtls_pk_xxx functions write to the end of the buffer.
629 * Move the data to the beginning and erase remaining data
630 * at the original location. */
631 if( 2 * (size_t) ret <= data_size )
632 {
633 memcpy( data, data + data_size - ret, ret );
634 memset( data + data_size - ret, 0, ret );
635 }
636 else if( (size_t) ret < data_size )
637 {
638 memmove( data, data + data_size - ret, ret );
639 memset( data + ret, 0, data_size - ret );
640 }
641
642 *data_length = ret;
643 return( PSA_SUCCESS );
644#else
645 (void) type;
646 (void) rsa;
647 (void) data;
648 (void) data_size;
649 (void) data_length;
650 return( PSA_ERROR_NOT_SUPPORTED );
651#endif /* MBEDTLS_PK_WRITE_C */
652}
653
654/** Import an RSA key from import representation to a slot
655 *
656 * \param[in,out] slot The slot where to store the export representation to
657 * \param[in] data The buffer containing the import representation
658 * \param[in] data_length The amount of bytes in \p data
659 */
660static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
661 const uint8_t *data,
662 size_t data_length )
663{
664 psa_status_t status;
665 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200666 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200667
Steven Cooremana01795d2020-07-24 22:48:15 +0200668 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200669 status = psa_load_rsa_representation( slot->attr.type,
670 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200671 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200672 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200673 if( status != PSA_SUCCESS )
674 goto exit;
675
676 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200677 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200678
Steven Cooreman75b74362020-07-28 14:30:13 +0200679 /* Re-export the data to PSA export format, such that we can store export
680 * representation in the key slot. Export representation in case of RSA is
681 * the smallest representation that's allowed as input, so a straight-up
682 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200683 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200684 if( output == NULL )
685 {
686 status = PSA_ERROR_INSUFFICIENT_MEMORY;
687 goto exit;
688 }
689
Steven Cooremana01795d2020-07-24 22:48:15 +0200690 status = psa_export_rsa_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200691 rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +0200692 output,
693 data_length,
694 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200695exit:
696 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200697 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200698 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200699
700 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000701 if( status != PSA_SUCCESS )
702 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200703 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000704 return( status );
705 }
706
Steven Cooremana01795d2020-07-24 22:48:15 +0200707 /* On success, store the allocated export-formatted key. */
708 slot->data.key.data = output;
709 slot->data.key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000710
711 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200712}
Steven Cooremana01795d2020-07-24 22:48:15 +0200713#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200714
Jaeden Ameroccdce902019-01-10 11:42:27 +0000715#if defined(MBEDTLS_ECP_C)
Steven Cooreman7f391872020-07-30 14:57:44 +0200716/** Load the contents of a key buffer into an internal ECP representation
Steven Cooremana2371e52020-07-28 14:30:39 +0200717 *
Steven Cooreman4fed4552020-08-03 14:46:03 +0200718 * \param[in] type The type of key contained in \p data.
719 * \param[in] data The buffer from which to load the representation.
720 * \param[in] data_length The size in bytes of \p data.
721 * \param[out] p_ecp Returns a pointer to an ECP context on success.
722 * The caller is responsible for freeing both the
723 * contents of the context and the context itself
724 * when done.
Steven Cooremana2371e52020-07-28 14:30:39 +0200725 */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200726static psa_status_t psa_load_ecp_representation( psa_key_type_t type,
727 const uint8_t *data,
728 size_t data_length,
Steven Cooremana2371e52020-07-28 14:30:39 +0200729 mbedtls_ecp_keypair **p_ecp )
Gilles Peskine4cd32772019-12-02 20:49:42 +0100730{
731 mbedtls_ecp_group_id grp_id = MBEDTLS_ECP_DP_NONE;
Steven Cooremanacda8342020-07-24 23:09:52 +0200732 psa_status_t status;
Steven Cooreman6d839f02020-07-30 11:36:45 +0200733 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +0200734 size_t curve_size = data_length;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100735
Steven Cooreman4fed4552020-08-03 14:46:03 +0200736 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) &&
737 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) != PSA_ECC_FAMILY_MONTGOMERY )
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100738 {
Steven Cooreman4fed4552020-08-03 14:46:03 +0200739 /* A Weierstrass public key is represented as:
740 * - The byte 0x04;
741 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
742 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
743 * So its data length is 2m+1 where n is the key size in bits.
744 */
745 if( ( data_length & 1 ) == 0 )
746 return( PSA_ERROR_INVALID_ARGUMENT );
747 curve_size = data_length / 2;
748
749 /* Montgomery public keys are represented in compressed format, meaning
750 * their curve_size is equal to the amount of input. */
751
752 /* Private keys are represented in uncompressed private random integer
753 * format, meaning their curve_size is equal to the amount of input. */
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100754 }
755
Steven Cooreman6d839f02020-07-30 11:36:45 +0200756 /* Allocate and initialize a key representation. */
Steven Cooreman29149862020-08-05 15:43:42 +0200757 ecp = mbedtls_calloc( 1, sizeof( mbedtls_ecp_keypair ) );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200758 if( ecp == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200759 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooremana2371e52020-07-28 14:30:39 +0200760 mbedtls_ecp_keypair_init( ecp );
761
Gilles Peskine4cd32772019-12-02 20:49:42 +0100762 /* Load the group. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200763 grp_id = mbedtls_ecc_group_of_psa( PSA_KEY_TYPE_ECC_GET_FAMILY( type ),
764 curve_size );
Gilles Peskine4295e8b2019-12-02 21:39:10 +0100765 if( grp_id == MBEDTLS_ECP_DP_NONE )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200766 {
767 status = PSA_ERROR_INVALID_ARGUMENT;
768 goto exit;
769 }
770
Steven Cooremanacda8342020-07-24 23:09:52 +0200771 status = mbedtls_to_psa_error(
772 mbedtls_ecp_group_load( &ecp->grp, grp_id ) );
773 if( status != PSA_SUCCESS )
Steven Cooreman6d839f02020-07-30 11:36:45 +0200774 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200775
Steven Cooreman6d839f02020-07-30 11:36:45 +0200776 /* Load the key material. */
Steven Cooreman7f391872020-07-30 14:57:44 +0200777 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200778 {
779 /* Load the public value. */
780 status = mbedtls_to_psa_error(
781 mbedtls_ecp_point_read_binary( &ecp->grp, &ecp->Q,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200782 data,
783 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200784 if( status != PSA_SUCCESS )
785 goto exit;
786
787 /* Check that the point is on the curve. */
788 status = mbedtls_to_psa_error(
789 mbedtls_ecp_check_pubkey( &ecp->grp, &ecp->Q ) );
790 if( status != PSA_SUCCESS )
791 goto exit;
792 }
793 else
794 {
Steven Cooreman6d839f02020-07-30 11:36:45 +0200795 /* Load and validate the secret value. */
Steven Cooremanacda8342020-07-24 23:09:52 +0200796 status = mbedtls_to_psa_error(
797 mbedtls_ecp_read_key( ecp->grp.id,
798 ecp,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200799 data,
800 data_length ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200801 if( status != PSA_SUCCESS )
802 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +0200803 }
Steven Cooremana2371e52020-07-28 14:30:39 +0200804
805 *p_ecp = ecp;
Steven Cooremanacda8342020-07-24 23:09:52 +0200806exit:
807 if( status != PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +0200808 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200809 mbedtls_ecp_keypair_free( ecp );
Steven Cooremana2371e52020-07-28 14:30:39 +0200810 mbedtls_free( ecp );
811 }
812
Steven Cooreman29149862020-08-05 15:43:42 +0200813 return( status );
Gilles Peskine4cd32772019-12-02 20:49:42 +0100814}
Jaeden Ameroccdce902019-01-10 11:42:27 +0000815
Steven Cooreman4fed4552020-08-03 14:46:03 +0200816/** Export an ECP key to export representation
817 *
818 * \param[in] type The type of key (public/private) to export
819 * \param[in] ecp The internal ECP representation from which to export
820 * \param[out] data The buffer to export to
821 * \param[in] data_size The length of the buffer to export to
822 * \param[out] data_length The amount of bytes written to \p data
823 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200824static psa_status_t psa_export_ecp_key( psa_key_type_t type,
825 mbedtls_ecp_keypair *ecp,
826 uint8_t *data,
827 size_t data_size,
828 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200829{
Steven Cooremanacda8342020-07-24 23:09:52 +0200830 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000831
Steven Cooremanacda8342020-07-24 23:09:52 +0200832 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200833 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200834 /* Check whether the public part is loaded */
835 if( mbedtls_ecp_is_zero( &ecp->Q ) )
836 {
837 /* Calculate the public key */
838 status = mbedtls_to_psa_error(
839 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
840 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
841 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200842 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200843 }
844
Steven Cooreman4fed4552020-08-03 14:46:03 +0200845 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200846 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
847 MBEDTLS_ECP_PF_UNCOMPRESSED,
848 data_length,
849 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200850 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200851 if( status != PSA_SUCCESS )
852 memset( data, 0, data_size );
853
Steven Cooreman29149862020-08-05 15:43:42 +0200854 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200855 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200856 else
857 {
Steven Cooreman29149862020-08-05 15:43:42 +0200858 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200859 return( PSA_ERROR_BUFFER_TOO_SMALL );
860
861 status = mbedtls_to_psa_error(
862 mbedtls_ecp_write_key( ecp,
863 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200864 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200865 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200866 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200867 else
868 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200869
870 return( status );
871 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200872}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200873
Steven Cooreman4fed4552020-08-03 14:46:03 +0200874/** Import an ECP key from import representation to a slot
875 *
876 * \param[in,out] slot The slot where to store the export representation to
877 * \param[in] data The buffer containing the import representation
878 * \param[in] data_length The amount of bytes in \p data
879 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200880static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
881 const uint8_t *data,
882 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100883{
Steven Cooremanacda8342020-07-24 23:09:52 +0200884 psa_status_t status;
885 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200886 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100887
Steven Cooremanacda8342020-07-24 23:09:52 +0200888 /* Parse input */
Steven Cooreman4fed4552020-08-03 14:46:03 +0200889 status = psa_load_ecp_representation( slot->attr.type,
890 data,
Steven Cooreman7f391872020-07-30 14:57:44 +0200891 data_length,
Steven Cooreman7f391872020-07-30 14:57:44 +0200892 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100893 if( status != PSA_SUCCESS )
894 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100895
Steven Cooremanacda8342020-07-24 23:09:52 +0200896 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200897 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200898 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200899 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200900
Steven Cooremanacda8342020-07-24 23:09:52 +0200901 /* Re-export the data to PSA export format. There is currently no support
902 * for other input formats then the export format, so this is a 1-1
903 * copy operation. */
904 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200905 if( output == NULL )
906 {
907 status = PSA_ERROR_INSUFFICIENT_MEMORY;
908 goto exit;
909 }
910
911 status = psa_export_ecp_key( slot->attr.type,
Steven Cooremana2371e52020-07-28 14:30:39 +0200912 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +0200913 output,
914 data_length,
915 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100916exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200917 /* Always free the PK object (will also free contained ECP context) */
918 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200919 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200920
921 /* Free the allocated buffer only on error. */
922 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100923 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200924 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200925 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100926 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200927
928 /* On success, store the allocated export-formatted key. */
929 slot->data.key.data = output;
930 slot->data.key.bytes = data_length;
931
932 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100933}
934#endif /* defined(MBEDTLS_ECP_C) */
935
Gilles Peskineb46bef22019-07-30 21:32:04 +0200936/** Return the size of the key in the given slot, in bits.
937 *
938 * \param[in] slot A key slot.
939 *
940 * \return The key size in bits, read from the metadata in the slot.
941 */
942static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
943{
944 return( slot->attr.bits );
945}
946
Steven Cooreman75b74362020-07-28 14:30:13 +0200947/** Try to allocate a buffer to an empty key slot.
948 *
949 * \param[in,out] slot Key slot to attach buffer to.
950 * \param[in] buffer_length Requested size of the buffer.
951 *
952 * \retval #PSA_SUCCESS
953 * The buffer has been successfully allocated.
954 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
955 * Not enough memory was available for allocation.
956 * \retval #PSA_ERROR_ALREADY_EXISTS
957 * Trying to allocate a buffer to a non-empty key slot.
958 */
959static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
960 size_t buffer_length )
961{
962 if( slot->data.key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200963 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200964
965 slot->data.key.data = mbedtls_calloc( 1, buffer_length );
966 if( slot->data.key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200967 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200968
969 slot->data.key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200970 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200971}
972
Gilles Peskine8e338702019-07-30 20:06:31 +0200973/** Import key data into a slot. `slot->attr.type` must have been set
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100974 * previously. This function assumes that the slot does not contain
975 * any key material yet. On failure, the slot content is unchanged. */
Gilles Peskinefa4135b2018-12-10 16:48:53 +0100976psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
977 const uint8_t *data,
978 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100979{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200980 psa_status_t status = PSA_SUCCESS;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100981
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200982 /* zero-length keys are never supported. */
983 if( data_length == 0 )
984 return( PSA_ERROR_NOT_SUPPORTED );
985
Gilles Peskine8e338702019-07-30 20:06:31 +0200986 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100987 {
Gilles Peskinec744d992019-07-30 17:26:54 +0200988 size_t bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200989
Steven Cooreman75b74362020-07-28 14:30:13 +0200990 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
991 if( data_length > SIZE_MAX / 8 )
992 return( PSA_ERROR_NOT_SUPPORTED );
993
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200994 /* Enforce a size limit, and in particular ensure that the bit
995 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200996 if( bit_size > PSA_MAX_KEY_BITS )
997 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200998
999 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +02001000 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001001 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001002
1003 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02001004 status = psa_allocate_buffer_to_slot( slot, data_length );
1005 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001006 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001007
1008 /* copy key into allocated buffer */
Steven Cooreman29149862020-08-05 15:43:42 +02001009 memcpy( slot->data.key.data, data, data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02001010
1011 /* Write the actual key size to the slot.
1012 * psa_start_key_creation() wrote the size declared by the
1013 * caller, which may be 0 (meaning unspecified) or wrong. */
1014 slot->attr.bits = (psa_key_bits_t) bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001015 }
Steven Cooreman19fd5742020-07-24 23:31:01 +02001016 else if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
1017 {
Gilles Peskinef76aa772018-10-29 19:24:33 +01001018#if defined(MBEDTLS_ECP_C)
Steven Cooreman19fd5742020-07-24 23:31:01 +02001019 status = psa_import_ecp_key( slot,
1020 data, data_length );
1021#else
1022 /* No drivers have been implemented yet, so without mbed TLS backing
1023 * there's no way to do ECP with the current library. */
1024 return( PSA_ERROR_NOT_SUPPORTED );
1025#endif /* defined(MBEDTLS_ECP_C) */
1026 }
1027 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskinef76aa772018-10-29 19:24:33 +01001028 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001029#if defined(MBEDTLS_RSA_C)
1030 status = psa_import_rsa_key( slot,
1031 data, data_length );
1032#else
1033 /* No drivers have been implemented yet, so without mbed TLS backing
1034 * there's no way to do RSA with the current library. */
1035 status = PSA_ERROR_NOT_SUPPORTED;
1036#endif /* defined(MBEDTLS_RSA_C) */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001037 }
1038 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +01001039 {
Steven Cooreman19fd5742020-07-24 23:31:01 +02001040 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001041 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +01001042 }
Darryl Green940d72c2018-07-13 13:18:51 +01001043
Darryl Green06fd18d2018-07-16 11:21:11 +01001044 return( status );
1045}
1046
Gilles Peskinef603c712019-01-19 13:40:11 +01001047/** Calculate the intersection of two algorithm usage policies.
1048 *
1049 * Return 0 (which allows no operation) on incompatibility.
1050 */
1051static psa_algorithm_t psa_key_policy_algorithm_intersection(
1052 psa_algorithm_t alg1,
1053 psa_algorithm_t alg2 )
1054{
Gilles Peskine549ea862019-05-22 11:45:59 +02001055 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +01001056 if( alg1 == alg2 )
1057 return( alg1 );
1058 /* If the policies are from the same hash-and-sign family, check
1059 * if one is a wildcard. If so the other has the specific algorithm. */
1060 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
1061 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
1062 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
1063 {
1064 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
1065 return( alg2 );
1066 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
1067 return( alg1 );
1068 }
1069 /* If the policies are incompatible, allow nothing. */
1070 return( 0 );
1071}
1072
Gilles Peskined6f371b2019-05-10 19:33:38 +02001073static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
1074 psa_algorithm_t requested_alg )
1075{
Gilles Peskine549ea862019-05-22 11:45:59 +02001076 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001077 if( requested_alg == policy_alg )
1078 return( 1 );
1079 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +02001080 * and requested_alg is the same hash-and-sign family with any hash,
1081 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001082 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1083 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1084 {
1085 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1086 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1087 }
1088 /* If it isn't permitted, it's forbidden. */
1089 return( 0 );
1090}
1091
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001092/** Test whether a policy permits an algorithm.
1093 *
1094 * The caller must test usage flags separately.
1095 */
1096static int psa_key_policy_permits( const psa_key_policy_t *policy,
1097 psa_algorithm_t alg )
1098{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001099 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1100 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001101}
1102
Gilles Peskinef603c712019-01-19 13:40:11 +01001103/** Restrict a key policy based on a constraint.
1104 *
1105 * \param[in,out] policy The policy to restrict.
1106 * \param[in] constraint The policy constraint to apply.
1107 *
1108 * \retval #PSA_SUCCESS
1109 * \c *policy contains the intersection of the original value of
1110 * \c *policy and \c *constraint.
1111 * \retval #PSA_ERROR_INVALID_ARGUMENT
1112 * \c *policy and \c *constraint are incompatible.
1113 * \c *policy is unchanged.
1114 */
1115static psa_status_t psa_restrict_key_policy(
1116 psa_key_policy_t *policy,
1117 const psa_key_policy_t *constraint )
1118{
1119 psa_algorithm_t intersection_alg =
1120 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001121 psa_algorithm_t intersection_alg2 =
1122 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001123 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1124 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001125 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1126 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001127 policy->usage &= constraint->usage;
1128 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001129 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001130 return( PSA_SUCCESS );
1131}
1132
Darryl Green06fd18d2018-07-16 11:21:11 +01001133/** Retrieve a slot which must contain a key. The key must have allow all the
1134 * usage flags set in \p usage. If \p alg is nonzero, the key must allow
1135 * operations with this algorithm. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001136static psa_status_t psa_get_key_from_slot( psa_key_handle_t handle,
Gilles Peskine2f060a82018-12-04 17:12:32 +01001137 psa_key_slot_t **p_slot,
Darryl Green06fd18d2018-07-16 11:21:11 +01001138 psa_key_usage_t usage,
1139 psa_algorithm_t alg )
1140{
1141 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001142 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001143
1144 *p_slot = NULL;
1145
Gilles Peskinec5487a82018-12-03 18:08:14 +01001146 status = psa_get_key_slot( handle, &slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001147 if( status != PSA_SUCCESS )
1148 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001149
1150 /* Enforce that usage policy for the key slot contains all the flags
1151 * required by the usage parameter. There is one exception: public
1152 * keys can always be exported, so we treat public key objects as
1153 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001154 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001155 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine8e338702019-07-30 20:06:31 +02001156 if( ( slot->attr.policy.usage & usage ) != usage )
Darryl Green06fd18d2018-07-16 11:21:11 +01001157 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001158
1159 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001160 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001161 return( PSA_ERROR_NOT_PERMITTED );
1162
1163 *p_slot = slot;
1164 return( PSA_SUCCESS );
1165}
Darryl Green940d72c2018-07-13 13:18:51 +01001166
Gilles Peskine28f8f302019-07-24 13:30:31 +02001167/** Retrieve a slot which must contain a transparent key.
1168 *
1169 * A transparent key is a key for which the key material is directly
1170 * available, as opposed to a key in a secure element.
1171 *
Gilles Peskine60450a42019-07-25 11:32:45 +02001172 * This is a temporary function to use instead of psa_get_key_from_slot()
1173 * until secure element support is fully implemented.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001174 */
1175#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1176static psa_status_t psa_get_transparent_key( psa_key_handle_t handle,
1177 psa_key_slot_t **p_slot,
1178 psa_key_usage_t usage,
1179 psa_algorithm_t alg )
1180{
1181 psa_status_t status = psa_get_key_from_slot( handle, p_slot, usage, alg );
1182 if( status != PSA_SUCCESS )
1183 return( status );
Gilles Peskineadad8132019-07-25 11:31:23 +02001184 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001185 {
1186 *p_slot = NULL;
1187 return( PSA_ERROR_NOT_SUPPORTED );
1188 }
1189 return( PSA_SUCCESS );
1190}
1191#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1192/* With no secure element support, all keys are transparent. */
1193#define psa_get_transparent_key( handle, p_slot, usage, alg ) \
1194 psa_get_key_from_slot( handle, p_slot, usage, alg )
1195#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1196
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001197/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001198static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001199{
Gilles Peskine73167e12019-07-12 23:44:37 +02001200#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1201 if( psa_key_slot_is_external( slot ) )
Darryl Green40225ba2018-11-15 14:48:15 +00001202 {
1203 /* No key material to clean. */
1204 }
Gilles Peskine73167e12019-07-12 23:44:37 +02001205 else
1206#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Darryl Green40225ba2018-11-15 14:48:15 +00001207 {
Steven Cooremanfd4d69a2020-08-05 15:46:33 +02001208 /* Data pointer will always be either a valid pointer or NULL in an
1209 * initialized slot, so we can just free it. */
1210 if( slot->data.key.data != NULL )
1211 mbedtls_platform_zeroize( slot->data.key.data, slot->data.key.bytes);
Steven Cooremana01795d2020-07-24 22:48:15 +02001212 mbedtls_free( slot->data.key.data );
1213 slot->data.key.data = NULL;
1214 slot->data.key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001215 }
Darryl Green40225ba2018-11-15 14:48:15 +00001216
1217 return( PSA_SUCCESS );
1218}
1219
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001220/** Completely wipe a slot in memory, including its policy.
1221 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001222psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001223{
1224 psa_status_t status = psa_remove_key_data_from_memory( slot );
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001225 /* Multipart operations may still be using the key. This is safe
1226 * because all multipart operation objects are independent from
1227 * the key slot: if they need to access the key after the setup
1228 * phase, they have a copy of the key. Note that this means that
1229 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001230 /* At this point, key material and other type-specific content has
1231 * been wiped. Clear remaining metadata. We can call memset and not
1232 * zeroize because the metadata is not particularly sensitive. */
1233 memset( slot, 0, sizeof( *slot ) );
1234 return( status );
1235}
1236
Gilles Peskinec5487a82018-12-03 18:08:14 +01001237psa_status_t psa_destroy_key( psa_key_handle_t handle )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001238{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001239 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001240 psa_status_t status; /* status of the last operation */
1241 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001242#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1243 psa_se_drv_table_entry_t *driver;
1244#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001245
Gilles Peskine1841cf42019-10-08 15:48:25 +02001246 if( handle == 0 )
1247 return( PSA_SUCCESS );
1248
Gilles Peskinec5487a82018-12-03 18:08:14 +01001249 status = psa_get_key_slot( handle, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001250 if( status != PSA_SUCCESS )
1251 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001252
1253#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001254 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001255 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001256 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001257 /* For a key in a secure element, we need to do three things:
1258 * remove the key file in internal storage, destroy the
1259 * key inside the secure element, and update the driver's
1260 * persistent data. Start a transaction that will encompass these
1261 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001262 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001263 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskinefc762652019-07-22 19:30:34 +02001264 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
Gilles Peskine8e338702019-07-30 20:06:31 +02001265 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001266 status = psa_crypto_save_transaction( );
1267 if( status != PSA_SUCCESS )
1268 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001269 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001270 /* We should still try to destroy the key in the secure
1271 * element and the key metadata in storage. This is especially
1272 * important if the error is that the storage is full.
1273 * But how to do it exactly without risking an inconsistent
1274 * state after a reset?
1275 * https://github.com/ARMmbed/mbed-crypto/issues/215
1276 */
1277 overall_status = status;
1278 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001279 }
1280
Gilles Peskine354f7672019-07-12 23:46:38 +02001281 status = psa_destroy_se_key( driver, slot->data.se.slot_number );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001282 if( overall_status == PSA_SUCCESS )
1283 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001284 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001285#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1286
Darryl Greend49a4992018-06-18 17:27:26 +01001287#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskinecaec2782019-08-13 15:11:49 +02001288 if( slot->attr.lifetime != PSA_KEY_LIFETIME_VOLATILE )
Darryl Greend49a4992018-06-18 17:27:26 +01001289 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001290 status = psa_destroy_persistent_key( slot->attr.id );
1291 if( overall_status == PSA_SUCCESS )
1292 overall_status = status;
1293
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001294 /* TODO: other slots may have a copy of the same key. We should
1295 * invalidate them.
1296 * https://github.com/ARMmbed/mbed-crypto/issues/214
1297 */
Darryl Greend49a4992018-06-18 17:27:26 +01001298 }
1299#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001300
Gilles Peskinefc762652019-07-22 19:30:34 +02001301#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1302 if( driver != NULL )
1303 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001304 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001305 if( overall_status == PSA_SUCCESS )
1306 overall_status = status;
1307 status = psa_crypto_stop_transaction( );
1308 if( overall_status == PSA_SUCCESS )
1309 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001310 }
1311#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1312
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001313#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1314exit:
1315#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001316 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001317 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1318 if( overall_status == PSA_SUCCESS )
1319 overall_status = status;
1320 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001321}
1322
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001323void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001324{
Gilles Peskineb699f072019-04-26 16:06:02 +02001325 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001326 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001327}
1328
Gilles Peskineb699f072019-04-26 16:06:02 +02001329psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1330 psa_key_type_t type,
1331 const uint8_t *data,
1332 size_t data_length )
1333{
1334 uint8_t *copy = NULL;
1335
1336 if( data_length != 0 )
1337 {
1338 copy = mbedtls_calloc( 1, data_length );
1339 if( copy == NULL )
1340 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1341 memcpy( copy, data, data_length );
1342 }
1343 /* After this point, this function is guaranteed to succeed, so it
1344 * can start modifying `*attributes`. */
1345
1346 if( attributes->domain_parameters != NULL )
1347 {
1348 mbedtls_free( attributes->domain_parameters );
1349 attributes->domain_parameters = NULL;
1350 attributes->domain_parameters_size = 0;
1351 }
1352
1353 attributes->domain_parameters = copy;
1354 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001355 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001356 return( PSA_SUCCESS );
1357}
1358
1359psa_status_t psa_get_key_domain_parameters(
1360 const psa_key_attributes_t *attributes,
1361 uint8_t *data, size_t data_size, size_t *data_length )
1362{
1363 if( attributes->domain_parameters_size > data_size )
1364 return( PSA_ERROR_BUFFER_TOO_SMALL );
1365 *data_length = attributes->domain_parameters_size;
1366 if( attributes->domain_parameters_size != 0 )
1367 memcpy( data, attributes->domain_parameters,
1368 attributes->domain_parameters_size );
1369 return( PSA_SUCCESS );
1370}
1371
1372#if defined(MBEDTLS_RSA_C)
1373static psa_status_t psa_get_rsa_public_exponent(
1374 const mbedtls_rsa_context *rsa,
1375 psa_key_attributes_t *attributes )
1376{
1377 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001378 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001379 uint8_t *buffer = NULL;
1380 size_t buflen;
1381 mbedtls_mpi_init( &mpi );
1382
1383 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1384 if( ret != 0 )
1385 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001386 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1387 {
1388 /* It's the default value, which is reported as an empty string,
1389 * so there's nothing to do. */
1390 goto exit;
1391 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001392
1393 buflen = mbedtls_mpi_size( &mpi );
1394 buffer = mbedtls_calloc( 1, buflen );
1395 if( buffer == NULL )
1396 {
1397 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1398 goto exit;
1399 }
1400 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1401 if( ret != 0 )
1402 goto exit;
1403 attributes->domain_parameters = buffer;
1404 attributes->domain_parameters_size = buflen;
1405
1406exit:
1407 mbedtls_mpi_free( &mpi );
1408 if( ret != 0 )
1409 mbedtls_free( buffer );
1410 return( mbedtls_to_psa_error( ret ) );
1411}
1412#endif /* MBEDTLS_RSA_C */
1413
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001414/** Retrieve all the publicly-accessible attributes of a key.
1415 */
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001416psa_status_t psa_get_key_attributes( psa_key_handle_t handle,
1417 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001418{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001419 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001420 psa_status_t status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001421
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001422 psa_reset_key_attributes( attributes );
1423
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001424 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001425 if( status != PSA_SUCCESS )
1426 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001427
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001428 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001429 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1430 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1431
1432#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1433 if( psa_key_slot_is_external( slot ) )
1434 psa_set_key_slot_number( attributes, slot->data.se.slot_number );
1435#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001436
Gilles Peskine8e338702019-07-30 20:06:31 +02001437 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001438 {
1439#if defined(MBEDTLS_RSA_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001440 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001441 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001442#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001443 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001444 * is not yet implemented.
1445 * https://github.com/ARMmbed/mbed-crypto/issues/216
1446 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001447 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001448 break;
1449#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001450 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001451 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001452
Steven Cooreman4fed4552020-08-03 14:46:03 +02001453 status = psa_load_rsa_representation( slot->attr.type,
1454 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02001455 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001456 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001457 if( status != PSA_SUCCESS )
1458 break;
1459
Steven Cooremana2371e52020-07-28 14:30:39 +02001460 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001461 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001462 mbedtls_rsa_free( rsa );
1463 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001464 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001465 break;
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001466#endif /* MBEDTLS_RSA_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001467 default:
1468 /* Nothing else to do. */
1469 break;
1470 }
1471
1472 if( status != PSA_SUCCESS )
1473 psa_reset_key_attributes( attributes );
1474 return( status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001475}
1476
Gilles Peskinec8000c02019-08-02 20:15:51 +02001477#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1478psa_status_t psa_get_key_slot_number(
1479 const psa_key_attributes_t *attributes,
1480 psa_key_slot_number_t *slot_number )
1481{
1482 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1483 {
1484 *slot_number = attributes->slot_number;
1485 return( PSA_SUCCESS );
1486 }
1487 else
1488 return( PSA_ERROR_INVALID_ARGUMENT );
1489}
1490#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1491
Steven Cooremana01795d2020-07-24 22:48:15 +02001492static psa_status_t psa_internal_export_key_buffer( const psa_key_slot_t *slot,
1493 uint8_t *data,
1494 size_t data_size,
1495 size_t *data_length )
1496{
1497 if( slot->data.key.bytes > data_size )
1498 return( PSA_ERROR_BUFFER_TOO_SMALL );
1499 memcpy( data, slot->data.key.data, slot->data.key.bytes );
1500 memset( data + slot->data.key.bytes, 0,
1501 data_size - slot->data.key.bytes );
1502 *data_length = slot->data.key.bytes;
1503 return( PSA_SUCCESS );
1504}
1505
Gilles Peskinef603c712019-01-19 13:40:11 +01001506static psa_status_t psa_internal_export_key( const psa_key_slot_t *slot,
1507 uint8_t *data,
1508 size_t data_size,
1509 size_t *data_length,
1510 int export_public_key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001511{
Gilles Peskine5d309672019-07-12 23:47:28 +02001512#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1513 const psa_drv_se_t *drv;
1514 psa_drv_se_context_t *drv_context;
1515#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1516
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001517 *data_length = 0;
1518
Gilles Peskine8e338702019-07-30 20:06:31 +02001519 if( export_public_key && ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Moran Pekera998bc62018-04-16 18:16:20 +03001520 return( PSA_ERROR_INVALID_ARGUMENT );
mohammad160306e79202018-03-28 13:17:44 +03001521
Gilles Peskinef9168942019-09-12 19:20:29 +02001522 /* Reject a zero-length output buffer now, since this can never be a
1523 * valid key representation. This way we know that data must be a valid
1524 * pointer and we can do things like memset(data, ..., data_size). */
1525 if( data_size == 0 )
1526 return( PSA_ERROR_BUFFER_TOO_SMALL );
1527
Gilles Peskine5d309672019-07-12 23:47:28 +02001528#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001529 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
Gilles Peskine5d309672019-07-12 23:47:28 +02001530 {
1531 psa_drv_se_export_key_t method;
1532 if( drv->key_management == NULL )
1533 return( PSA_ERROR_NOT_SUPPORTED );
1534 method = ( export_public_key ?
1535 drv->key_management->p_export_public :
1536 drv->key_management->p_export );
1537 if( method == NULL )
1538 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2e0f3882019-07-25 11:34:33 +02001539 return( method( drv_context,
1540 slot->data.se.slot_number,
1541 data, data_size, data_length ) );
Gilles Peskine5d309672019-07-12 23:47:28 +02001542 }
1543#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1544
Gilles Peskine8e338702019-07-30 20:06:31 +02001545 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001546 {
Steven Cooremanacda8342020-07-24 23:09:52 +02001547 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
Gilles Peskine188c71e2018-10-29 19:26:02 +01001548 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001549 else if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) ||
1550 PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001551 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001552 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001553 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001554 /* Exporting public -> public */
1555 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1556 }
1557 else if( !export_public_key )
1558 {
1559 /* Exporting private -> private */
1560 return( psa_internal_export_key_buffer( slot, data, data_size, data_length ) );
1561 }
1562 /* Need to export the public part of a private key,
1563 * so conversion is needed */
1564 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
1565 {
Darryl Green9e2d7a02018-07-24 16:33:30 +01001566#if defined(MBEDTLS_RSA_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001567 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001568 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001569 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001570 slot->data.key.data,
1571 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001572 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001573 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001574 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001575
Steven Cooreman560c28a2020-07-24 23:20:24 +02001576 status = psa_export_rsa_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
Steven Cooremana2371e52020-07-28 14:30:39 +02001577 rsa,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001578 data,
1579 data_size,
1580 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001581
Steven Cooremana2371e52020-07-28 14:30:39 +02001582 mbedtls_rsa_free( rsa );
1583 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001584
Steven Cooreman560c28a2020-07-24 23:20:24 +02001585 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001586#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001587 /* We don't know how to convert a private RSA key to public. */
1588 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001589#endif
Gilles Peskine969ac722018-01-28 18:16:59 +01001590 }
1591 else
Moran Pekera998bc62018-04-16 18:16:20 +03001592 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001593#if defined(MBEDTLS_ECP_C)
Steven Cooremana2371e52020-07-28 14:30:39 +02001594 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02001595 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02001596 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02001597 slot->data.key.data,
1598 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02001599 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001600 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001601 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001602
1603 status = psa_export_ecp_key( PSA_KEY_TYPE_ECC_PUBLIC_KEY(
1604 PSA_KEY_TYPE_ECC_GET_FAMILY(
1605 slot->attr.type ) ),
Steven Cooremana2371e52020-07-28 14:30:39 +02001606 ecp,
Steven Cooreman560c28a2020-07-24 23:20:24 +02001607 data,
1608 data_size,
1609 data_length );
1610
Steven Cooremana2371e52020-07-28 14:30:39 +02001611 mbedtls_ecp_keypair_free( ecp );
1612 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001613 return( status );
1614#else
1615 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001616 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001617#endif
Moran Pekera998bc62018-04-16 18:16:20 +03001618 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001619 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001620 else
1621 {
1622 /* This shouldn't happen in the reference implementation, but
1623 it is valid for a special-purpose implementation to omit
1624 support for exporting certain key types. */
1625 return( PSA_ERROR_NOT_SUPPORTED );
1626 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001627}
1628
Gilles Peskinec5487a82018-12-03 18:08:14 +01001629psa_status_t psa_export_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001630 uint8_t *data,
1631 size_t data_size,
1632 size_t *data_length )
Moran Pekera998bc62018-04-16 18:16:20 +03001633{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001634 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001635 psa_status_t status;
1636
1637 /* Set the key to empty now, so that even when there are errors, we always
1638 * set data_length to a value between 0 and data_size. On error, setting
1639 * the key to empty is a good choice because an empty key representation is
1640 * unlikely to be accepted anywhere. */
1641 *data_length = 0;
1642
1643 /* Export requires the EXPORT flag. There is an exception for public keys,
1644 * which don't require any flag, but psa_get_key_from_slot takes
1645 * care of this. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001646 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_EXPORT, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001647 if( status != PSA_SUCCESS )
1648 return( status );
1649 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001650 data_length, 0 ) );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001651}
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001652
Gilles Peskinec5487a82018-12-03 18:08:14 +01001653psa_status_t psa_export_public_key( psa_key_handle_t handle,
Gilles Peskine2d277862018-06-18 15:41:12 +02001654 uint8_t *data,
1655 size_t data_size,
1656 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001657{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001658 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001659 psa_status_t status;
1660
1661 /* Set the key to empty now, so that even when there are errors, we always
1662 * set data_length to a value between 0 and data_size. On error, setting
1663 * the key to empty is a good choice because an empty key representation is
1664 * unlikely to be accepted anywhere. */
1665 *data_length = 0;
1666
1667 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskinec5487a82018-12-03 18:08:14 +01001668 status = psa_get_key_from_slot( handle, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001669 if( status != PSA_SUCCESS )
1670 return( status );
1671 return( psa_internal_export_key( slot, data, data_size,
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02001672 data_length, 1 ) );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001673}
1674
Gilles Peskine91e8c332019-08-02 19:19:39 +02001675#if defined(static_assert)
1676static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1677 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001678static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001679 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001680static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001681 "One or more key attribute flag is listed as both internal-only and external-only" );
1682#endif
1683
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001684/** Validate that a key policy is internally well-formed.
1685 *
1686 * This function only rejects invalid policies. It does not validate the
1687 * consistency of the policy with respect to other attributes of the key
1688 * such as the key type.
1689 */
1690static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001691{
1692 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001693 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001694 PSA_KEY_USAGE_ENCRYPT |
1695 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001696 PSA_KEY_USAGE_SIGN_HASH |
1697 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001698 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1699 return( PSA_ERROR_INVALID_ARGUMENT );
1700
Gilles Peskine4747d192019-04-17 15:05:45 +02001701 return( PSA_SUCCESS );
1702}
1703
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001704/** Validate the internal consistency of key attributes.
1705 *
1706 * This function only rejects invalid attribute values. If does not
1707 * validate the consistency of the attributes with any key data that may
1708 * be involved in the creation of the key.
1709 *
1710 * Call this function early in the key creation process.
1711 *
1712 * \param[in] attributes Key attributes for the new key.
1713 * \param[out] p_drv On any return, the driver for the key, if any.
1714 * NULL for a transparent key.
1715 *
1716 */
1717static psa_status_t psa_validate_key_attributes(
1718 const psa_key_attributes_t *attributes,
1719 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001720{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001721 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001722
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001723 status = psa_validate_key_location( psa_get_key_lifetime( attributes ),
1724 p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001725 if( status != PSA_SUCCESS )
1726 return( status );
1727
Steven Cooreman8c1e7592020-06-17 14:52:05 +02001728 status = psa_validate_key_persistence( psa_get_key_lifetime( attributes ),
1729 psa_get_key_id( attributes ) );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001730 if( status != PSA_SUCCESS )
1731 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001732
1733 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001734 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001735 return( status );
1736
1737 /* Refuse to create overly large keys.
1738 * Note that this doesn't trigger on import if the attributes don't
1739 * explicitly specify a size (so psa_get_key_bits returns 0), so
1740 * psa_import_key() needs its own checks. */
1741 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1742 return( PSA_ERROR_NOT_SUPPORTED );
1743
Gilles Peskine91e8c332019-08-02 19:19:39 +02001744 /* Reject invalid flags. These should not be reachable through the API. */
1745 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1746 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1747 return( PSA_ERROR_INVALID_ARGUMENT );
1748
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001749 return( PSA_SUCCESS );
1750}
1751
Gilles Peskine4747d192019-04-17 15:05:45 +02001752/** Prepare a key slot to receive key material.
1753 *
1754 * This function allocates a key slot and sets its metadata.
1755 *
1756 * If this function fails, call psa_fail_key_creation().
1757 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001758 * This function is intended to be used as follows:
1759 * -# Call psa_start_key_creation() to allocate a key slot, prepare
1760 * it with the specified attributes, and assign it a handle.
1761 * -# Populate the slot with the key material.
1762 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1763 * In case of failure at any step, stop the sequence and call
1764 * psa_fail_key_creation().
1765 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001766 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001767 * \param[in] attributes Key attributes for the new key.
1768 * \param[out] handle On success, a handle for the allocated slot.
1769 * \param[out] p_slot On success, a pointer to the prepared slot.
1770 * \param[out] p_drv On any return, the driver for the key, if any.
1771 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001772 *
1773 * \retval #PSA_SUCCESS
1774 * The key slot is ready to receive key material.
1775 * \return If this function fails, the key slot is an invalid state.
1776 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 */
1778static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001779 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001780 const psa_key_attributes_t *attributes,
1781 psa_key_handle_t *handle,
Gilles Peskine011e4282019-06-26 18:34:38 +02001782 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001783 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001784{
1785 psa_status_t status;
1786 psa_key_slot_t *slot;
1787
Gilles Peskinedf179142019-07-15 22:02:14 +02001788 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001789 *p_drv = NULL;
1790
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001791 status = psa_validate_key_attributes( attributes, p_drv );
1792 if( status != PSA_SUCCESS )
1793 return( status );
1794
Gilles Peskineedbed562019-08-07 18:19:59 +02001795 status = psa_get_empty_key_slot( handle, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001796 if( status != PSA_SUCCESS )
1797 return( status );
1798 slot = *p_slot;
1799
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001800 /* We're storing the declared bit-size of the key. It's up to each
1801 * creation mechanism to verify that this information is correct.
1802 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001803 * an input (generate, device) but not for those where the bit-size
1804 * is optional (import, copy). */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001805
1806 slot->attr = attributes->core;
Gilles Peskinec744d992019-07-30 17:26:54 +02001807
Gilles Peskine91e8c332019-08-02 19:19:39 +02001808 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001809 * external-only flags, query `attributes`. Thanks to the check
1810 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001811 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001812 * may have set. */
1813 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001814
Gilles Peskinecbaff462019-07-12 23:46:04 +02001815#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001816 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001817 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001818 * create the key file in internal storage, create the
1819 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001820 * persistent data. This is done by starting a transaction that will
1821 * encompass these three actions.
1822 * For registering a volatile key, we just need to find an appropriate
1823 * slot number inside the SE. Since the key is designated volatile, creating
1824 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001825 /* The first thing to do is to find a slot number for the new key.
1826 * We save the slot number in persistent storage as part of the
1827 * transaction data. It will be needed to recover if the power
1828 * fails during the key creation process, to clean up on the secure
1829 * element side after restarting. Obtaining a slot number from the
1830 * secure element driver updates its persistent state, but we do not yet
1831 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001832 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001833 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001834 {
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001835 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Gilles Peskinecbaff462019-07-12 23:46:04 +02001836 &slot->data.se.slot_number );
1837 if( status != PSA_SUCCESS )
1838 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001839
1840 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001841 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001842 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1843 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
1844 psa_crypto_transaction.key.slot = slot->data.se.slot_number;
1845 psa_crypto_transaction.key.id = slot->attr.id;
1846 status = psa_crypto_save_transaction( );
1847 if( status != PSA_SUCCESS )
1848 {
1849 (void) psa_crypto_stop_transaction( );
1850 return( status );
1851 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001852 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001853 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001854
1855 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1856 {
1857 /* Key registration only makes sense with a secure element. */
1858 return( PSA_ERROR_INVALID_ARGUMENT );
1859 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001860#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1861
Darryl Green0c6575a2018-11-07 16:05:30 +00001862 return( status );
1863}
Gilles Peskine4747d192019-04-17 15:05:45 +02001864
1865/** Finalize the creation of a key once its key material has been set.
1866 *
1867 * This entails writing the key to persistent storage.
1868 *
1869 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001870 * See the documentation of psa_start_key_creation() for the intended use
1871 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001872 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001873 * \param[in,out] slot Pointer to the slot with key material.
1874 * \param[in] driver The secure element driver for the key,
1875 * or NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001876 *
1877 * \retval #PSA_SUCCESS
1878 * The key was successfully created. The handle is now valid.
1879 * \return If this function fails, the key slot is an invalid state.
1880 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001881 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001882static psa_status_t psa_finish_key_creation(
1883 psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001884 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001885{
1886 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001887 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001888 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001889
1890#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001891 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001892 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001893#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1894 if( driver != NULL )
1895 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001896 psa_se_key_data_storage_t data;
1897#if defined(static_assert)
1898 static_assert( sizeof( slot->data.se.slot_number ) ==
1899 sizeof( data.slot_number ),
1900 "Slot number size does not match psa_se_key_data_storage_t" );
1901 static_assert( sizeof( slot->attr.bits ) == sizeof( data.bits ),
1902 "Bit-size size does not match psa_se_key_data_storage_t" );
1903#endif
1904 memcpy( &data.slot_number, &slot->data.se.slot_number,
1905 sizeof( slot->data.se.slot_number ) );
1906 memcpy( &data.bits, &slot->attr.bits,
1907 sizeof( slot->attr.bits ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001908 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001909 (uint8_t*) &data,
1910 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001911 }
1912 else
1913#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1914 {
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001915 size_t buffer_size =
Gilles Peskine8e338702019-07-30 20:06:31 +02001916 PSA_KEY_EXPORT_MAX_SIZE( slot->attr.type,
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001917 slot->attr.bits );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001918 uint8_t *buffer = mbedtls_calloc( 1, buffer_size );
1919 size_t length = 0;
Gilles Peskinef9168942019-09-12 19:20:29 +02001920 if( buffer == NULL )
Gilles Peskine1df83d42019-07-23 16:13:14 +02001921 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1922 status = psa_internal_export_key( slot,
1923 buffer, buffer_size, &length,
1924 0 );
Gilles Peskinee60d1d02019-07-24 20:27:59 +02001925 if( status == PSA_SUCCESS )
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001926 status = psa_save_persistent_key( &slot->attr,
Gilles Peskine4ed0e6f2019-07-30 20:22:33 +02001927 buffer, length );
Gilles Peskine4747d192019-04-17 15:05:45 +02001928
Gilles Peskinef9168942019-09-12 19:20:29 +02001929 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001930 mbedtls_free( buffer );
1931 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001932 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001933#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1934
Gilles Peskinecbaff462019-07-12 23:46:04 +02001935#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001936 /* Finish the transaction for a key creation. This does not
1937 * happen when registering an existing key. Detect this case
1938 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001939 * creation of a persistent key in a secure element requires a transaction,
1940 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001941 if( driver != NULL &&
1942 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001943 {
1944 status = psa_save_se_persistent_data( driver );
1945 if( status != PSA_SUCCESS )
1946 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001947 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001948 return( status );
1949 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001950 status = psa_crypto_stop_transaction( );
1951 if( status != PSA_SUCCESS )
1952 return( status );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001953 }
1954#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1955
Gilles Peskine4747d192019-04-17 15:05:45 +02001956 return( status );
1957}
1958
1959/** Abort the creation of a key.
1960 *
1961 * You may call this function after calling psa_start_key_creation(),
1962 * or after psa_finish_key_creation() fails. In other circumstances, this
1963 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001964 * See the documentation of psa_start_key_creation() for the intended use
1965 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001966 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001967 * \param[in,out] slot Pointer to the slot with key material.
1968 * \param[in] driver The secure element driver for the key,
1969 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001970 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001971static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001972 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001973{
Gilles Peskine011e4282019-06-26 18:34:38 +02001974 (void) driver;
1975
Gilles Peskine4747d192019-04-17 15:05:45 +02001976 if( slot == NULL )
1977 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001978
1979#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001980 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001981 * element, and the failure happened later (when saving metadata
1982 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001983 * element.
1984 * https://github.com/ARMmbed/mbed-crypto/issues/217
1985 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001986
Gilles Peskined7729582019-08-05 15:55:54 +02001987 /* Abort the ongoing transaction if any (there may not be one if
1988 * the creation process failed before starting one, or if the
1989 * key creation is a registration of a key in a secure element).
1990 * Earlier functions must already have done what it takes to undo any
1991 * partial creation. All that's left is to update the transaction data
1992 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001993 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001994#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1995
Gilles Peskine4747d192019-04-17 15:05:45 +02001996 psa_wipe_key_slot( slot );
1997}
1998
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001999/** Validate optional attributes during key creation.
2000 *
2001 * Some key attributes are optional during key creation. If they are
2002 * specified in the attributes structure, check that they are consistent
2003 * with the data in the slot.
2004 *
2005 * This function should be called near the end of key creation, after
2006 * the slot in memory is fully populated but before saving persistent data.
2007 */
2008static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002009 const psa_key_slot_t *slot,
2010 const psa_key_attributes_t *attributes )
2011{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002012 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002013 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002014 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002015 return( PSA_ERROR_INVALID_ARGUMENT );
2016 }
2017
2018 if( attributes->domain_parameters_size != 0 )
2019 {
2020#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02002021 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002023 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002024 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002025 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002026
Steven Cooreman7f391872020-07-30 14:57:44 +02002027 psa_status_t status = psa_load_rsa_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02002028 slot->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02002029 slot->data.key.data,
2030 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02002031 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002032 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002033 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002034
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002035 mbedtls_mpi_init( &actual );
2036 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002037 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002038 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002039 mbedtls_rsa_free( rsa );
2040 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002041 if( ret != 0 )
2042 goto rsa_exit;
2043 ret = mbedtls_mpi_read_binary( &required,
2044 attributes->domain_parameters,
2045 attributes->domain_parameters_size );
2046 if( ret != 0 )
2047 goto rsa_exit;
2048 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2049 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2050 rsa_exit:
2051 mbedtls_mpi_free( &actual );
2052 mbedtls_mpi_free( &required );
2053 if( ret != 0)
2054 return( mbedtls_to_psa_error( ret ) );
2055 }
2056 else
2057#endif
2058 {
2059 return( PSA_ERROR_INVALID_ARGUMENT );
2060 }
2061 }
2062
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002063 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002064 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002065 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002066 return( PSA_ERROR_INVALID_ARGUMENT );
2067 }
2068
2069 return( PSA_SUCCESS );
2070}
2071
Gilles Peskine4747d192019-04-17 15:05:45 +02002072psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002073 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002074 size_t data_length,
2075 psa_key_handle_t *handle )
Gilles Peskine4747d192019-04-17 15:05:45 +02002076{
2077 psa_status_t status;
2078 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002079 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080
Gilles Peskine0f84d622019-09-12 19:03:13 +02002081 /* Reject zero-length symmetric keys (including raw data key objects).
2082 * This also rejects any key which might be encoded as an empty string,
2083 * which is never valid. */
2084 if( data_length == 0 )
2085 return( PSA_ERROR_INVALID_ARGUMENT );
2086
Gilles Peskinedf179142019-07-15 22:02:14 +02002087 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
2088 handle, &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002089 if( status != PSA_SUCCESS )
2090 goto exit;
2091
Gilles Peskine5d309672019-07-12 23:47:28 +02002092#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2093 if( driver != NULL )
2094 {
2095 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002096 /* The driver should set the number of key bits, however in
2097 * case it doesn't, we initialize bits to an invalid value. */
2098 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002099 if( drv->key_management == NULL ||
2100 drv->key_management->p_import == NULL )
2101 {
2102 status = PSA_ERROR_NOT_SUPPORTED;
2103 goto exit;
2104 }
2105 status = drv->key_management->p_import(
2106 psa_get_se_driver_context( driver ),
Gilles Peskinef3801ff2019-08-06 17:32:04 +02002107 slot->data.se.slot_number, attributes, data, data_length,
Gilles Peskineb46bef22019-07-30 21:32:04 +02002108 &bits );
2109 if( status != PSA_SUCCESS )
2110 goto exit;
2111 if( bits > PSA_MAX_KEY_BITS )
2112 {
2113 status = PSA_ERROR_NOT_SUPPORTED;
2114 goto exit;
2115 }
2116 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002117 }
2118 else
2119#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2120 {
2121 status = psa_import_key_into_slot( slot, data, data_length );
2122 if( status != PSA_SUCCESS )
2123 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002124 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002125 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002126 if( status != PSA_SUCCESS )
2127 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002128
Gilles Peskine011e4282019-06-26 18:34:38 +02002129 status = psa_finish_key_creation( slot, driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002130exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002131 if( status != PSA_SUCCESS )
2132 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002133 psa_fail_key_creation( slot, driver );
Gilles Peskine4747d192019-04-17 15:05:45 +02002134 *handle = 0;
2135 }
2136 return( status );
2137}
2138
Gilles Peskined7729582019-08-05 15:55:54 +02002139#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2140psa_status_t mbedtls_psa_register_se_key(
2141 const psa_key_attributes_t *attributes )
2142{
2143 psa_status_t status;
2144 psa_key_slot_t *slot = NULL;
2145 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskined7729582019-08-05 15:55:54 +02002146 psa_key_handle_t handle = 0;
2147
2148 /* Leaving attributes unspecified is not currently supported.
2149 * It could make sense to query the key type and size from the
2150 * secure element, but not all secure elements support this
2151 * and the driver HAL doesn't currently support it. */
2152 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2153 return( PSA_ERROR_NOT_SUPPORTED );
2154 if( psa_get_key_bits( attributes ) == 0 )
2155 return( PSA_ERROR_NOT_SUPPORTED );
2156
2157 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
2158 &handle, &slot, &driver );
2159 if( status != PSA_SUCCESS )
2160 goto exit;
2161
Gilles Peskined7729582019-08-05 15:55:54 +02002162 status = psa_finish_key_creation( slot, driver );
2163
2164exit:
2165 if( status != PSA_SUCCESS )
2166 {
2167 psa_fail_key_creation( slot, driver );
2168 }
2169 /* Registration doesn't keep the key in RAM. */
2170 psa_close_key( handle );
2171 return( status );
2172}
2173#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2174
Gilles Peskinef603c712019-01-19 13:40:11 +01002175static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002176 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002177{
2178 psa_status_t status;
2179 uint8_t *buffer = NULL;
2180 size_t buffer_size = 0;
2181 size_t length;
2182
Gilles Peskine8e338702019-07-30 20:06:31 +02002183 buffer_size = PSA_KEY_EXPORT_MAX_SIZE( source->attr.type,
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002184 psa_get_key_slot_bits( source ) );
Gilles Peskinef603c712019-01-19 13:40:11 +01002185 buffer = mbedtls_calloc( 1, buffer_size );
Gilles Peskinef9168942019-09-12 19:20:29 +02002186 if( buffer == NULL )
Gilles Peskine122d0022019-01-23 10:55:43 +01002187 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskinef603c712019-01-19 13:40:11 +01002188 status = psa_internal_export_key( source, buffer, buffer_size, &length, 0 );
2189 if( status != PSA_SUCCESS )
2190 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02002191 target->attr.type = source->attr.type;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002192 status = psa_import_key_into_slot( target, buffer, length );
Gilles Peskinef603c712019-01-19 13:40:11 +01002193
2194exit:
Gilles Peskinef9168942019-09-12 19:20:29 +02002195 mbedtls_platform_zeroize( buffer, buffer_size );
Gilles Peskine122d0022019-01-23 10:55:43 +01002196 mbedtls_free( buffer );
Gilles Peskinef603c712019-01-19 13:40:11 +01002197 return( status );
2198}
2199
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002200psa_status_t psa_copy_key( psa_key_handle_t source_handle,
2201 const psa_key_attributes_t *specified_attributes,
2202 psa_key_handle_t *target_handle )
Gilles Peskinef603c712019-01-19 13:40:11 +01002203{
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002204 psa_status_t status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002205 psa_key_slot_t *source_slot = NULL;
2206 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002207 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002208 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002209
Gilles Peskine28f8f302019-07-24 13:30:31 +02002210 status = psa_get_transparent_key( source_handle, &source_slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02002211 PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002212 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002213 goto exit;
2214
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002215 status = psa_validate_optional_attributes( source_slot,
2216 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002217 if( status != PSA_SUCCESS )
2218 goto exit;
2219
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002220 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002221 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002222 if( status != PSA_SUCCESS )
2223 goto exit;
2224
Gilles Peskinedf179142019-07-15 22:02:14 +02002225 status = psa_start_key_creation( PSA_KEY_CREATION_COPY,
2226 &actual_attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02002227 target_handle, &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002228 if( status != PSA_SUCCESS )
2229 goto exit;
2230
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002231#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2232 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002233 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002234 /* Copying to a secure element is not implemented yet. */
2235 status = PSA_ERROR_NOT_SUPPORTED;
2236 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002237 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002238#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002239
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002240 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002241 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002242 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002243
Gilles Peskine011e4282019-06-26 18:34:38 +02002244 status = psa_finish_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002245exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002246 if( status != PSA_SUCCESS )
2247 {
Gilles Peskine011e4282019-06-26 18:34:38 +02002248 psa_fail_key_creation( target_slot, driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002249 *target_handle = 0;
2250 }
2251 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002252}
2253
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002254
2255
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002256/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002257/* Message digests */
2258/****************************************************************/
2259
Gilles Peskineb16841e2019-10-10 20:36:12 +02002260#if defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002261static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002262{
2263 switch( alg )
2264 {
2265#if defined(MBEDTLS_MD2_C)
2266 case PSA_ALG_MD2:
2267 return( &mbedtls_md2_info );
2268#endif
2269#if defined(MBEDTLS_MD4_C)
2270 case PSA_ALG_MD4:
2271 return( &mbedtls_md4_info );
2272#endif
2273#if defined(MBEDTLS_MD5_C)
2274 case PSA_ALG_MD5:
2275 return( &mbedtls_md5_info );
2276#endif
2277#if defined(MBEDTLS_RIPEMD160_C)
2278 case PSA_ALG_RIPEMD160:
2279 return( &mbedtls_ripemd160_info );
2280#endif
2281#if defined(MBEDTLS_SHA1_C)
2282 case PSA_ALG_SHA_1:
2283 return( &mbedtls_sha1_info );
2284#endif
2285#if defined(MBEDTLS_SHA256_C)
2286 case PSA_ALG_SHA_224:
2287 return( &mbedtls_sha224_info );
2288 case PSA_ALG_SHA_256:
2289 return( &mbedtls_sha256_info );
2290#endif
2291#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002292#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002293 case PSA_ALG_SHA_384:
2294 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002295#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002296 case PSA_ALG_SHA_512:
2297 return( &mbedtls_sha512_info );
2298#endif
2299 default:
2300 return( NULL );
2301 }
2302}
Gilles Peskineb16841e2019-10-10 20:36:12 +02002303#endif
Gilles Peskine20035e32018-02-03 22:44:14 +01002304
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002305psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2306{
2307 switch( operation->alg )
2308 {
Gilles Peskine81736312018-06-26 15:04:31 +02002309 case 0:
2310 /* The object has (apparently) been initialized but it is not
2311 * in use. It's ok to call abort on such an object, and there's
2312 * nothing to do. */
2313 break;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002314#if defined(MBEDTLS_MD2_C)
2315 case PSA_ALG_MD2:
2316 mbedtls_md2_free( &operation->ctx.md2 );
2317 break;
2318#endif
2319#if defined(MBEDTLS_MD4_C)
2320 case PSA_ALG_MD4:
2321 mbedtls_md4_free( &operation->ctx.md4 );
2322 break;
2323#endif
2324#if defined(MBEDTLS_MD5_C)
2325 case PSA_ALG_MD5:
2326 mbedtls_md5_free( &operation->ctx.md5 );
2327 break;
2328#endif
2329#if defined(MBEDTLS_RIPEMD160_C)
2330 case PSA_ALG_RIPEMD160:
2331 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2332 break;
2333#endif
2334#if defined(MBEDTLS_SHA1_C)
2335 case PSA_ALG_SHA_1:
2336 mbedtls_sha1_free( &operation->ctx.sha1 );
2337 break;
2338#endif
2339#if defined(MBEDTLS_SHA256_C)
2340 case PSA_ALG_SHA_224:
2341 case PSA_ALG_SHA_256:
2342 mbedtls_sha256_free( &operation->ctx.sha256 );
2343 break;
2344#endif
2345#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002346#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002347 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002348#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002349 case PSA_ALG_SHA_512:
2350 mbedtls_sha512_free( &operation->ctx.sha512 );
2351 break;
2352#endif
2353 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002354 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002355 }
2356 operation->alg = 0;
2357 return( PSA_SUCCESS );
2358}
2359
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002360psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002361 psa_algorithm_t alg )
2362{
Janos Follath24eed8d2019-11-22 13:21:35 +00002363 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002364
2365 /* A context must be freshly initialized before it can be set up. */
2366 if( operation->alg != 0 )
2367 {
2368 return( PSA_ERROR_BAD_STATE );
2369 }
2370
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002371 switch( alg )
2372 {
2373#if defined(MBEDTLS_MD2_C)
2374 case PSA_ALG_MD2:
2375 mbedtls_md2_init( &operation->ctx.md2 );
2376 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2377 break;
2378#endif
2379#if defined(MBEDTLS_MD4_C)
2380 case PSA_ALG_MD4:
2381 mbedtls_md4_init( &operation->ctx.md4 );
2382 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2383 break;
2384#endif
2385#if defined(MBEDTLS_MD5_C)
2386 case PSA_ALG_MD5:
2387 mbedtls_md5_init( &operation->ctx.md5 );
2388 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2389 break;
2390#endif
2391#if defined(MBEDTLS_RIPEMD160_C)
2392 case PSA_ALG_RIPEMD160:
2393 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2394 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2395 break;
2396#endif
2397#if defined(MBEDTLS_SHA1_C)
2398 case PSA_ALG_SHA_1:
2399 mbedtls_sha1_init( &operation->ctx.sha1 );
2400 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2401 break;
2402#endif
2403#if defined(MBEDTLS_SHA256_C)
2404 case PSA_ALG_SHA_224:
2405 mbedtls_sha256_init( &operation->ctx.sha256 );
2406 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2407 break;
2408 case PSA_ALG_SHA_256:
2409 mbedtls_sha256_init( &operation->ctx.sha256 );
2410 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2411 break;
2412#endif
2413#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002414#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002415 case PSA_ALG_SHA_384:
2416 mbedtls_sha512_init( &operation->ctx.sha512 );
2417 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2418 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002419#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002420 case PSA_ALG_SHA_512:
2421 mbedtls_sha512_init( &operation->ctx.sha512 );
2422 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2423 break;
2424#endif
2425 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002426 return( PSA_ALG_IS_HASH( alg ) ?
2427 PSA_ERROR_NOT_SUPPORTED :
2428 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002429 }
2430 if( ret == 0 )
2431 operation->alg = alg;
2432 else
2433 psa_hash_abort( operation );
2434 return( mbedtls_to_psa_error( ret ) );
2435}
2436
2437psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2438 const uint8_t *input,
2439 size_t input_length )
2440{
Janos Follath24eed8d2019-11-22 13:21:35 +00002441 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002442
2443 /* Don't require hash implementations to behave correctly on a
2444 * zero-length input, which may have an invalid pointer. */
2445 if( input_length == 0 )
2446 return( PSA_SUCCESS );
2447
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002448 switch( operation->alg )
2449 {
2450#if defined(MBEDTLS_MD2_C)
2451 case PSA_ALG_MD2:
2452 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2453 input, input_length );
2454 break;
2455#endif
2456#if defined(MBEDTLS_MD4_C)
2457 case PSA_ALG_MD4:
2458 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2459 input, input_length );
2460 break;
2461#endif
2462#if defined(MBEDTLS_MD5_C)
2463 case PSA_ALG_MD5:
2464 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2465 input, input_length );
2466 break;
2467#endif
2468#if defined(MBEDTLS_RIPEMD160_C)
2469 case PSA_ALG_RIPEMD160:
2470 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2471 input, input_length );
2472 break;
2473#endif
2474#if defined(MBEDTLS_SHA1_C)
2475 case PSA_ALG_SHA_1:
2476 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2477 input, input_length );
2478 break;
2479#endif
2480#if defined(MBEDTLS_SHA256_C)
2481 case PSA_ALG_SHA_224:
2482 case PSA_ALG_SHA_256:
2483 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2484 input, input_length );
2485 break;
2486#endif
2487#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002488#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002489 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002490#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002491 case PSA_ALG_SHA_512:
2492 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2493 input, input_length );
2494 break;
2495#endif
2496 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002497 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002498 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002499
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002500 if( ret != 0 )
2501 psa_hash_abort( operation );
2502 return( mbedtls_to_psa_error( ret ) );
2503}
2504
2505psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2506 uint8_t *hash,
2507 size_t hash_size,
2508 size_t *hash_length )
2509{
itayzafrir40835d42018-08-02 13:14:17 +03002510 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002511 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine71bb7b72018-04-19 08:29:59 +02002512 size_t actual_hash_length = PSA_HASH_SIZE( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002513
2514 /* Fill the output buffer with something that isn't a valid hash
2515 * (barring an attack on the hash and deliberately-crafted input),
2516 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002517 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002518 /* If hash_size is 0 then hash may be NULL and then the
2519 * call to memset would have undefined behavior. */
2520 if( hash_size != 0 )
2521 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002522
2523 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002524 {
2525 status = PSA_ERROR_BUFFER_TOO_SMALL;
2526 goto exit;
2527 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002528
2529 switch( operation->alg )
2530 {
2531#if defined(MBEDTLS_MD2_C)
2532 case PSA_ALG_MD2:
2533 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2534 break;
2535#endif
2536#if defined(MBEDTLS_MD4_C)
2537 case PSA_ALG_MD4:
2538 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2539 break;
2540#endif
2541#if defined(MBEDTLS_MD5_C)
2542 case PSA_ALG_MD5:
2543 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2544 break;
2545#endif
2546#if defined(MBEDTLS_RIPEMD160_C)
2547 case PSA_ALG_RIPEMD160:
2548 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2549 break;
2550#endif
2551#if defined(MBEDTLS_SHA1_C)
2552 case PSA_ALG_SHA_1:
2553 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2554 break;
2555#endif
2556#if defined(MBEDTLS_SHA256_C)
2557 case PSA_ALG_SHA_224:
2558 case PSA_ALG_SHA_256:
2559 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2560 break;
2561#endif
2562#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002563#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002564 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002565#endif
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002566 case PSA_ALG_SHA_512:
2567 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2568 break;
2569#endif
2570 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002571 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002572 }
itayzafrir40835d42018-08-02 13:14:17 +03002573 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002574
itayzafrir40835d42018-08-02 13:14:17 +03002575exit:
2576 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002577 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002578 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002579 return( psa_hash_abort( operation ) );
2580 }
2581 else
2582 {
2583 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002584 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002585 }
2586}
2587
Gilles Peskine2d277862018-06-18 15:41:12 +02002588psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2589 const uint8_t *hash,
2590 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002591{
2592 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2593 size_t actual_hash_length;
2594 psa_status_t status = psa_hash_finish( operation,
2595 actual_hash, sizeof( actual_hash ),
2596 &actual_hash_length );
2597 if( status != PSA_SUCCESS )
2598 return( status );
2599 if( actual_hash_length != hash_length )
2600 return( PSA_ERROR_INVALID_SIGNATURE );
2601 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2602 return( PSA_ERROR_INVALID_SIGNATURE );
2603 return( PSA_SUCCESS );
2604}
2605
Gilles Peskine0a749c82019-11-28 19:33:58 +01002606psa_status_t psa_hash_compute( psa_algorithm_t alg,
2607 const uint8_t *input, size_t input_length,
2608 uint8_t *hash, size_t hash_size,
2609 size_t *hash_length )
2610{
2611 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2613
2614 *hash_length = hash_size;
2615 status = psa_hash_setup( &operation, alg );
2616 if( status != PSA_SUCCESS )
2617 goto exit;
2618 status = psa_hash_update( &operation, input, input_length );
2619 if( status != PSA_SUCCESS )
2620 goto exit;
2621 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2622 if( status != PSA_SUCCESS )
2623 goto exit;
2624
2625exit:
2626 if( status == PSA_SUCCESS )
2627 status = psa_hash_abort( &operation );
2628 else
2629 psa_hash_abort( &operation );
2630 return( status );
2631}
2632
2633psa_status_t psa_hash_compare( psa_algorithm_t alg,
2634 const uint8_t *input, size_t input_length,
2635 const uint8_t *hash, size_t hash_length )
2636{
2637 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2638 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2639
2640 status = psa_hash_setup( &operation, alg );
2641 if( status != PSA_SUCCESS )
2642 goto exit;
2643 status = psa_hash_update( &operation, input, input_length );
2644 if( status != PSA_SUCCESS )
2645 goto exit;
2646 status = psa_hash_verify( &operation, hash, hash_length );
2647 if( status != PSA_SUCCESS )
2648 goto exit;
2649
2650exit:
2651 if( status == PSA_SUCCESS )
2652 status = psa_hash_abort( &operation );
2653 else
2654 psa_hash_abort( &operation );
2655 return( status );
2656}
2657
Gilles Peskineeb35d782019-01-22 17:56:16 +01002658psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2659 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002660{
2661 if( target_operation->alg != 0 )
2662 return( PSA_ERROR_BAD_STATE );
2663
2664 switch( source_operation->alg )
2665 {
2666 case 0:
2667 return( PSA_ERROR_BAD_STATE );
2668#if defined(MBEDTLS_MD2_C)
2669 case PSA_ALG_MD2:
2670 mbedtls_md2_clone( &target_operation->ctx.md2,
2671 &source_operation->ctx.md2 );
2672 break;
2673#endif
2674#if defined(MBEDTLS_MD4_C)
2675 case PSA_ALG_MD4:
2676 mbedtls_md4_clone( &target_operation->ctx.md4,
2677 &source_operation->ctx.md4 );
2678 break;
2679#endif
2680#if defined(MBEDTLS_MD5_C)
2681 case PSA_ALG_MD5:
2682 mbedtls_md5_clone( &target_operation->ctx.md5,
2683 &source_operation->ctx.md5 );
2684 break;
2685#endif
2686#if defined(MBEDTLS_RIPEMD160_C)
2687 case PSA_ALG_RIPEMD160:
2688 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2689 &source_operation->ctx.ripemd160 );
2690 break;
2691#endif
2692#if defined(MBEDTLS_SHA1_C)
2693 case PSA_ALG_SHA_1:
2694 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2695 &source_operation->ctx.sha1 );
2696 break;
2697#endif
2698#if defined(MBEDTLS_SHA256_C)
2699 case PSA_ALG_SHA_224:
2700 case PSA_ALG_SHA_256:
2701 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2702 &source_operation->ctx.sha256 );
2703 break;
2704#endif
2705#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002706#if !defined(MBEDTLS_SHA512_NO_SHA384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002707 case PSA_ALG_SHA_384:
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002708#endif
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002709 case PSA_ALG_SHA_512:
2710 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2711 &source_operation->ctx.sha512 );
2712 break;
2713#endif
2714 default:
2715 return( PSA_ERROR_NOT_SUPPORTED );
2716 }
2717
2718 target_operation->alg = source_operation->alg;
2719 return( PSA_SUCCESS );
2720}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002721
2722
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002723/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002724/* MAC */
2725/****************************************************************/
2726
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002727static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728 psa_algorithm_t alg,
2729 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002730 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002731 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002732{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002734 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002735
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002736 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002737 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002738
Gilles Peskine8c9def32018-02-08 10:02:12 +01002739 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2740 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002741 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002742 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002743 case PSA_ALG_ARC4:
Gilles Peskine26869f22019-05-06 15:25:00 +02002744 case PSA_ALG_CHACHA20:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002745 mode = MBEDTLS_MODE_STREAM;
2746 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002747 case PSA_ALG_CTR:
2748 mode = MBEDTLS_MODE_CTR;
2749 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002750 case PSA_ALG_CFB:
2751 mode = MBEDTLS_MODE_CFB;
2752 break;
2753 case PSA_ALG_OFB:
2754 mode = MBEDTLS_MODE_OFB;
2755 break;
2756 case PSA_ALG_CBC_NO_PADDING:
2757 mode = MBEDTLS_MODE_CBC;
2758 break;
2759 case PSA_ALG_CBC_PKCS7:
2760 mode = MBEDTLS_MODE_CBC;
2761 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002762 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002763 mode = MBEDTLS_MODE_CCM;
2764 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002765 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002766 mode = MBEDTLS_MODE_GCM;
2767 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002768 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2769 mode = MBEDTLS_MODE_CHACHAPOLY;
2770 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002771 default:
2772 return( NULL );
2773 }
2774 }
2775 else if( alg == PSA_ALG_CMAC )
2776 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002777 else
2778 return( NULL );
2779
2780 switch( key_type )
2781 {
2782 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002783 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002784 break;
2785 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002786 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2787 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002789 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002790 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002791 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002792 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2793 * but two-key Triple-DES is functionally three-key Triple-DES
2794 * with K1=K3, so that's how we present it to mbedtls. */
2795 if( key_bits == 128 )
2796 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002797 break;
2798 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002799 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800 break;
2801 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002802 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002803 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002804 case PSA_KEY_TYPE_CHACHA20:
2805 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2806 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002807 default:
2808 return( NULL );
2809 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002810 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002811 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002812
Jaeden Amero23bbb752018-06-26 14:16:54 +01002813 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2814 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002815}
2816
Gilles Peskinea05219c2018-11-16 16:02:56 +01002817#if defined(MBEDTLS_MD_C)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002818static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002819{
Gilles Peskine2d277862018-06-18 15:41:12 +02002820 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002821 {
2822 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002823 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002824 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002825 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002826 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002827 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002828 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002829 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002830 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002831 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002832 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002833 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002834 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002835 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002836 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002837 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002838 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002839 return( 128 );
2840 default:
2841 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002842 }
2843}
Gilles Peskinea05219c2018-11-16 16:02:56 +01002844#endif /* MBEDTLS_MD_C */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002845
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002846/* Initialize the MAC operation structure. Once this function has been
2847 * called, psa_mac_abort can run and will do the right thing. */
2848static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2849 psa_algorithm_t alg )
2850{
2851 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2852
2853 operation->alg = alg;
2854 operation->key_set = 0;
2855 operation->iv_set = 0;
2856 operation->iv_required = 0;
2857 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002858 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002859
2860#if defined(MBEDTLS_CMAC_C)
2861 if( alg == PSA_ALG_CMAC )
2862 {
2863 operation->iv_required = 0;
2864 mbedtls_cipher_init( &operation->ctx.cmac );
2865 status = PSA_SUCCESS;
2866 }
2867 else
2868#endif /* MBEDTLS_CMAC_C */
2869#if defined(MBEDTLS_MD_C)
2870 if( PSA_ALG_IS_HMAC( operation->alg ) )
2871 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002872 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2873 operation->ctx.hmac.hash_ctx.alg = 0;
2874 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002875 }
2876 else
2877#endif /* MBEDTLS_MD_C */
2878 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002879 if( ! PSA_ALG_IS_MAC( alg ) )
2880 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002881 }
2882
2883 if( status != PSA_SUCCESS )
2884 memset( operation, 0, sizeof( *operation ) );
2885 return( status );
2886}
2887
Gilles Peskine01126fa2018-07-12 17:04:55 +02002888#if defined(MBEDTLS_MD_C)
2889static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2890{
Gilles Peskine3f108122018-12-07 18:14:53 +01002891 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002892 return( psa_hash_abort( &hmac->hash_ctx ) );
2893}
2894#endif /* MBEDTLS_MD_C */
2895
Gilles Peskine8c9def32018-02-08 10:02:12 +01002896psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2897{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002898 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002899 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002900 /* The object has (apparently) been initialized but it is not
2901 * in use. It's ok to call abort on such an object, and there's
2902 * nothing to do. */
2903 return( PSA_SUCCESS );
2904 }
2905 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002906#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002907 if( operation->alg == PSA_ALG_CMAC )
2908 {
2909 mbedtls_cipher_free( &operation->ctx.cmac );
2910 }
2911 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002912#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002913#if defined(MBEDTLS_MD_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002914 if( PSA_ALG_IS_HMAC( operation->alg ) )
2915 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002916 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002917 }
2918 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002919#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002920 {
2921 /* Sanity check (shouldn't happen: operation->alg should
2922 * always have been initialized to a valid value). */
2923 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002924 }
Moran Peker41deec42018-04-04 15:43:05 +03002925
Gilles Peskine8c9def32018-02-08 10:02:12 +01002926 operation->alg = 0;
2927 operation->key_set = 0;
2928 operation->iv_set = 0;
2929 operation->iv_required = 0;
2930 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002931 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002932
Gilles Peskine8c9def32018-02-08 10:02:12 +01002933 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002934
2935bad_state:
2936 /* If abort is called on an uninitialized object, we can't trust
2937 * anything. Wipe the object in case it contains confidential data.
2938 * This may result in a memory leak if a pointer gets overwritten,
2939 * but it's too late to do anything about this. */
2940 memset( operation, 0, sizeof( *operation ) );
2941 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002942}
2943
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002944#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002945static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002946 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002947 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002948 const mbedtls_cipher_info_t *cipher_info )
2949{
Janos Follath24eed8d2019-11-22 13:21:35 +00002950 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002951
2952 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002953
2954 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2955 if( ret != 0 )
2956 return( ret );
2957
2958 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02002959 slot->data.key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002960 key_bits );
2961 return( ret );
2962}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002963#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002964
Gilles Peskine248051a2018-06-20 16:09:38 +02002965#if defined(MBEDTLS_MD_C)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002966static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2967 const uint8_t *key,
2968 size_t key_length,
2969 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002970{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002971 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002972 size_t i;
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002973 size_t hash_size = PSA_HASH_SIZE( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002974 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002975 psa_status_t status;
2976
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002977 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2978 * overflow below. This should never trigger if the hash algorithm
2979 * is implemented correctly. */
2980 /* The size checks against the ipad and opad buffers cannot be written
2981 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2982 * because that triggers -Wlogical-op on GCC 7.3. */
2983 if( block_size > sizeof( ipad ) )
2984 return( PSA_ERROR_NOT_SUPPORTED );
2985 if( block_size > sizeof( hmac->opad ) )
2986 return( PSA_ERROR_NOT_SUPPORTED );
2987 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002988 return( PSA_ERROR_NOT_SUPPORTED );
2989
Gilles Peskined223b522018-06-11 18:12:58 +02002990 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002991 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002992 status = psa_hash_compute( hash_alg, key, key_length,
2993 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002994 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002995 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002996 }
Gilles Peskine96889972018-07-12 17:07:03 +02002997 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2998 * but it is permitted. It is common when HMAC is used in HKDF, for
2999 * example. Don't call `memcpy` in the 0-length because `key` could be
3000 * an invalid pointer which would make the behavior undefined. */
3001 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003002 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003003
Gilles Peskined223b522018-06-11 18:12:58 +02003004 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3005 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003006 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003007 ipad[i] ^= 0x36;
3008 memset( ipad + key_length, 0x36, block_size - key_length );
3009
3010 /* Copy the key material from ipad to opad, flipping the requisite bits,
3011 * and filling the rest of opad with the requisite constant. */
3012 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003013 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3014 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003015
Gilles Peskine01126fa2018-07-12 17:04:55 +02003016 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003017 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003018 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003019
Gilles Peskine01126fa2018-07-12 17:04:55 +02003020 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003021
3022cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003023 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003024
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003025 return( status );
3026}
Gilles Peskine248051a2018-06-20 16:09:38 +02003027#endif /* MBEDTLS_MD_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003028
Gilles Peskine89167cb2018-07-08 20:12:23 +02003029static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003030 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003031 psa_algorithm_t alg,
3032 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003033{
Gilles Peskine8c9def32018-02-08 10:02:12 +01003034 psa_status_t status;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003035 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003036 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003037 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003038 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003039 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003040 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003041
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003042 /* A context must be freshly initialized before it can be set up. */
3043 if( operation->alg != 0 )
3044 {
3045 return( PSA_ERROR_BAD_STATE );
3046 }
3047
Gilles Peskined911eb72018-08-14 15:18:45 +02003048 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003049 if( status != PSA_SUCCESS )
3050 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003051 if( is_sign )
3052 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003053
Gilles Peskine28f8f302019-07-24 13:30:31 +02003054 status = psa_get_transparent_key( handle, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003055 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003056 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003057 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003058
Gilles Peskine8c9def32018-02-08 10:02:12 +01003059#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003060 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003061 {
3062 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003063 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003064 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003065 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003066 if( cipher_info == NULL )
3067 {
3068 status = PSA_ERROR_NOT_SUPPORTED;
3069 goto exit;
3070 }
3071 operation->mac_size = cipher_info->block_size;
3072 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3073 status = mbedtls_to_psa_error( ret );
3074 }
3075 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003076#endif /* MBEDTLS_CMAC_C */
Gilles Peskine8c9def32018-02-08 10:02:12 +01003077#if defined(MBEDTLS_MD_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003078 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003079 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003080 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003081 if( hash_alg == 0 )
3082 {
3083 status = PSA_ERROR_NOT_SUPPORTED;
3084 goto exit;
3085 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003086
3087 operation->mac_size = PSA_HASH_SIZE( hash_alg );
3088 /* Sanity check. This shouldn't fail on a valid configuration. */
3089 if( operation->mac_size == 0 ||
3090 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3091 {
3092 status = PSA_ERROR_NOT_SUPPORTED;
3093 goto exit;
3094 }
3095
Gilles Peskine8e338702019-07-30 20:06:31 +02003096 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003097 {
3098 status = PSA_ERROR_INVALID_ARGUMENT;
3099 goto exit;
3100 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003101
Gilles Peskine01126fa2018-07-12 17:04:55 +02003102 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02003103 slot->data.key.data,
3104 slot->data.key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003105 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003106 }
3107 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003108#endif /* MBEDTLS_MD_C */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003109 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003110 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003111 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003112 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003113
Gilles Peskined911eb72018-08-14 15:18:45 +02003114 if( truncated == 0 )
3115 {
3116 /* The "normal" case: untruncated algorithm. Nothing to do. */
3117 }
3118 else if( truncated < 4 )
3119 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003120 /* A very short MAC is too short for security since it can be
3121 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3122 * so we make this our minimum, even though 32 bits is still
3123 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003124 status = PSA_ERROR_NOT_SUPPORTED;
3125 }
3126 else if( truncated > operation->mac_size )
3127 {
3128 /* It's impossible to "truncate" to a larger length. */
3129 status = PSA_ERROR_INVALID_ARGUMENT;
3130 }
3131 else
3132 operation->mac_size = truncated;
3133
Gilles Peskinefbfac682018-07-08 20:51:54 +02003134exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003135 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003136 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003137 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003138 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003139 else
3140 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003141 operation->key_set = 1;
3142 }
3143 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003144}
3145
Gilles Peskine89167cb2018-07-08 20:12:23 +02003146psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003147 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003148 psa_algorithm_t alg )
3149{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003150 return( psa_mac_setup( operation, handle, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003151}
3152
3153psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01003154 psa_key_handle_t handle,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003155 psa_algorithm_t alg )
3156{
Gilles Peskinec5487a82018-12-03 18:08:14 +01003157 return( psa_mac_setup( operation, handle, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003158}
3159
Gilles Peskine8c9def32018-02-08 10:02:12 +01003160psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3161 const uint8_t *input,
3162 size_t input_length )
3163{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003164 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003165 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003166 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003167 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003168 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003169 operation->has_input = 1;
3170
Gilles Peskine8c9def32018-02-08 10:02:12 +01003171#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003172 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003173 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003174 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3175 input, input_length );
3176 status = mbedtls_to_psa_error( ret );
3177 }
3178 else
3179#endif /* MBEDTLS_CMAC_C */
3180#if defined(MBEDTLS_MD_C)
3181 if( PSA_ALG_IS_HMAC( operation->alg ) )
3182 {
3183 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3184 input_length );
3185 }
3186 else
3187#endif /* MBEDTLS_MD_C */
3188 {
3189 /* This shouldn't happen if `operation` was initialized by
3190 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003191 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003192 }
3193
Gilles Peskinefbfac682018-07-08 20:51:54 +02003194 if( status != PSA_SUCCESS )
3195 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003196 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003197}
3198
Gilles Peskine01126fa2018-07-12 17:04:55 +02003199#if defined(MBEDTLS_MD_C)
3200static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3201 uint8_t *mac,
3202 size_t mac_size )
3203{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003204 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003205 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3206 size_t hash_size = 0;
3207 size_t block_size = psa_get_hash_block_size( hash_alg );
3208 psa_status_t status;
3209
Gilles Peskine01126fa2018-07-12 17:04:55 +02003210 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3211 if( status != PSA_SUCCESS )
3212 return( status );
3213 /* From here on, tmp needs to be wiped. */
3214
3215 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3216 if( status != PSA_SUCCESS )
3217 goto exit;
3218
3219 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3220 if( status != PSA_SUCCESS )
3221 goto exit;
3222
3223 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3224 if( status != PSA_SUCCESS )
3225 goto exit;
3226
Gilles Peskined911eb72018-08-14 15:18:45 +02003227 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3228 if( status != PSA_SUCCESS )
3229 goto exit;
3230
3231 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003232
3233exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003234 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003235 return( status );
3236}
3237#endif /* MBEDTLS_MD_C */
3238
mohammad16036df908f2018-04-02 08:34:15 -07003239static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003240 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003241 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003242{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003243 if( ! operation->key_set )
3244 return( PSA_ERROR_BAD_STATE );
3245 if( operation->iv_required && ! operation->iv_set )
3246 return( PSA_ERROR_BAD_STATE );
3247
Gilles Peskine8c9def32018-02-08 10:02:12 +01003248 if( mac_size < operation->mac_size )
3249 return( PSA_ERROR_BUFFER_TOO_SMALL );
3250
Gilles Peskine8c9def32018-02-08 10:02:12 +01003251#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003252 if( operation->alg == PSA_ALG_CMAC )
3253 {
Gilles Peskined911eb72018-08-14 15:18:45 +02003254 uint8_t tmp[PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE];
3255 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3256 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003257 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003258 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003259 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003260 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003261 else
3262#endif /* MBEDTLS_CMAC_C */
3263#if defined(MBEDTLS_MD_C)
3264 if( PSA_ALG_IS_HMAC( operation->alg ) )
3265 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003266 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003267 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003268 }
3269 else
3270#endif /* MBEDTLS_MD_C */
3271 {
3272 /* This shouldn't happen if `operation` was initialized by
3273 * a setup function. */
3274 return( PSA_ERROR_BAD_STATE );
3275 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003276}
3277
Gilles Peskineacd4be32018-07-08 19:56:25 +02003278psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3279 uint8_t *mac,
3280 size_t mac_size,
3281 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003282{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003283 psa_status_t status;
3284
Jaeden Amero252ef282019-02-15 14:05:35 +00003285 if( operation->alg == 0 )
3286 {
3287 return( PSA_ERROR_BAD_STATE );
3288 }
3289
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003290 /* Fill the output buffer with something that isn't a valid mac
3291 * (barring an attack on the mac and deliberately-crafted input),
3292 * in case the caller doesn't check the return status properly. */
3293 *mac_length = mac_size;
3294 /* If mac_size is 0 then mac may be NULL and then the
3295 * call to memset would have undefined behavior. */
3296 if( mac_size != 0 )
3297 memset( mac, '!', mac_size );
3298
Gilles Peskine89167cb2018-07-08 20:12:23 +02003299 if( ! operation->is_sign )
3300 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003301 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003302 }
mohammad16036df908f2018-04-02 08:34:15 -07003303
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003304 status = psa_mac_finish_internal( operation, mac, mac_size );
3305
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003306 if( status == PSA_SUCCESS )
3307 {
3308 status = psa_mac_abort( operation );
3309 if( status == PSA_SUCCESS )
3310 *mac_length = operation->mac_size;
3311 else
3312 memset( mac, '!', mac_size );
3313 }
3314 else
3315 psa_mac_abort( operation );
3316 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003317}
3318
Gilles Peskineacd4be32018-07-08 19:56:25 +02003319psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3320 const uint8_t *mac,
3321 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003322{
Gilles Peskine828ed142018-06-18 23:25:51 +02003323 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003324 psa_status_t status;
3325
Jaeden Amero252ef282019-02-15 14:05:35 +00003326 if( operation->alg == 0 )
3327 {
3328 return( PSA_ERROR_BAD_STATE );
3329 }
3330
Gilles Peskine89167cb2018-07-08 20:12:23 +02003331 if( operation->is_sign )
3332 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003333 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003334 }
3335 if( operation->mac_size != mac_length )
3336 {
3337 status = PSA_ERROR_INVALID_SIGNATURE;
3338 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003339 }
mohammad16036df908f2018-04-02 08:34:15 -07003340
3341 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003342 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003343 if( status != PSA_SUCCESS )
3344 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003345
3346 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3347 status = PSA_ERROR_INVALID_SIGNATURE;
3348
3349cleanup:
3350 if( status == PSA_SUCCESS )
3351 status = psa_mac_abort( operation );
3352 else
3353 psa_mac_abort( operation );
3354
Gilles Peskine3f108122018-12-07 18:14:53 +01003355 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003356
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003357 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003358}
3359
3360
Gilles Peskine20035e32018-02-03 22:44:14 +01003361
Gilles Peskine20035e32018-02-03 22:44:14 +01003362/****************************************************************/
3363/* Asymmetric cryptography */
3364/****************************************************************/
3365
Gilles Peskine2b450e32018-06-27 15:42:46 +02003366#if defined(MBEDTLS_RSA_C)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003367/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003368 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003369static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3370 size_t hash_length,
3371 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003372{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003373 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003374 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003375 *md_alg = mbedtls_md_get_type( md_info );
3376
3377 /* The Mbed TLS RSA module uses an unsigned int for hash length
3378 * parameters. Validate that it fits so that we don't risk an
3379 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003380#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003381 if( hash_length > UINT_MAX )
3382 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003383#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003384
3385#if defined(MBEDTLS_PKCS1_V15)
3386 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3387 * must be correct. */
3388 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3389 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003390 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003391 if( md_info == NULL )
3392 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003393 if( mbedtls_md_get_size( md_info ) != hash_length )
3394 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003395 }
3396#endif /* MBEDTLS_PKCS1_V15 */
3397
3398#if defined(MBEDTLS_PKCS1_V21)
3399 /* PSS requires a hash internally. */
3400 if( PSA_ALG_IS_RSA_PSS( alg ) )
3401 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003402 if( md_info == NULL )
3403 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003404 }
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003405#endif /* MBEDTLS_PKCS1_V21 */
3406
Gilles Peskine61b91d42018-06-08 16:09:36 +02003407 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003408}
3409
Gilles Peskine2b450e32018-06-27 15:42:46 +02003410static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3411 psa_algorithm_t alg,
3412 const uint8_t *hash,
3413 size_t hash_length,
3414 uint8_t *signature,
3415 size_t signature_size,
3416 size_t *signature_length )
3417{
3418 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003419 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003420 mbedtls_md_type_t md_alg;
3421
3422 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3423 if( status != PSA_SUCCESS )
3424 return( status );
3425
Gilles Peskine630a18a2018-06-29 17:49:35 +02003426 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003427 return( PSA_ERROR_BUFFER_TOO_SMALL );
3428
3429#if defined(MBEDTLS_PKCS1_V15)
3430 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3431 {
3432 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3433 MBEDTLS_MD_NONE );
3434 ret = mbedtls_rsa_pkcs1_sign( rsa,
3435 mbedtls_ctr_drbg_random,
3436 &global_data.ctr_drbg,
3437 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003438 md_alg,
3439 (unsigned int) hash_length,
3440 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003441 signature );
3442 }
3443 else
3444#endif /* MBEDTLS_PKCS1_V15 */
3445#if defined(MBEDTLS_PKCS1_V21)
3446 if( PSA_ALG_IS_RSA_PSS( alg ) )
3447 {
3448 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3449 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
3450 mbedtls_ctr_drbg_random,
3451 &global_data.ctr_drbg,
3452 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003453 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003454 (unsigned int) hash_length,
3455 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003456 signature );
3457 }
3458 else
3459#endif /* MBEDTLS_PKCS1_V21 */
3460 {
3461 return( PSA_ERROR_INVALID_ARGUMENT );
3462 }
3463
3464 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003465 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003466 return( mbedtls_to_psa_error( ret ) );
3467}
3468
3469static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3470 psa_algorithm_t alg,
3471 const uint8_t *hash,
3472 size_t hash_length,
3473 const uint8_t *signature,
3474 size_t signature_length )
3475{
3476 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003477 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003478 mbedtls_md_type_t md_alg;
3479
3480 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3481 if( status != PSA_SUCCESS )
3482 return( status );
3483
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003484 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3485 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003486
3487#if defined(MBEDTLS_PKCS1_V15)
3488 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3489 {
3490 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3491 MBEDTLS_MD_NONE );
3492 ret = mbedtls_rsa_pkcs1_verify( rsa,
3493 mbedtls_ctr_drbg_random,
3494 &global_data.ctr_drbg,
3495 MBEDTLS_RSA_PUBLIC,
3496 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003497 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003498 hash,
3499 signature );
3500 }
3501 else
3502#endif /* MBEDTLS_PKCS1_V15 */
3503#if defined(MBEDTLS_PKCS1_V21)
3504 if( PSA_ALG_IS_RSA_PSS( alg ) )
3505 {
3506 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3507 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
3508 mbedtls_ctr_drbg_random,
3509 &global_data.ctr_drbg,
3510 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003511 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003512 (unsigned int) hash_length,
3513 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003514 signature );
3515 }
3516 else
3517#endif /* MBEDTLS_PKCS1_V21 */
3518 {
3519 return( PSA_ERROR_INVALID_ARGUMENT );
3520 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003521
3522 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3523 * the rest of the signature is invalid". This has little use in
3524 * practice and PSA doesn't report this distinction. */
3525 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3526 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003527 return( mbedtls_to_psa_error( ret ) );
3528}
3529#endif /* MBEDTLS_RSA_C */
3530
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003531#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003532/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3533 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3534 * (even though these functions don't modify it). */
3535static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3536 psa_algorithm_t alg,
3537 const uint8_t *hash,
3538 size_t hash_length,
3539 uint8_t *signature,
3540 size_t signature_size,
3541 size_t *signature_length )
3542{
Janos Follath24eed8d2019-11-22 13:21:35 +00003543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003544 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003545 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003546 mbedtls_mpi_init( &r );
3547 mbedtls_mpi_init( &s );
3548
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003549 if( signature_size < 2 * curve_bytes )
3550 {
3551 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3552 goto cleanup;
3553 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003554
Gilles Peskinea05219c2018-11-16 16:02:56 +01003555#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003556 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3557 {
3558 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3559 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3560 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003561 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3562 &ecp->d, hash,
3563 hash_length, md_alg,
3564 mbedtls_ctr_drbg_random,
3565 &global_data.ctr_drbg ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003566 }
3567 else
Gilles Peskinea05219c2018-11-16 16:02:56 +01003568#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003569 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003570 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003571 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3572 hash, hash_length,
3573 mbedtls_ctr_drbg_random,
3574 &global_data.ctr_drbg ) );
3575 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003576
3577 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3578 signature,
3579 curve_bytes ) );
3580 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3581 signature + curve_bytes,
3582 curve_bytes ) );
3583
3584cleanup:
3585 mbedtls_mpi_free( &r );
3586 mbedtls_mpi_free( &s );
3587 if( ret == 0 )
3588 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003589 return( mbedtls_to_psa_error( ret ) );
3590}
3591
3592static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3593 const uint8_t *hash,
3594 size_t hash_length,
3595 const uint8_t *signature,
3596 size_t signature_length )
3597{
Janos Follath24eed8d2019-11-22 13:21:35 +00003598 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003599 mbedtls_mpi r, s;
3600 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3601 mbedtls_mpi_init( &r );
3602 mbedtls_mpi_init( &s );
3603
3604 if( signature_length != 2 * curve_bytes )
3605 return( PSA_ERROR_INVALID_SIGNATURE );
3606
3607 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3608 signature,
3609 curve_bytes ) );
3610 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3611 signature + curve_bytes,
3612 curve_bytes ) );
3613
Steven Cooremanacda8342020-07-24 23:09:52 +02003614 /* Check whether the public part is loaded. If not, load it. */
3615 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3616 {
3617 MBEDTLS_MPI_CHK(
3618 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
3619 mbedtls_ctr_drbg_random, &global_data.ctr_drbg ) );
3620 }
3621
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003622 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3623 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003624
3625cleanup:
3626 mbedtls_mpi_free( &r );
3627 mbedtls_mpi_free( &s );
3628 return( mbedtls_to_psa_error( ret ) );
3629}
3630#endif /* MBEDTLS_ECDSA_C */
3631
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003632psa_status_t psa_sign_hash( psa_key_handle_t handle,
3633 psa_algorithm_t alg,
3634 const uint8_t *hash,
3635 size_t hash_length,
3636 uint8_t *signature,
3637 size_t signature_size,
3638 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003639{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003640 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003641 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003642#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3643 const psa_drv_se_t *drv;
3644 psa_drv_se_context_t *drv_context;
3645#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003646
3647 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003648 /* Immediately reject a zero-length signature buffer. This guarantees
3649 * that signature must be a valid pointer. (On the other hand, the hash
3650 * buffer can in principle be empty since it doesn't actually have
3651 * to be a hash.) */
3652 if( signature_size == 0 )
3653 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003654
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003655 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_SIGN_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003656 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003657 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003658 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003659 {
3660 status = PSA_ERROR_INVALID_ARGUMENT;
3661 goto exit;
3662 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003663
Gilles Peskineedc64242019-08-07 21:05:07 +02003664#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3665 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3666 {
3667 if( drv->asymmetric == NULL ||
3668 drv->asymmetric->p_sign == NULL )
3669 {
3670 status = PSA_ERROR_NOT_SUPPORTED;
3671 goto exit;
3672 }
3673 status = drv->asymmetric->p_sign( drv_context,
3674 slot->data.se.slot_number,
3675 alg,
3676 hash, hash_length,
3677 signature, signature_size,
3678 signature_length );
3679 }
3680 else
3681#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine20035e32018-02-03 22:44:14 +01003682#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003683 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003684 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003685 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003686
Steven Cooreman4fed4552020-08-03 14:46:03 +02003687 status = psa_load_rsa_representation( slot->attr.type,
3688 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003689 slot->data.key.bytes,
Steven Cooremana01795d2020-07-24 22:48:15 +02003690 &rsa );
3691 if( status != PSA_SUCCESS )
3692 goto exit;
3693
Steven Cooremana2371e52020-07-28 14:30:39 +02003694 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003695 alg,
3696 hash, hash_length,
3697 signature, signature_size,
3698 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003699
Steven Cooremana2371e52020-07-28 14:30:39 +02003700 mbedtls_rsa_free( rsa );
3701 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003702 }
3703 else
3704#endif /* defined(MBEDTLS_RSA_C) */
3705#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003706 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003707 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003708#if defined(MBEDTLS_ECDSA_C)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003709 if(
3710#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
3711 PSA_ALG_IS_ECDSA( alg )
3712#else
3713 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3714#endif
3715 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003716 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003717 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003718 status = psa_load_ecp_representation( slot->attr.type,
3719 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003720 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003721 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003722 if( status != PSA_SUCCESS )
3723 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003724 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003725 alg,
3726 hash, hash_length,
3727 signature, signature_size,
3728 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003729 mbedtls_ecp_keypair_free( ecp );
3730 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003731 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003732 else
3733#endif /* defined(MBEDTLS_ECDSA_C) */
3734 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003735 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003736 }
itayzafrir5c753392018-05-08 11:18:38 +03003737 }
3738 else
3739#endif /* defined(MBEDTLS_ECP_C) */
3740 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003741 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003742 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003743
3744exit:
3745 /* Fill the unused part of the output buffer (the whole buffer on error,
3746 * the trailing part on success) with something that isn't a valid mac
3747 * (barring an attack on the mac and deliberately-crafted input),
3748 * in case the caller doesn't check the return status properly. */
3749 if( status == PSA_SUCCESS )
3750 memset( signature + *signature_length, '!',
3751 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003752 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003753 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003754 /* If signature_size is 0 then we have nothing to do. We must not call
3755 * memset because signature may be NULL in this case. */
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003756 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003757}
3758
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003759psa_status_t psa_verify_hash( psa_key_handle_t handle,
3760 psa_algorithm_t alg,
3761 const uint8_t *hash,
3762 size_t hash_length,
3763 const uint8_t *signature,
3764 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003765{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003766 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003767 psa_status_t status;
Gilles Peskineedc64242019-08-07 21:05:07 +02003768#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3769 const psa_drv_se_t *drv;
3770 psa_drv_se_context_t *drv_context;
3771#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003772
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003773 status = psa_get_key_from_slot( handle, &slot, PSA_KEY_USAGE_VERIFY_HASH, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003774 if( status != PSA_SUCCESS )
3775 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003776
Gilles Peskineedc64242019-08-07 21:05:07 +02003777#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3778 if( psa_get_se_driver( slot->attr.lifetime, &drv, &drv_context ) )
3779 {
3780 if( drv->asymmetric == NULL ||
3781 drv->asymmetric->p_verify == NULL )
3782 return( PSA_ERROR_NOT_SUPPORTED );
3783 return( drv->asymmetric->p_verify( drv_context,
3784 slot->data.se.slot_number,
3785 alg,
3786 hash, hash_length,
3787 signature, signature_length ) );
3788 }
3789 else
3790#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine61b91d42018-06-08 16:09:36 +02003791#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003792 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003793 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003794 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003795
Steven Cooreman4fed4552020-08-03 14:46:03 +02003796 status = psa_load_rsa_representation( slot->attr.type,
3797 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003798 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003799 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003800 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003801 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02003802
Steven Cooremana2371e52020-07-28 14:30:39 +02003803 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003804 alg,
3805 hash, hash_length,
3806 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003807 mbedtls_rsa_free( rsa );
3808 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003809 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003810 }
3811 else
3812#endif /* defined(MBEDTLS_RSA_C) */
itayzafrir5c753392018-05-08 11:18:38 +03003813#if defined(MBEDTLS_ECP_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003814 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003815 {
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003816#if defined(MBEDTLS_ECDSA_C)
3817 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003818 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003819 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003820 status = psa_load_ecp_representation( slot->attr.type,
3821 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003822 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003823 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003824 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003825 return( status );
Steven Cooremana2371e52020-07-28 14:30:39 +02003826 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003827 hash, hash_length,
3828 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003829 mbedtls_ecp_keypair_free( ecp );
3830 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02003831 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02003832 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003833 else
3834#endif /* defined(MBEDTLS_ECDSA_C) */
3835 {
3836 return( PSA_ERROR_INVALID_ARGUMENT );
3837 }
itayzafrir5c753392018-05-08 11:18:38 +03003838 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003839 else
3840#endif /* defined(MBEDTLS_ECP_C) */
3841 {
3842 return( PSA_ERROR_NOT_SUPPORTED );
3843 }
3844}
3845
Gilles Peskine072ac562018-06-30 00:21:29 +02003846#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21)
3847static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3848 mbedtls_rsa_context *rsa )
3849{
3850 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3851 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3852 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3853 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3854}
3855#endif /* defined(MBEDTLS_RSA_C) && defined(MBEDTLS_PKCS1_V21) */
3856
Gilles Peskinec5487a82018-12-03 18:08:14 +01003857psa_status_t psa_asymmetric_encrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003858 psa_algorithm_t alg,
3859 const uint8_t *input,
3860 size_t input_length,
3861 const uint8_t *salt,
3862 size_t salt_length,
3863 uint8_t *output,
3864 size_t output_size,
3865 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003866{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003867 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003868 psa_status_t status;
3869
Darryl Green5cc689a2018-07-24 15:34:10 +01003870 (void) input;
3871 (void) input_length;
3872 (void) salt;
3873 (void) output;
3874 (void) output_size;
3875
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003876 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003877
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003878 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3879 return( PSA_ERROR_INVALID_ARGUMENT );
3880
Gilles Peskine28f8f302019-07-24 13:30:31 +02003881 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003882 if( status != PSA_SUCCESS )
3883 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003884 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3885 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003886 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003887
3888#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003889 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003890 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003891 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman4fed4552020-08-03 14:46:03 +02003892 status = psa_load_rsa_representation( slot->attr.type,
3893 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003894 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003895 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003896 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003897 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003898
3899 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003900 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003901 status = PSA_ERROR_BUFFER_TOO_SMALL;
3902 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003903 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003904#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003905 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003906 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003907 status = mbedtls_to_psa_error(
3908 mbedtls_rsa_pkcs1_encrypt( rsa,
3909 mbedtls_ctr_drbg_random,
3910 &global_data.ctr_drbg,
3911 MBEDTLS_RSA_PUBLIC,
3912 input_length,
3913 input,
3914 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003915 }
3916 else
3917#endif /* MBEDTLS_PKCS1_V15 */
3918#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003919 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003920 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003921 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003922 status = mbedtls_to_psa_error(
3923 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
3924 mbedtls_ctr_drbg_random,
3925 &global_data.ctr_drbg,
3926 MBEDTLS_RSA_PUBLIC,
3927 salt, salt_length,
3928 input_length,
3929 input,
3930 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003931 }
3932 else
3933#endif /* MBEDTLS_PKCS1_V21 */
3934 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003935 status = PSA_ERROR_INVALID_ARGUMENT;
3936 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003937 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003938rsa_exit:
3939 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003940 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003941
Steven Cooremana2371e52020-07-28 14:30:39 +02003942 mbedtls_rsa_free( rsa );
3943 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003944 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003945 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003946 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02003947#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003948 {
3949 return( PSA_ERROR_NOT_SUPPORTED );
3950 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003951}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003952
Gilles Peskinec5487a82018-12-03 18:08:14 +01003953psa_status_t psa_asymmetric_decrypt( psa_key_handle_t handle,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003954 psa_algorithm_t alg,
3955 const uint8_t *input,
3956 size_t input_length,
3957 const uint8_t *salt,
3958 size_t salt_length,
3959 uint8_t *output,
3960 size_t output_size,
3961 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003962{
Gilles Peskine2f060a82018-12-04 17:12:32 +01003963 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003964 psa_status_t status;
3965
Darryl Green5cc689a2018-07-24 15:34:10 +01003966 (void) input;
3967 (void) input_length;
3968 (void) salt;
3969 (void) output;
3970 (void) output_size;
3971
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003972 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003973
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003974 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3975 return( PSA_ERROR_INVALID_ARGUMENT );
3976
Gilles Peskine28f8f302019-07-24 13:30:31 +02003977 status = psa_get_transparent_key( handle, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003978 if( status != PSA_SUCCESS )
3979 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003980 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003981 return( PSA_ERROR_INVALID_ARGUMENT );
3982
3983#if defined(MBEDTLS_RSA_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003984 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003985 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003986 mbedtls_rsa_context *rsa = NULL;
3987 status = psa_load_rsa_representation( slot->attr.type,
3988 slot->data.key.data,
Steven Cooreman7f391872020-07-30 14:57:44 +02003989 slot->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02003990 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003991 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02003992 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003993
Steven Cooremana2371e52020-07-28 14:30:39 +02003994 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003995 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003996 status = PSA_ERROR_INVALID_ARGUMENT;
3997 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003998 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003999
4000#if defined(MBEDTLS_PKCS1_V15)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004001 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004002 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004003 status = mbedtls_to_psa_error(
4004 mbedtls_rsa_pkcs1_decrypt( rsa,
4005 mbedtls_ctr_drbg_random,
4006 &global_data.ctr_drbg,
4007 MBEDTLS_RSA_PRIVATE,
4008 output_length,
4009 input,
4010 output,
4011 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004012 }
4013 else
4014#endif /* MBEDTLS_PKCS1_V15 */
4015#if defined(MBEDTLS_PKCS1_V21)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004016 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004017 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004018 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004019 status = mbedtls_to_psa_error(
4020 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
4021 mbedtls_ctr_drbg_random,
4022 &global_data.ctr_drbg,
4023 MBEDTLS_RSA_PRIVATE,
4024 salt, salt_length,
4025 output_length,
4026 input,
4027 output,
4028 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004029 }
4030 else
4031#endif /* MBEDTLS_PKCS1_V21 */
4032 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004033 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004034 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004035
Steven Cooreman4fed4552020-08-03 14:46:03 +02004036rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004037 mbedtls_rsa_free( rsa );
4038 mbedtls_free( rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004039 return( status );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004040 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004041 else
Gilles Peskineb75e4f12018-06-08 17:44:47 +02004042#endif /* defined(MBEDTLS_RSA_C) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004043 {
4044 return( PSA_ERROR_NOT_SUPPORTED );
4045 }
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004046}
Gilles Peskine20035e32018-02-03 22:44:14 +01004047
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004048
4049
mohammad1603503973b2018-03-12 15:59:30 +02004050/****************************************************************/
4051/* Symmetric cryptography */
4052/****************************************************************/
4053
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004054/* Initialize the cipher operation structure. Once this function has been
4055 * called, psa_cipher_abort can run and will do the right thing. */
4056static psa_status_t psa_cipher_init( psa_cipher_operation_t *operation,
4057 psa_algorithm_t alg )
4058{
Gilles Peskinec06e0712018-06-20 16:21:04 +02004059 if( ! PSA_ALG_IS_CIPHER( alg ) )
4060 {
4061 memset( operation, 0, sizeof( *operation ) );
4062 return( PSA_ERROR_INVALID_ARGUMENT );
4063 }
4064
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004065 operation->alg = alg;
4066 operation->key_set = 0;
4067 operation->iv_set = 0;
4068 operation->iv_required = 1;
4069 operation->iv_size = 0;
4070 operation->block_size = 0;
4071 mbedtls_cipher_init( &operation->ctx.cipher );
4072 return( PSA_SUCCESS );
4073}
4074
Gilles Peskinee553c652018-06-04 16:22:46 +02004075static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004076 psa_key_handle_t handle,
Gilles Peskine7e928852018-06-04 16:23:10 +02004077 psa_algorithm_t alg,
4078 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004079{
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004080 int ret = 0;
4081 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004082 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004083 size_t key_bits;
4084 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004085 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4086 PSA_KEY_USAGE_ENCRYPT :
4087 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004088
Jaeden Amero36ee5d02019-02-19 09:25:10 +00004089 /* A context must be freshly initialized before it can be set up. */
4090 if( operation->alg != 0 )
4091 {
4092 return( PSA_ERROR_BAD_STATE );
4093 }
4094
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004095 status = psa_cipher_init( operation, alg );
4096 if( status != PSA_SUCCESS )
4097 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004098
Gilles Peskine28f8f302019-07-24 13:30:31 +02004099 status = psa_get_transparent_key( handle, &slot, usage, alg);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004100 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004101 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004102 key_bits = psa_get_key_slot_bits( slot );
mohammad1603503973b2018-03-12 15:59:30 +02004103
Gilles Peskine8e338702019-07-30 20:06:31 +02004104 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004105 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004106 {
4107 status = PSA_ERROR_NOT_SUPPORTED;
4108 goto exit;
4109 }
mohammad1603503973b2018-03-12 15:59:30 +02004110
mohammad1603503973b2018-03-12 15:59:30 +02004111 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004112 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004113 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004114
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004115#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004116 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004117 {
4118 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004119 uint8_t keys[24];
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004120 memcpy( keys, slot->data.key.data, 16 );
4121 memcpy( keys + 16, slot->data.key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004122 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4123 keys,
4124 192, cipher_operation );
4125 }
4126 else
4127#endif
4128 {
4129 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004130 slot->data.key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004131 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004132 }
Moran Peker41deec42018-04-04 15:43:05 +03004133 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004134 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004135
mohammad16038481e742018-03-18 13:57:31 +02004136#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004137 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004138 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004139 case PSA_ALG_CBC_NO_PADDING:
4140 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4141 MBEDTLS_PADDING_NONE );
4142 break;
4143 case PSA_ALG_CBC_PKCS7:
4144 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4145 MBEDTLS_PADDING_PKCS7 );
4146 break;
4147 default:
4148 /* The algorithm doesn't involve padding. */
4149 ret = 0;
4150 break;
4151 }
4152 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004153 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004154#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4155
mohammad1603503973b2018-03-12 15:59:30 +02004156 operation->key_set = 1;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004157 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
Gilles Peskine8e338702019-07-30 20:06:31 +02004158 PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type ) );
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004159 if( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG )
mohammad16038481e742018-03-18 13:57:31 +02004160 {
Gilles Peskine8e338702019-07-30 20:06:31 +02004161 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_SIZE( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004162 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004163#if defined(MBEDTLS_CHACHA20_C)
4164 else
4165 if( alg == PSA_ALG_CHACHA20 )
4166 operation->iv_size = 12;
4167#endif
mohammad1603503973b2018-03-12 15:59:30 +02004168
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004169exit:
4170 if( status == 0 )
4171 status = mbedtls_to_psa_error( ret );
4172 if( status != 0 )
4173 psa_cipher_abort( operation );
4174 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004175}
4176
Gilles Peskinefe119512018-07-08 21:39:34 +02004177psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004178 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004179 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004180{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004181 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004182}
4183
Gilles Peskinefe119512018-07-08 21:39:34 +02004184psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004185 psa_key_handle_t handle,
Gilles Peskinefe119512018-07-08 21:39:34 +02004186 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004187{
Gilles Peskinec5487a82018-12-03 18:08:14 +01004188 return( psa_cipher_setup( operation, handle, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004189}
4190
Gilles Peskinefe119512018-07-08 21:39:34 +02004191psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004192 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004193 size_t iv_size,
4194 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004195{
itayzafrir534bd7c2018-08-02 13:56:32 +03004196 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004197 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004198 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03004199 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00004200 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03004201 }
Moran Peker41deec42018-04-04 15:43:05 +03004202 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004203 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004204 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004205 goto exit;
4206 }
Gilles Peskine7e928852018-06-04 16:23:10 +02004207 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
4208 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004209 if( ret != 0 )
4210 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004211 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004212 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004213 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004214
mohammad16038481e742018-03-18 13:57:31 +02004215 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004216 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004217
Moran Peker395db872018-05-31 14:07:14 +03004218exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03004219 if( status != PSA_SUCCESS )
Moran Peker395db872018-05-31 14:07:14 +03004220 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004221 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004222}
4223
Gilles Peskinefe119512018-07-08 21:39:34 +02004224psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004225 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004226 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004227{
itayzafrir534bd7c2018-08-02 13:56:32 +03004228 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004229 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02004230 if( operation->iv_set || ! operation->iv_required )
itayzafrir534bd7c2018-08-02 13:56:32 +03004231 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00004232 return( PSA_ERROR_BAD_STATE );
itayzafrir534bd7c2018-08-02 13:56:32 +03004233 }
Moran Pekera28258c2018-05-29 16:25:04 +03004234 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004235 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004236 status = PSA_ERROR_INVALID_ARGUMENT;
4237 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004238 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004239 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4240 status = mbedtls_to_psa_error( ret );
4241exit:
4242 if( status == PSA_SUCCESS )
4243 operation->iv_set = 1;
4244 else
mohammad1603503973b2018-03-12 15:59:30 +02004245 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004246 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004247}
4248
Gilles Peskinee553c652018-06-04 16:22:46 +02004249psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4250 const uint8_t *input,
4251 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004252 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004253 size_t output_size,
4254 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004255{
itayzafrir534bd7c2018-08-02 13:56:32 +03004256 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004257 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004258 size_t expected_output_size;
Jaeden Ameroab439972019-02-15 14:12:05 +00004259
4260 if( operation->alg == 0 )
4261 {
4262 return( PSA_ERROR_BAD_STATE );
4263 }
4264
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004265 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004266 {
4267 /* Take the unprocessed partial block left over from previous
4268 * update calls, if any, plus the input to this call. Remove
4269 * the last partial block, if any. You get the data that will be
4270 * output in this call. */
4271 expected_output_size =
4272 ( operation->ctx.cipher.unprocessed_len + input_length )
4273 / operation->block_size * operation->block_size;
4274 }
4275 else
4276 {
4277 expected_output_size = input_length;
4278 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004279
Gilles Peskine89d789c2018-06-04 17:17:16 +02004280 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004281 {
4282 status = PSA_ERROR_BUFFER_TOO_SMALL;
4283 goto exit;
4284 }
mohammad160382759612018-03-12 18:16:40 +02004285
mohammad1603503973b2018-03-12 15:59:30 +02004286 ret = mbedtls_cipher_update( &operation->ctx.cipher, input,
Gilles Peskinee553c652018-06-04 16:22:46 +02004287 input_length, output, output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03004288 status = mbedtls_to_psa_error( ret );
4289exit:
4290 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004291 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004292 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004293}
4294
Gilles Peskinee553c652018-06-04 16:22:46 +02004295psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4296 uint8_t *output,
4297 size_t output_size,
4298 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004299{
David Saadab4ecc272019-02-14 13:48:10 +02004300 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Janos Follath315b51c2018-07-09 16:04:51 +01004301 int cipher_ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee553c652018-06-04 16:22:46 +02004302 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Moran Pekerbed71a22018-04-22 20:19:20 +03004303
mohammad1603503973b2018-03-12 15:59:30 +02004304 if( ! operation->key_set )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004305 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00004306 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03004307 }
4308 if( operation->iv_required && ! operation->iv_set )
4309 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00004310 return( PSA_ERROR_BAD_STATE );
Moran Peker7cb22b82018-06-05 11:40:02 +03004311 }
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004312
Gilles Peskine2c5219a2018-06-06 15:12:32 +02004313 if( operation->ctx.cipher.operation == MBEDTLS_ENCRYPT &&
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004314 operation->alg == PSA_ALG_CBC_NO_PADDING &&
4315 operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004316 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004317 status = PSA_ERROR_INVALID_ARGUMENT;
Janos Follath315b51c2018-07-09 16:04:51 +01004318 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004319 }
4320
Janos Follath315b51c2018-07-09 16:04:51 +01004321 cipher_ret = mbedtls_cipher_finish( &operation->ctx.cipher,
4322 temp_output_buffer,
4323 output_length );
4324 if( cipher_ret != 0 )
mohammad1603503973b2018-03-12 15:59:30 +02004325 {
Janos Follath315b51c2018-07-09 16:04:51 +01004326 status = mbedtls_to_psa_error( cipher_ret );
4327 goto error;
mohammad1603503973b2018-03-12 15:59:30 +02004328 }
Janos Follath315b51c2018-07-09 16:04:51 +01004329
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004330 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004331 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004332 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004333 memcpy( output, temp_output_buffer, *output_length );
4334 else
4335 {
Janos Follath315b51c2018-07-09 16:04:51 +01004336 status = PSA_ERROR_BUFFER_TOO_SMALL;
4337 goto error;
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004338 }
mohammad1603503973b2018-03-12 15:59:30 +02004339
Gilles Peskine3f108122018-12-07 18:14:53 +01004340 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004341 status = psa_cipher_abort( operation );
4342
4343 return( status );
4344
4345error:
4346
4347 *output_length = 0;
4348
Gilles Peskine3f108122018-12-07 18:14:53 +01004349 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004350 (void) psa_cipher_abort( operation );
4351
4352 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004353}
4354
Gilles Peskinee553c652018-06-04 16:22:46 +02004355psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4356{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004357 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004358 {
4359 /* The object has (apparently) been initialized but it is not
4360 * in use. It's ok to call abort on such an object, and there's
4361 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004362 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004363 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004364
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004365 /* Sanity check (shouldn't happen: operation->alg should
4366 * always have been initialized to a valid value). */
4367 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4368 return( PSA_ERROR_BAD_STATE );
4369
mohammad1603503973b2018-03-12 15:59:30 +02004370 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004371
Moran Peker41deec42018-04-04 15:43:05 +03004372 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004373 operation->key_set = 0;
4374 operation->iv_set = 0;
4375 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004376 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004377 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004378
Moran Peker395db872018-05-31 14:07:14 +03004379 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004380}
4381
Gilles Peskinea0655c32018-04-30 17:06:50 +02004382
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004383
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004384
mohammad16035955c982018-04-26 00:53:03 +03004385/****************************************************************/
4386/* AEAD */
4387/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004388
Gilles Peskineedf9a652018-08-17 18:11:56 +02004389typedef struct
4390{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004391 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004392 const mbedtls_cipher_info_t *cipher_info;
4393 union
4394 {
4395#if defined(MBEDTLS_CCM_C)
4396 mbedtls_ccm_context ccm;
4397#endif /* MBEDTLS_CCM_C */
4398#if defined(MBEDTLS_GCM_C)
4399 mbedtls_gcm_context gcm;
4400#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004401#if defined(MBEDTLS_CHACHAPOLY_C)
4402 mbedtls_chachapoly_context chachapoly;
4403#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004404 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004405 psa_algorithm_t core_alg;
4406 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004407 uint8_t tag_length;
4408} aead_operation_t;
4409
Gilles Peskine30a9e412019-01-14 18:36:12 +01004410static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004411{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004412 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004413 {
4414#if defined(MBEDTLS_CCM_C)
4415 case PSA_ALG_CCM:
4416 mbedtls_ccm_free( &operation->ctx.ccm );
4417 break;
4418#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004419#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004420 case PSA_ALG_GCM:
4421 mbedtls_gcm_free( &operation->ctx.gcm );
4422 break;
4423#endif /* MBEDTLS_GCM_C */
4424 }
4425}
4426
4427static psa_status_t psa_aead_setup( aead_operation_t *operation,
Gilles Peskinec5487a82018-12-03 18:08:14 +01004428 psa_key_handle_t handle,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004429 psa_key_usage_t usage,
4430 psa_algorithm_t alg )
4431{
4432 psa_status_t status;
4433 size_t key_bits;
4434 mbedtls_cipher_id_t cipher_id;
4435
Gilles Peskine28f8f302019-07-24 13:30:31 +02004436 status = psa_get_transparent_key( handle, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004437 if( status != PSA_SUCCESS )
4438 return( status );
4439
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004440 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004441
4442 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004443 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004444 &cipher_id );
4445 if( operation->cipher_info == NULL )
4446 return( PSA_ERROR_NOT_SUPPORTED );
4447
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004448 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004449 {
4450#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004451 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4452 operation->core_alg = PSA_ALG_CCM;
4453 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004454 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4455 * The call to mbedtls_ccm_encrypt_and_tag or
4456 * mbedtls_ccm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004457 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004458 return( PSA_ERROR_INVALID_ARGUMENT );
4459 mbedtls_ccm_init( &operation->ctx.ccm );
4460 status = mbedtls_to_psa_error(
4461 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004462 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004463 (unsigned int) key_bits ) );
4464 if( status != 0 )
4465 goto cleanup;
4466 break;
4467#endif /* MBEDTLS_CCM_C */
4468
4469#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004470 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4471 operation->core_alg = PSA_ALG_GCM;
4472 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004473 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4474 * The call to mbedtls_gcm_crypt_and_tag or
4475 * mbedtls_gcm_auth_decrypt will validate the tag length. */
Gilles Peskine8e338702019-07-30 20:06:31 +02004476 if( PSA_BLOCK_CIPHER_BLOCK_SIZE( operation->slot->attr.type ) != 16 )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004477 return( PSA_ERROR_INVALID_ARGUMENT );
4478 mbedtls_gcm_init( &operation->ctx.gcm );
4479 status = mbedtls_to_psa_error(
4480 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004481 operation->slot->data.key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004482 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004483 if( status != 0 )
4484 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004485 break;
4486#endif /* MBEDTLS_GCM_C */
4487
Gilles Peskine26869f22019-05-06 15:25:00 +02004488#if defined(MBEDTLS_CHACHAPOLY_C)
4489 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4490 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4491 operation->full_tag_length = 16;
4492 /* We only support the default tag length. */
4493 if( alg != PSA_ALG_CHACHA20_POLY1305 )
4494 return( PSA_ERROR_NOT_SUPPORTED );
4495 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4496 status = mbedtls_to_psa_error(
4497 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02004498 operation->slot->data.key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004499 if( status != 0 )
4500 goto cleanup;
4501 break;
4502#endif /* MBEDTLS_CHACHAPOLY_C */
4503
Gilles Peskineedf9a652018-08-17 18:11:56 +02004504 default:
4505 return( PSA_ERROR_NOT_SUPPORTED );
4506 }
4507
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004508 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4509 {
4510 status = PSA_ERROR_INVALID_ARGUMENT;
4511 goto cleanup;
4512 }
4513 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004514
Gilles Peskineedf9a652018-08-17 18:11:56 +02004515 return( PSA_SUCCESS );
4516
4517cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004518 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004519 return( status );
4520}
4521
Gilles Peskinec5487a82018-12-03 18:08:14 +01004522psa_status_t psa_aead_encrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004523 psa_algorithm_t alg,
4524 const uint8_t *nonce,
4525 size_t nonce_length,
4526 const uint8_t *additional_data,
4527 size_t additional_data_length,
4528 const uint8_t *plaintext,
4529 size_t plaintext_length,
4530 uint8_t *ciphertext,
4531 size_t ciphertext_size,
4532 size_t *ciphertext_length )
4533{
mohammad16035955c982018-04-26 00:53:03 +03004534 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004535 aead_operation_t operation;
mohammad160315223a82018-06-03 17:19:55 +03004536 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004537
mohammad1603f08a5502018-06-03 15:05:47 +03004538 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004539
Gilles Peskinec5487a82018-12-03 18:08:14 +01004540 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004541 if( status != PSA_SUCCESS )
4542 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004543
Gilles Peskineedf9a652018-08-17 18:11:56 +02004544 /* For all currently supported modes, the tag is at the end of the
4545 * ciphertext. */
4546 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4547 {
4548 status = PSA_ERROR_BUFFER_TOO_SMALL;
4549 goto exit;
4550 }
4551 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004552
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004553#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004554 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004555 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004556 status = mbedtls_to_psa_error(
4557 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4558 MBEDTLS_GCM_ENCRYPT,
4559 plaintext_length,
4560 nonce, nonce_length,
4561 additional_data, additional_data_length,
4562 plaintext, ciphertext,
4563 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004564 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004565 else
4566#endif /* MBEDTLS_GCM_C */
4567#if defined(MBEDTLS_CCM_C)
4568 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004569 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004570 status = mbedtls_to_psa_error(
4571 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4572 plaintext_length,
4573 nonce, nonce_length,
4574 additional_data,
4575 additional_data_length,
4576 plaintext, ciphertext,
4577 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004578 }
mohammad16035c8845f2018-05-09 05:40:09 -07004579 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004580#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004581#if defined(MBEDTLS_CHACHAPOLY_C)
4582 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4583 {
4584 if( nonce_length != 12 || operation.tag_length != 16 )
4585 {
4586 status = PSA_ERROR_NOT_SUPPORTED;
4587 goto exit;
4588 }
4589 status = mbedtls_to_psa_error(
4590 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4591 plaintext_length,
4592 nonce,
4593 additional_data,
4594 additional_data_length,
4595 plaintext,
4596 ciphertext,
4597 tag ) );
4598 }
4599 else
4600#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004601 {
mohammad1603554faad2018-06-03 15:07:38 +03004602 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004603 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004604
Gilles Peskineedf9a652018-08-17 18:11:56 +02004605 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4606 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004607
Gilles Peskineedf9a652018-08-17 18:11:56 +02004608exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004609 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004610 if( status == PSA_SUCCESS )
4611 *ciphertext_length = plaintext_length + operation.tag_length;
4612 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004613}
4614
Gilles Peskineee652a32018-06-01 19:23:52 +02004615/* Locate the tag in a ciphertext buffer containing the encrypted data
4616 * followed by the tag. Return the length of the part preceding the tag in
4617 * *plaintext_length. This is the size of the plaintext in modes where
4618 * the encrypted data has the same size as the plaintext, such as
4619 * CCM and GCM. */
4620static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4621 const uint8_t *ciphertext,
4622 size_t ciphertext_length,
4623 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004624 const uint8_t **p_tag )
4625{
4626 size_t payload_length;
4627 if( tag_length > ciphertext_length )
4628 return( PSA_ERROR_INVALID_ARGUMENT );
4629 payload_length = ciphertext_length - tag_length;
4630 if( payload_length > plaintext_size )
4631 return( PSA_ERROR_BUFFER_TOO_SMALL );
4632 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004633 return( PSA_SUCCESS );
4634}
4635
Gilles Peskinec5487a82018-12-03 18:08:14 +01004636psa_status_t psa_aead_decrypt( psa_key_handle_t handle,
mohammad16035955c982018-04-26 00:53:03 +03004637 psa_algorithm_t alg,
4638 const uint8_t *nonce,
4639 size_t nonce_length,
4640 const uint8_t *additional_data,
4641 size_t additional_data_length,
4642 const uint8_t *ciphertext,
4643 size_t ciphertext_length,
4644 uint8_t *plaintext,
4645 size_t plaintext_size,
4646 size_t *plaintext_length )
4647{
mohammad16035955c982018-04-26 00:53:03 +03004648 psa_status_t status;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004649 aead_operation_t operation;
4650 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004651
Gilles Peskineee652a32018-06-01 19:23:52 +02004652 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004653
Gilles Peskinec5487a82018-12-03 18:08:14 +01004654 status = psa_aead_setup( &operation, handle, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004655 if( status != PSA_SUCCESS )
4656 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004657
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004658 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4659 ciphertext, ciphertext_length,
4660 plaintext_size, &tag );
4661 if( status != PSA_SUCCESS )
4662 goto exit;
4663
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004664#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004665 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004666 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004667 status = mbedtls_to_psa_error(
4668 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4669 ciphertext_length - operation.tag_length,
4670 nonce, nonce_length,
4671 additional_data,
4672 additional_data_length,
4673 tag, operation.tag_length,
4674 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004675 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004676 else
4677#endif /* MBEDTLS_GCM_C */
4678#if defined(MBEDTLS_CCM_C)
4679 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004680 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004681 status = mbedtls_to_psa_error(
4682 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4683 ciphertext_length - operation.tag_length,
4684 nonce, nonce_length,
4685 additional_data,
4686 additional_data_length,
4687 ciphertext, plaintext,
4688 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004689 }
mohammad160339574652018-06-01 04:39:53 -07004690 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004691#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004692#if defined(MBEDTLS_CHACHAPOLY_C)
4693 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4694 {
4695 if( nonce_length != 12 || operation.tag_length != 16 )
4696 {
4697 status = PSA_ERROR_NOT_SUPPORTED;
4698 goto exit;
4699 }
4700 status = mbedtls_to_psa_error(
4701 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4702 ciphertext_length - operation.tag_length,
4703 nonce,
4704 additional_data,
4705 additional_data_length,
4706 tag,
4707 ciphertext,
4708 plaintext ) );
4709 }
4710 else
4711#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004712 {
mohammad1603554faad2018-06-03 15:07:38 +03004713 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004714 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004715
Gilles Peskineedf9a652018-08-17 18:11:56 +02004716 if( status != PSA_SUCCESS && plaintext_size != 0 )
4717 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004718
Gilles Peskineedf9a652018-08-17 18:11:56 +02004719exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004720 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004721 if( status == PSA_SUCCESS )
4722 *plaintext_length = ciphertext_length - operation.tag_length;
4723 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004724}
4725
Gilles Peskinea0655c32018-04-30 17:06:50 +02004726
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004727
Gilles Peskine20035e32018-02-03 22:44:14 +01004728/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004729/* Generators */
4730/****************************************************************/
4731
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004732#define HKDF_STATE_INIT 0 /* no input yet */
4733#define HKDF_STATE_STARTED 1 /* got salt */
4734#define HKDF_STATE_KEYED 2 /* got key */
4735#define HKDF_STATE_OUTPUT 3 /* output started */
4736
Gilles Peskinecbe66502019-05-16 16:59:18 +02004737static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004738 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004739{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004740 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4741 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004742 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004743 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004744}
4745
4746
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004747psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004748{
4749 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004750 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004751 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004752 {
4753 /* The object has (apparently) been initialized but it is not
4754 * in use. It's ok to call abort on such an object, and there's
4755 * nothing to do. */
4756 }
4757 else
Gilles Peskinebef7f142018-07-12 17:22:21 +02004758#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004759 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004760 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004761 mbedtls_free( operation->ctx.hkdf.info );
4762 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004763 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004764 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004765 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004766 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004767 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004768 if( operation->ctx.tls12_prf.seed != NULL )
4769 {
4770 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4771 operation->ctx.tls12_prf.seed_length );
4772 mbedtls_free( operation->ctx.tls12_prf.seed );
4773 }
4774
4775 if( operation->ctx.tls12_prf.label != NULL )
4776 {
4777 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4778 operation->ctx.tls12_prf.label_length );
4779 mbedtls_free( operation->ctx.tls12_prf.label );
4780 }
4781
4782 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4783
4784 /* We leave the fields Ai and output_block to be erased safely by the
4785 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004786 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004787 else
4788#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004789 {
4790 status = PSA_ERROR_BAD_STATE;
4791 }
Janos Follath083036a2019-06-11 10:22:26 +01004792 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004793 return( status );
4794}
4795
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004796psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004797 size_t *capacity)
4798{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004799 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004800 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004801 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004802 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004803 }
4804
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004805 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004806 return( PSA_SUCCESS );
4807}
4808
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004809psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004810 size_t capacity )
4811{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004812 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004813 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004814 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004815 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004816 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004817 return( PSA_SUCCESS );
4818}
4819
Gilles Peskinebef7f142018-07-12 17:22:21 +02004820#if defined(MBEDTLS_MD_C)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004821/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004822 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004823static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004824 psa_algorithm_t hash_alg,
4825 uint8_t *output,
4826 size_t output_length )
4827{
4828 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
4829 psa_status_t status;
4830
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004831 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4832 return( PSA_ERROR_BAD_STATE );
4833 hkdf->state = HKDF_STATE_OUTPUT;
4834
Gilles Peskinebef7f142018-07-12 17:22:21 +02004835 while( output_length != 0 )
4836 {
4837 /* Copy what remains of the current block */
4838 uint8_t n = hash_length - hkdf->offset_in_block;
4839 if( n > output_length )
4840 n = (uint8_t) output_length;
4841 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4842 output += n;
4843 output_length -= n;
4844 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004845 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004846 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004847 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004848 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004849 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004850 * object was corrupted or if this function is called directly
4851 * inside the library. */
4852 if( hkdf->block_number == 0xff )
4853 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004854
4855 /* We need a new block */
4856 ++hkdf->block_number;
4857 hkdf->offset_in_block = 0;
4858 status = psa_hmac_setup_internal( &hkdf->hmac,
4859 hkdf->prk, hash_length,
4860 hash_alg );
4861 if( status != PSA_SUCCESS )
4862 return( status );
4863 if( hkdf->block_number != 1 )
4864 {
4865 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4866 hkdf->output_block,
4867 hash_length );
4868 if( status != PSA_SUCCESS )
4869 return( status );
4870 }
4871 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4872 hkdf->info,
4873 hkdf->info_length );
4874 if( status != PSA_SUCCESS )
4875 return( status );
4876 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4877 &hkdf->block_number, 1 );
4878 if( status != PSA_SUCCESS )
4879 return( status );
4880 status = psa_hmac_finish_internal( &hkdf->hmac,
4881 hkdf->output_block,
4882 sizeof( hkdf->output_block ) );
4883 if( status != PSA_SUCCESS )
4884 return( status );
4885 }
4886
4887 return( PSA_SUCCESS );
4888}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004889
Janos Follath7742fee2019-06-17 12:58:10 +01004890static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4891 psa_tls12_prf_key_derivation_t *tls12_prf,
4892 psa_algorithm_t alg )
4893{
4894 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
4895 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004896 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4897 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004898
Janos Follath7742fee2019-06-17 12:58:10 +01004899 /* We can't be wanting more output after block 0xff, otherwise
4900 * the capacity check in psa_key_derivation_output_bytes() would have
4901 * prevented this call. It could happen only if the operation
4902 * object was corrupted or if this function is called directly
4903 * inside the library. */
4904 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004905 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004906
4907 /* We need a new block */
4908 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004909 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004910
4911 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4912 *
4913 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4914 *
4915 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4916 * HMAC_hash(secret, A(2) + seed) +
4917 * HMAC_hash(secret, A(3) + seed) + ...
4918 *
4919 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004920 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004921 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004922 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004923 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004924 * is currently extracted as `output_block` and where i is
4925 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004926 */
4927
Janos Follathea29bfb2019-06-19 12:21:20 +01004928 /* Save the hash context before using it, to preserve the hash state with
4929 * only the inner padding in it. We need this, because inner padding depends
4930 * on the key (secret in the RFC's terminology). */
4931 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4932 if( status != PSA_SUCCESS )
4933 goto cleanup;
4934
4935 /* Calculate A(i) where i = tls12_prf->block_number. */
4936 if( tls12_prf->block_number == 1 )
4937 {
4938 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4939 * the variable seed and in this instance means it in the context of the
4940 * P_hash function, where seed = label + seed.) */
4941 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4942 tls12_prf->label, tls12_prf->label_length );
4943 if( status != PSA_SUCCESS )
4944 goto cleanup;
4945 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4946 tls12_prf->seed, tls12_prf->seed_length );
4947 if( status != PSA_SUCCESS )
4948 goto cleanup;
4949 }
4950 else
4951 {
4952 /* A(i) = HMAC_hash(secret, A(i-1)) */
4953 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4954 tls12_prf->Ai, hash_length );
4955 if( status != PSA_SUCCESS )
4956 goto cleanup;
4957 }
4958
4959 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4960 tls12_prf->Ai, hash_length );
4961 if( status != PSA_SUCCESS )
4962 goto cleanup;
4963 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4964 if( status != PSA_SUCCESS )
4965 goto cleanup;
4966
4967 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4968 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4969 tls12_prf->Ai, hash_length );
4970 if( status != PSA_SUCCESS )
4971 goto cleanup;
4972 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4973 tls12_prf->label, tls12_prf->label_length );
4974 if( status != PSA_SUCCESS )
4975 goto cleanup;
4976 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4977 tls12_prf->seed, tls12_prf->seed_length );
4978 if( status != PSA_SUCCESS )
4979 goto cleanup;
4980 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4981 tls12_prf->output_block, hash_length );
4982 if( status != PSA_SUCCESS )
4983 goto cleanup;
4984 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4985 if( status != PSA_SUCCESS )
4986 goto cleanup;
4987
Janos Follath7742fee2019-06-17 12:58:10 +01004988
4989cleanup:
4990
Janos Follathea29bfb2019-06-19 12:21:20 +01004991 cleanup_status = psa_hash_abort( &backup );
4992 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4993 status = cleanup_status;
4994
4995 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004996}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004997
Janos Follath844eb0e2019-06-19 12:10:49 +01004998static psa_status_t psa_key_derivation_tls12_prf_read(
4999 psa_tls12_prf_key_derivation_t *tls12_prf,
5000 psa_algorithm_t alg,
5001 uint8_t *output,
5002 size_t output_length )
5003{
5004 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
5005 uint8_t hash_length = PSA_HASH_SIZE( hash_alg );
5006 psa_status_t status;
5007 uint8_t offset, length;
5008
5009 while( output_length != 0 )
5010 {
5011 /* Check if we have fully processed the current block. */
5012 if( tls12_prf->left_in_block == 0 )
5013 {
5014 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5015 alg );
5016 if( status != PSA_SUCCESS )
5017 return( status );
5018
5019 continue;
5020 }
5021
5022 if( tls12_prf->left_in_block > output_length )
5023 length = (uint8_t) output_length;
5024 else
5025 length = tls12_prf->left_in_block;
5026
5027 offset = hash_length - tls12_prf->left_in_block;
5028 memcpy( output, tls12_prf->output_block + offset, length );
5029 output += length;
5030 output_length -= length;
5031 tls12_prf->left_in_block -= length;
5032 }
5033
5034 return( PSA_SUCCESS );
5035}
Gilles Peskinebef7f142018-07-12 17:22:21 +02005036#endif /* MBEDTLS_MD_C */
5037
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005038psa_status_t psa_key_derivation_output_bytes(
5039 psa_key_derivation_operation_t *operation,
5040 uint8_t *output,
5041 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005042{
5043 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005044 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005045
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005046 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005047 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005048 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005049 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005050 }
5051
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005052 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005053 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005054 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005055 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005056 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005057 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005058 goto exit;
5059 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005060 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005061 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005062 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005063 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005064 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5065 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005066 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005067 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005068 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005069 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005070 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005071
Gilles Peskinebef7f142018-07-12 17:22:21 +02005072#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005073 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005074 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005075 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005076 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005077 output, output_length );
5078 }
Janos Follathadbec812019-06-14 11:05:39 +01005079 else
Janos Follathadbec812019-06-14 11:05:39 +01005080 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine969c5d62019-01-16 15:53:06 +01005081 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005082 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005083 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005084 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005085 output_length );
5086 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005087 else
5088#endif /* MBEDTLS_MD_C */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005089 {
5090 return( PSA_ERROR_BAD_STATE );
5091 }
5092
5093exit:
5094 if( status != PSA_SUCCESS )
5095 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005096 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005097 * This allows us to differentiate between exhausted operations and
5098 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5099 * operations. */
5100 psa_algorithm_t alg = operation->alg;
5101 psa_key_derivation_abort( operation );
5102 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005103 memset( output, '!', output_length );
5104 }
5105 return( status );
5106}
5107
Gilles Peskine08542d82018-07-19 17:05:42 +02005108#if defined(MBEDTLS_DES_C)
5109static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5110{
5111 if( data_size >= 8 )
5112 mbedtls_des_key_set_parity( data );
5113 if( data_size >= 16 )
5114 mbedtls_des_key_set_parity( data + 8 );
5115 if( data_size >= 24 )
5116 mbedtls_des_key_set_parity( data + 16 );
5117}
5118#endif /* MBEDTLS_DES_C */
5119
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005120static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005121 psa_key_slot_t *slot,
5122 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005123 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005124{
5125 uint8_t *data = NULL;
5126 size_t bytes = PSA_BITS_TO_BYTES( bits );
5127 psa_status_t status;
5128
Gilles Peskine8e338702019-07-30 20:06:31 +02005129 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005130 return( PSA_ERROR_INVALID_ARGUMENT );
5131 if( bits % 8 != 0 )
5132 return( PSA_ERROR_INVALID_ARGUMENT );
5133 data = mbedtls_calloc( 1, bytes );
5134 if( data == NULL )
5135 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5136
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005137 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005138 if( status != PSA_SUCCESS )
5139 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005140#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005141 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005142 psa_des_set_key_parity( data, bytes );
5143#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005144 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005145
5146exit:
5147 mbedtls_free( data );
5148 return( status );
5149}
5150
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005151psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005152 psa_key_derivation_operation_t *operation,
Gilles Peskine98dd7792019-05-15 19:43:49 +02005153 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005154{
5155 psa_status_t status;
5156 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005157 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005158
5159 /* Reject any attempt to create a zero-length key so that we don't
5160 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5161 if( psa_get_key_bits( attributes ) == 0 )
5162 return( PSA_ERROR_INVALID_ARGUMENT );
5163
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005164 if( ! operation->can_output_key )
5165 return( PSA_ERROR_NOT_PERMITTED );
5166
Gilles Peskinedf179142019-07-15 22:02:14 +02005167 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE,
5168 attributes, handle, &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005169#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5170 if( driver != NULL )
5171 {
5172 /* Deriving a key in a secure element is not implemented yet. */
5173 status = PSA_ERROR_NOT_SUPPORTED;
5174 }
5175#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005176 if( status == PSA_SUCCESS )
5177 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005178 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005179 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005180 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005181 }
5182 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005183 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005184 if( status != PSA_SUCCESS )
5185 {
Gilles Peskine011e4282019-06-26 18:34:38 +02005186 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005187 *handle = 0;
5188 }
5189 return( status );
5190}
5191
Gilles Peskineeab56e42018-07-12 17:12:33 +02005192
5193
5194/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005195/* Key derivation */
5196/****************************************************************/
5197
Gilles Peskine969c5d62019-01-16 15:53:06 +01005198static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005199 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005200 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005201{
Janos Follath5fe19732019-06-20 15:09:30 +01005202 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5203 * initialisers for this union leave some bytes unspecified.) */
5204 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5205
Gilles Peskine969c5d62019-01-16 15:53:06 +01005206 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005207#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005208 if( PSA_ALG_IS_HKDF( kdf_alg ) ||
5209 PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5210 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005211 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005212 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005213 size_t hash_size = PSA_HASH_SIZE( hash_alg );
5214 if( hash_size == 0 )
5215 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005216 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5217 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005218 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005219 {
5220 return( PSA_ERROR_NOT_SUPPORTED );
5221 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005222 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005223 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005224 }
5225#endif /* MBEDTLS_MD_C */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005226 else
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005227 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005228}
5229
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005230psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005231 psa_algorithm_t alg )
5232{
5233 psa_status_t status;
5234
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005235 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005236 return( PSA_ERROR_BAD_STATE );
5237
Gilles Peskine6843c292019-01-18 16:44:49 +01005238 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5239 return( PSA_ERROR_INVALID_ARGUMENT );
5240 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005241 {
5242 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005243 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005244 }
5245 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5246 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005247 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005248 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005249 else
5250 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005251
5252 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005253 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005254 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005255}
5256
5257#if defined(MBEDTLS_MD_C)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005258static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005259 psa_algorithm_t hash_alg,
5260 psa_key_derivation_step_t step,
5261 const uint8_t *data,
5262 size_t data_length )
5263{
5264 psa_status_t status;
5265 switch( step )
5266 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005267 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005268 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005269 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005270 status = psa_hmac_setup_internal( &hkdf->hmac,
5271 data, data_length,
5272 hash_alg );
5273 if( status != PSA_SUCCESS )
5274 return( status );
5275 hkdf->state = HKDF_STATE_STARTED;
5276 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005277 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005278 /* If no salt was provided, use an empty salt. */
5279 if( hkdf->state == HKDF_STATE_INIT )
5280 {
5281 status = psa_hmac_setup_internal( &hkdf->hmac,
5282 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005283 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005284 if( status != PSA_SUCCESS )
5285 return( status );
5286 hkdf->state = HKDF_STATE_STARTED;
5287 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005288 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005289 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005290 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5291 data, data_length );
5292 if( status != PSA_SUCCESS )
5293 return( status );
5294 status = psa_hmac_finish_internal( &hkdf->hmac,
5295 hkdf->prk,
5296 sizeof( hkdf->prk ) );
5297 if( status != PSA_SUCCESS )
5298 return( status );
5299 hkdf->offset_in_block = PSA_HASH_SIZE( hash_alg );
5300 hkdf->block_number = 0;
5301 hkdf->state = HKDF_STATE_KEYED;
5302 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005303 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005304 if( hkdf->state == HKDF_STATE_OUTPUT )
5305 return( PSA_ERROR_BAD_STATE );
5306 if( hkdf->info_set )
5307 return( PSA_ERROR_BAD_STATE );
5308 hkdf->info_length = data_length;
5309 if( data_length != 0 )
5310 {
5311 hkdf->info = mbedtls_calloc( 1, data_length );
5312 if( hkdf->info == NULL )
5313 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5314 memcpy( hkdf->info, data, data_length );
5315 }
5316 hkdf->info_set = 1;
5317 return( PSA_SUCCESS );
5318 default:
5319 return( PSA_ERROR_INVALID_ARGUMENT );
5320 }
5321}
Janos Follathb03233e2019-06-11 15:30:30 +01005322
Janos Follathf08e2652019-06-13 09:05:41 +01005323static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5324 const uint8_t *data,
5325 size_t data_length )
5326{
5327 if( prf->state != TLS12_PRF_STATE_INIT )
5328 return( PSA_ERROR_BAD_STATE );
5329
Janos Follathd6dce9f2019-07-04 09:11:38 +01005330 if( data_length != 0 )
5331 {
5332 prf->seed = mbedtls_calloc( 1, data_length );
5333 if( prf->seed == NULL )
5334 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005335
Janos Follathd6dce9f2019-07-04 09:11:38 +01005336 memcpy( prf->seed, data, data_length );
5337 prf->seed_length = data_length;
5338 }
Janos Follathf08e2652019-06-13 09:05:41 +01005339
5340 prf->state = TLS12_PRF_STATE_SEED_SET;
5341
5342 return( PSA_SUCCESS );
5343}
5344
Janos Follath81550542019-06-13 14:26:34 +01005345static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5346 psa_algorithm_t hash_alg,
5347 const uint8_t *data,
5348 size_t data_length )
5349{
5350 psa_status_t status;
5351 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5352 return( PSA_ERROR_BAD_STATE );
5353
5354 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5355 if( status != PSA_SUCCESS )
5356 return( status );
5357
5358 prf->state = TLS12_PRF_STATE_KEY_SET;
5359
5360 return( PSA_SUCCESS );
5361}
5362
Janos Follath6660f0e2019-06-17 08:44:03 +01005363static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5364 psa_tls12_prf_key_derivation_t *prf,
5365 psa_algorithm_t hash_alg,
5366 const uint8_t *data,
5367 size_t data_length )
5368{
5369 psa_status_t status;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02005370 uint8_t pms[ 4 + 2 * PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN ];
5371 uint8_t *cur = pms;
Janos Follath6660f0e2019-06-17 08:44:03 +01005372
5373 if( data_length > PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN )
5374 return( PSA_ERROR_INVALID_ARGUMENT );
5375
5376 /* Quoting RFC 4279, Section 2:
5377 *
5378 * The premaster secret is formed as follows: if the PSK is N octets
5379 * long, concatenate a uint16 with the value N, N zero octets, a second
5380 * uint16 with the value N, and the PSK itself.
5381 */
5382
Janos Follath40e13932019-06-26 13:22:29 +01005383 *cur++ = ( data_length >> 8 ) & 0xff;
5384 *cur++ = ( data_length >> 0 ) & 0xff;
5385 memset( cur, 0, data_length );
5386 cur += data_length;
5387 *cur++ = pms[0];
5388 *cur++ = pms[1];
5389 memcpy( cur, data, data_length );
5390 cur += data_length;
Janos Follath6660f0e2019-06-17 08:44:03 +01005391
Janos Follath40e13932019-06-26 13:22:29 +01005392 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
Janos Follath6660f0e2019-06-17 08:44:03 +01005393
5394 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5395 return( status );
5396}
5397
Janos Follath63028dd2019-06-13 09:15:47 +01005398static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5399 const uint8_t *data,
5400 size_t data_length )
5401{
5402 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5403 return( PSA_ERROR_BAD_STATE );
5404
Janos Follathd6dce9f2019-07-04 09:11:38 +01005405 if( data_length != 0 )
5406 {
5407 prf->label = mbedtls_calloc( 1, data_length );
5408 if( prf->label == NULL )
5409 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005410
Janos Follathd6dce9f2019-07-04 09:11:38 +01005411 memcpy( prf->label, data, data_length );
5412 prf->label_length = data_length;
5413 }
Janos Follath63028dd2019-06-13 09:15:47 +01005414
5415 prf->state = TLS12_PRF_STATE_LABEL_SET;
5416
5417 return( PSA_SUCCESS );
5418}
5419
Janos Follathb03233e2019-06-11 15:30:30 +01005420static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5421 psa_algorithm_t hash_alg,
5422 psa_key_derivation_step_t step,
5423 const uint8_t *data,
5424 size_t data_length )
5425{
Janos Follathb03233e2019-06-11 15:30:30 +01005426 switch( step )
5427 {
Janos Follathf08e2652019-06-13 09:05:41 +01005428 case PSA_KEY_DERIVATION_INPUT_SEED:
5429 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005430 case PSA_KEY_DERIVATION_INPUT_SECRET:
5431 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005432 case PSA_KEY_DERIVATION_INPUT_LABEL:
5433 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005434 default:
5435 return( PSA_ERROR_INVALID_ARGUMENT );
5436 }
5437}
Janos Follath6660f0e2019-06-17 08:44:03 +01005438
5439static psa_status_t psa_tls12_prf_psk_to_ms_input(
5440 psa_tls12_prf_key_derivation_t *prf,
5441 psa_algorithm_t hash_alg,
5442 psa_key_derivation_step_t step,
5443 const uint8_t *data,
5444 size_t data_length )
5445{
5446 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005447 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005448 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5449 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005450 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005451
5452 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5453}
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005454#endif /* MBEDTLS_MD_C */
5455
Gilles Peskineb8965192019-09-24 16:21:10 +02005456/** Check whether the given key type is acceptable for the given
5457 * input step of a key derivation.
5458 *
5459 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5460 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5461 * Both secret and non-secret inputs can alternatively have the type
5462 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5463 * that the input was passed as a buffer rather than via a key object.
5464 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005465static int psa_key_derivation_check_input_type(
5466 psa_key_derivation_step_t step,
5467 psa_key_type_t key_type )
5468{
5469 switch( step )
5470 {
5471 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005472 if( key_type == PSA_KEY_TYPE_DERIVE )
5473 return( PSA_SUCCESS );
5474 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005475 return( PSA_SUCCESS );
5476 break;
5477 case PSA_KEY_DERIVATION_INPUT_LABEL:
5478 case PSA_KEY_DERIVATION_INPUT_SALT:
5479 case PSA_KEY_DERIVATION_INPUT_INFO:
5480 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005481 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5482 return( PSA_SUCCESS );
5483 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005484 return( PSA_SUCCESS );
5485 break;
5486 }
5487 return( PSA_ERROR_INVALID_ARGUMENT );
5488}
5489
Janos Follathb80a94e2019-06-12 15:54:46 +01005490static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005491 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005492 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005493 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005494 const uint8_t *data,
5495 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005496{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005497 psa_status_t status;
5498 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5499
5500 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005501 if( status != PSA_SUCCESS )
5502 goto exit;
5503
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005504#if defined(MBEDTLS_MD_C)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005505 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005506 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005507 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005508 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005509 step, data, data_length );
5510 }
k-stachowiak012dcc42019-08-13 14:55:03 +02005511 else if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005512 {
Janos Follathb03233e2019-06-11 15:30:30 +01005513 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5514 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5515 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005516 }
5517 else if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5518 {
5519 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5520 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5521 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005522 }
5523 else
5524#endif /* MBEDTLS_MD_C */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005525 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005526 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005527 return( PSA_ERROR_BAD_STATE );
5528 }
5529
Gilles Peskine224b0d62019-09-23 18:13:17 +02005530exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005531 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005532 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005533 return( status );
5534}
5535
Janos Follath51f4a0f2019-06-14 11:35:55 +01005536psa_status_t psa_key_derivation_input_bytes(
5537 psa_key_derivation_operation_t *operation,
5538 psa_key_derivation_step_t step,
5539 const uint8_t *data,
5540 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005541{
Gilles Peskineb8965192019-09-24 16:21:10 +02005542 return( psa_key_derivation_input_internal( operation, step,
5543 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005544 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005545}
5546
Janos Follath51f4a0f2019-06-14 11:35:55 +01005547psa_status_t psa_key_derivation_input_key(
5548 psa_key_derivation_operation_t *operation,
5549 psa_key_derivation_step_t step,
5550 psa_key_handle_t handle )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005551{
5552 psa_key_slot_t *slot;
5553 psa_status_t status;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005554
Gilles Peskine28f8f302019-07-24 13:30:31 +02005555 status = psa_get_transparent_key( handle, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005556 PSA_KEY_USAGE_DERIVE,
5557 operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005558 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005559 {
5560 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005561 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005562 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005563
5564 /* Passing a key object as a SECRET input unlocks the permission
5565 * to output to a key object. */
5566 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5567 operation->can_output_key = 1;
5568
Janos Follathb80a94e2019-06-12 15:54:46 +01005569 return( psa_key_derivation_input_internal( operation,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005570 step, slot->attr.type,
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005571 slot->data.key.data,
5572 slot->data.key.bytes ) );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005573}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005574
5575
5576
5577/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005578/* Key agreement */
5579/****************************************************************/
5580
Gilles Peskinea05219c2018-11-16 16:02:56 +01005581#if defined(MBEDTLS_ECDH_C)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005582static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5583 size_t peer_key_length,
5584 const mbedtls_ecp_keypair *our_key,
5585 uint8_t *shared_secret,
5586 size_t shared_secret_size,
5587 size_t *shared_secret_length )
5588{
Steven Cooremand4867872020-08-05 16:31:39 +02005589 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005590 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005591 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005592 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005593 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005594 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005595
Steven Cooreman4fed4552020-08-03 14:46:03 +02005596 status = psa_load_ecp_representation( PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5597 peer_key,
Steven Cooreman7f391872020-07-30 14:57:44 +02005598 peer_key_length,
Steven Cooreman7f391872020-07-30 14:57:44 +02005599 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005600 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005601 goto exit;
5602
Jaeden Amero97271b32019-01-10 19:38:51 +00005603 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005604 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005605 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005606 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005607 status = mbedtls_to_psa_error(
5608 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5609 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005610 goto exit;
5611
Jaeden Amero97271b32019-01-10 19:38:51 +00005612 status = mbedtls_to_psa_error(
5613 mbedtls_ecdh_calc_secret( &ecdh,
5614 shared_secret_length,
5615 shared_secret, shared_secret_size,
5616 mbedtls_ctr_drbg_random,
5617 &global_data.ctr_drbg ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005618 if( status != PSA_SUCCESS )
5619 goto exit;
5620 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5621 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005622
5623exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005624 if( status != PSA_SUCCESS )
5625 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005626 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005627 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005628 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005629
Jaeden Amero97271b32019-01-10 19:38:51 +00005630 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005631}
Gilles Peskinea05219c2018-11-16 16:02:56 +01005632#endif /* MBEDTLS_ECDH_C */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005633
Gilles Peskine01d718c2018-09-18 12:01:02 +02005634#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5635
Gilles Peskine0216fe12019-04-11 21:23:21 +02005636static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5637 psa_key_slot_t *private_key,
5638 const uint8_t *peer_key,
5639 size_t peer_key_length,
5640 uint8_t *shared_secret,
5641 size_t shared_secret_size,
5642 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005643{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005644 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005645 {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005646#if defined(MBEDTLS_ECDH_C)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005647 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005648 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005649 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005650 mbedtls_ecp_keypair *ecp = NULL;
Steven Cooreman7f391872020-07-30 14:57:44 +02005651 psa_status_t status = psa_load_ecp_representation(
Steven Cooreman4fed4552020-08-03 14:46:03 +02005652 private_key->attr.type,
Steven Cooreman7f391872020-07-30 14:57:44 +02005653 private_key->data.key.data,
5654 private_key->data.key.bytes,
Steven Cooreman7f391872020-07-30 14:57:44 +02005655 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005656 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005657 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005658 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005659 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005660 shared_secret, shared_secret_size,
5661 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005662 mbedtls_ecp_keypair_free( ecp );
5663 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005664 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005665#endif /* MBEDTLS_ECDH_C */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005666 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005667 (void) private_key;
5668 (void) peer_key;
5669 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005670 (void) shared_secret;
5671 (void) shared_secret_size;
5672 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005673 return( PSA_ERROR_NOT_SUPPORTED );
5674 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005675}
5676
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005677/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005678 * to potentially free embedded data structures and wipe confidential data.
5679 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005680static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005681 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005682 psa_key_slot_t *private_key,
5683 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005684 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005685{
5686 psa_status_t status;
5687 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5688 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005689 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005690
5691 /* Step 1: run the secret agreement algorithm to generate the shared
5692 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005693 status = psa_key_agreement_raw_internal( ka_alg,
5694 private_key,
5695 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005696 shared_secret,
5697 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005698 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005699 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005700 goto exit;
5701
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005702 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005703 * the shared secret. A shared secret is permitted wherever a key
5704 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005705 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005706 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005707 shared_secret,
5708 shared_secret_length );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005709
Gilles Peskine12313cd2018-06-20 00:20:32 +02005710exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005711 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005712 return( status );
5713}
5714
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005715psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005716 psa_key_derivation_step_t step,
5717 psa_key_handle_t private_key,
5718 const uint8_t *peer_key,
5719 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005720{
Gilles Peskine2f060a82018-12-04 17:12:32 +01005721 psa_key_slot_t *slot;
Gilles Peskine08542d82018-07-19 17:05:42 +02005722 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005723 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005724 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine28f8f302019-07-24 13:30:31 +02005725 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005726 PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005727 if( status != PSA_SUCCESS )
5728 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005729 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005730 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005731 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005732 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733 psa_key_derivation_abort( operation );
Gilles Peskine346797d2018-11-16 16:05:06 +01005734 return( status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005735}
5736
Gilles Peskinebe697d82019-05-16 18:00:41 +02005737psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
5738 psa_key_handle_t private_key,
5739 const uint8_t *peer_key,
5740 size_t peer_key_length,
5741 uint8_t *output,
5742 size_t output_size,
5743 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005744{
5745 psa_key_slot_t *slot;
5746 psa_status_t status;
5747
5748 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5749 {
5750 status = PSA_ERROR_INVALID_ARGUMENT;
5751 goto exit;
5752 }
Gilles Peskine28f8f302019-07-24 13:30:31 +02005753 status = psa_get_transparent_key( private_key, &slot,
Gilles Peskinef77a6ac2019-07-25 10:51:03 +02005754 PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005755 if( status != PSA_SUCCESS )
5756 goto exit;
5757
5758 status = psa_key_agreement_raw_internal( alg, slot,
5759 peer_key, peer_key_length,
5760 output, output_size,
5761 output_length );
5762
5763exit:
5764 if( status != PSA_SUCCESS )
5765 {
5766 /* If an error happens and is not handled properly, the output
5767 * may be used as a key to protect sensitive data. Arrange for such
5768 * a key to be random, which is likely to result in decryption or
5769 * verification errors. This is better than filling the buffer with
5770 * some constant data such as zeros, which would result in the data
5771 * being protected with a reproducible, easily knowable key.
5772 */
5773 psa_generate_random( output, output_size );
5774 *output_length = output_size;
5775 }
5776 return( status );
5777}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005778
5779
5780/****************************************************************/
5781/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005782/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005783
Gilles Peskine4c317f42018-07-12 01:24:09 +02005784psa_status_t psa_generate_random( uint8_t *output,
Gilles Peskine53d991e2018-07-12 01:14:59 +02005785 size_t output_size )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005786{
Janos Follath24eed8d2019-11-22 13:21:35 +00005787 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005788 GUARD_MODULE_INITIALIZED;
5789
Gilles Peskinef181eca2019-08-07 13:49:00 +02005790 while( output_size > MBEDTLS_CTR_DRBG_MAX_REQUEST )
5791 {
5792 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg,
5793 output,
5794 MBEDTLS_CTR_DRBG_MAX_REQUEST );
5795 if( ret != 0 )
5796 return( mbedtls_to_psa_error( ret ) );
5797 output += MBEDTLS_CTR_DRBG_MAX_REQUEST;
5798 output_size -= MBEDTLS_CTR_DRBG_MAX_REQUEST;
5799 }
5800
Gilles Peskinee59236f2018-01-27 23:32:46 +01005801 ret = mbedtls_ctr_drbg_random( &global_data.ctr_drbg, output, output_size );
5802 return( mbedtls_to_psa_error( ret ) );
5803}
5804
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005805#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5806#include "mbedtls/entropy_poll.h"
5807
Gilles Peskine7228da22019-07-15 11:06:15 +02005808psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005809 size_t seed_size )
5810{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005811 if( global_data.initialized )
5812 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005813
5814 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5815 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5816 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5817 return( PSA_ERROR_INVALID_ARGUMENT );
5818
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005819 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005820}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005821#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005822
Gilles Peskinee56e8782019-04-26 17:34:02 +02005823#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
5824static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5825 size_t domain_parameters_size,
5826 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005827{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005828 size_t i;
5829 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005830
Gilles Peskinee56e8782019-04-26 17:34:02 +02005831 if( domain_parameters_size == 0 )
5832 {
5833 *exponent = 65537;
5834 return( PSA_SUCCESS );
5835 }
5836
5837 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
5838 * support values that fit in a 32-bit integer, which is larger than
5839 * int on just about every platform anyway. */
5840 if( domain_parameters_size > sizeof( acc ) )
5841 return( PSA_ERROR_NOT_SUPPORTED );
5842 for( i = 0; i < domain_parameters_size; i++ )
5843 acc = ( acc << 8 ) | domain_parameters[i];
5844 if( acc > INT_MAX )
5845 return( PSA_ERROR_NOT_SUPPORTED );
5846 *exponent = acc;
5847 return( PSA_SUCCESS );
5848}
5849#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5850
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005851static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02005852 psa_key_slot_t *slot, size_t bits,
5853 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005854{
Gilles Peskine8e338702019-07-30 20:06:31 +02005855 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005856
Gilles Peskinee56e8782019-04-26 17:34:02 +02005857 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005858 return( PSA_ERROR_INVALID_ARGUMENT );
5859
Gilles Peskinee59236f2018-01-27 23:32:46 +01005860 if( key_type_is_raw_bytes( type ) )
5861 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005862 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005863
5864 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005865 if( status != PSA_SUCCESS )
5866 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005867
5868 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02005869 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
5870 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005871 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005872
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005873 status = psa_generate_random( slot->data.key.data,
5874 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005875 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005876 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005877
5878 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005879#if defined(MBEDTLS_DES_C)
5880 if( type == PSA_KEY_TYPE_DES )
Steven Cooreman71fd80d2020-07-07 21:12:27 +02005881 psa_des_set_key_parity( slot->data.key.data,
5882 slot->data.key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005883#endif /* MBEDTLS_DES_C */
5884 }
5885 else
5886
5887#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005888 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005889 {
Steven Cooremana01795d2020-07-24 22:48:15 +02005890 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00005891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005892 int exponent;
5893 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005894 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5895 return( PSA_ERROR_NOT_SUPPORTED );
5896 /* Accept only byte-aligned keys, for the same reasons as
5897 * in psa_import_rsa_key(). */
5898 if( bits % 8 != 0 )
5899 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02005900 status = psa_read_rsa_exponent( domain_parameters,
5901 domain_parameters_size,
5902 &exponent );
5903 if( status != PSA_SUCCESS )
5904 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02005905 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
5906 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskinee59236f2018-01-27 23:32:46 +01005907 mbedtls_ctr_drbg_random,
5908 &global_data.ctr_drbg,
5909 (unsigned int) bits,
5910 exponent );
5911 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005912 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02005913
5914 /* Make sure to always have an export representation available */
5915 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
5916
Steven Cooreman75b74362020-07-28 14:30:13 +02005917 status = psa_allocate_buffer_to_slot( slot, bytes );
5918 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02005919 {
5920 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02005921 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005922 }
Steven Cooremana01795d2020-07-24 22:48:15 +02005923
5924 status = psa_export_rsa_key( type,
5925 &rsa,
5926 slot->data.key.data,
5927 bytes,
5928 &slot->data.key.bytes );
5929 mbedtls_rsa_free( &rsa );
5930 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02005931 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02005932 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005933 }
5934 else
5935#endif /* MBEDTLS_RSA_C && MBEDTLS_GENPRIME */
5936
5937#if defined(MBEDTLS_ECP_C)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005938 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005939 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01005940 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01005941 mbedtls_ecp_group_id grp_id =
5942 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005943 const mbedtls_ecp_curve_info *curve_info =
5944 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02005945 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00005946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02005947 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005948 return( PSA_ERROR_NOT_SUPPORTED );
5949 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
5950 return( PSA_ERROR_NOT_SUPPORTED );
5951 if( curve_info->bit_size != bits )
5952 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanacda8342020-07-24 23:09:52 +02005953 mbedtls_ecp_keypair_init( &ecp );
5954 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskinee59236f2018-01-27 23:32:46 +01005955 mbedtls_ctr_drbg_random,
5956 &global_data.ctr_drbg );
5957 if( ret != 0 )
5958 {
Steven Cooremanacda8342020-07-24 23:09:52 +02005959 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005960 return( mbedtls_to_psa_error( ret ) );
5961 }
Steven Cooremanacda8342020-07-24 23:09:52 +02005962
5963
5964 /* Make sure to always have an export representation available */
5965 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02005966 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
5967 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02005968 {
5969 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005970 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005971 }
Steven Cooreman75b74362020-07-28 14:30:13 +02005972
5973 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +02005974 mbedtls_ecp_write_key( &ecp, slot->data.key.data, bytes ) );
5975
5976 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02005977 if( status != PSA_SUCCESS ) {
5978 memset( slot->data.key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02005979 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02005980 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02005981 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005982 }
5983 else
5984#endif /* MBEDTLS_ECP_C */
Steven Cooreman29149862020-08-05 15:43:42 +02005985 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01005986 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005987 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005988
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005989 return( PSA_SUCCESS );
5990}
Darryl Green0c6575a2018-11-07 16:05:30 +00005991
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005992psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Gilles Peskinee56e8782019-04-26 17:34:02 +02005993 psa_key_handle_t *handle )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005994{
5995 psa_status_t status;
5996 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005997 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02005998
Gilles Peskine0f84d622019-09-12 19:03:13 +02005999 /* Reject any attempt to create a zero-length key so that we don't
6000 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6001 if( psa_get_key_bits( attributes ) == 0 )
6002 return( PSA_ERROR_INVALID_ARGUMENT );
6003
Gilles Peskinedf179142019-07-15 22:02:14 +02006004 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE,
6005 attributes, handle, &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006006 if( status != PSA_SUCCESS )
6007 goto exit;
6008
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006009#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6010 if( driver != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00006011 {
Gilles Peskine11792082019-08-06 18:36:36 +02006012 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
6013 size_t pubkey_length = 0; /* We don't support this feature yet */
6014 if( drv->key_management == NULL ||
6015 drv->key_management->p_generate == NULL )
6016 {
6017 status = PSA_ERROR_NOT_SUPPORTED;
6018 goto exit;
6019 }
6020 status = drv->key_management->p_generate(
6021 psa_get_se_driver_context( driver ),
6022 slot->data.se.slot_number, attributes,
6023 NULL, 0, &pubkey_length );
Darryl Green0c6575a2018-11-07 16:05:30 +00006024 }
Gilles Peskine11792082019-08-06 18:36:36 +02006025 else
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006026#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006027 {
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006028 status = psa_generate_key_internal(
Gilles Peskine7e0cff92019-07-30 13:48:52 +02006029 slot, attributes->core.bits,
Gilles Peskinee56e8782019-04-26 17:34:02 +02006030 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006031 }
Gilles Peskine11792082019-08-06 18:36:36 +02006032
6033exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006034 if( status == PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006035 status = psa_finish_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006036 if( status != PSA_SUCCESS )
6037 {
Gilles Peskine011e4282019-06-26 18:34:38 +02006038 psa_fail_key_creation( slot, driver );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006039 *handle = 0;
6040 }
Darryl Green0c6575a2018-11-07 16:05:30 +00006041 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006042}
6043
6044
Gilles Peskinee59236f2018-01-27 23:32:46 +01006045
6046/****************************************************************/
6047/* Module setup */
6048/****************************************************************/
6049
Gilles Peskine5e769522018-11-20 21:59:56 +01006050psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6051 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6052 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6053{
6054 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6055 return( PSA_ERROR_BAD_STATE );
6056 global_data.entropy_init = entropy_init;
6057 global_data.entropy_free = entropy_free;
6058 return( PSA_SUCCESS );
6059}
6060
Gilles Peskinee59236f2018-01-27 23:32:46 +01006061void mbedtls_psa_crypto_free( void )
6062{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006063 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006064 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6065 {
6066 mbedtls_ctr_drbg_free( &global_data.ctr_drbg );
Gilles Peskine5e769522018-11-20 21:59:56 +01006067 global_data.entropy_free( &global_data.entropy );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006068 }
6069 /* Wipe all remaining data, including configuration.
6070 * In particular, this sets all state indicator to the value
6071 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006072 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006073#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006074 /* Unregister all secure element drivers, so that we restart from
6075 * a pristine state. */
6076 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006077#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006078}
6079
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006080#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6081/** Recover a transaction that was interrupted by a power failure.
6082 *
6083 * This function is called during initialization, before psa_crypto_init()
6084 * returns. If this function returns a failure status, the initialization
6085 * fails.
6086 */
6087static psa_status_t psa_crypto_recover_transaction(
6088 const psa_crypto_transaction_t *transaction )
6089{
6090 switch( transaction->unknown.type )
6091 {
6092 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6093 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006094 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006095 * is implemented.
6096 * https://github.com/ARMmbed/mbed-crypto/issues/218
6097 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006098 default:
6099 /* We found an unsupported transaction in the storage.
6100 * We don't know what state the storage is in. Give up. */
6101 return( PSA_ERROR_STORAGE_FAILURE );
6102 }
6103}
6104#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6105
Gilles Peskinee59236f2018-01-27 23:32:46 +01006106psa_status_t psa_crypto_init( void )
6107{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006108 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006109 const unsigned char drbg_seed[] = "PSA";
6110
Gilles Peskinec6b69072018-11-20 21:42:52 +01006111 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006112 if( global_data.initialized != 0 )
6113 return( PSA_SUCCESS );
6114
Gilles Peskine5e769522018-11-20 21:59:56 +01006115 /* Set default configuration if
6116 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6117 if( global_data.entropy_init == NULL )
6118 global_data.entropy_init = mbedtls_entropy_init;
6119 if( global_data.entropy_free == NULL )
6120 global_data.entropy_free = mbedtls_entropy_free;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006121
Gilles Peskinec6b69072018-11-20 21:42:52 +01006122 /* Initialize the random generator. */
Gilles Peskine5e769522018-11-20 21:59:56 +01006123 global_data.entropy_init( &global_data.entropy );
Jaeden Amero76541612019-06-04 17:14:43 +01006124#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6125 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6126 /* The PSA entropy injection feature depends on using NV seed as an entropy
6127 * source. Add NV seed as an entropy source for PSA entropy injection. */
6128 mbedtls_entropy_add_source( &global_data.entropy,
6129 mbedtls_nv_seed_poll, NULL,
6130 MBEDTLS_ENTROPY_BLOCK_SIZE,
6131 MBEDTLS_ENTROPY_SOURCE_STRONG );
6132#endif
Gilles Peskinee59236f2018-01-27 23:32:46 +01006133 mbedtls_ctr_drbg_init( &global_data.ctr_drbg );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006134 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine66fb1262018-12-10 16:29:04 +01006135 status = mbedtls_to_psa_error(
6136 mbedtls_ctr_drbg_seed( &global_data.ctr_drbg,
6137 mbedtls_entropy_func,
6138 &global_data.entropy,
6139 drbg_seed, sizeof( drbg_seed ) - 1 ) );
6140 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006141 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006142 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006143
Gilles Peskine66fb1262018-12-10 16:29:04 +01006144 status = psa_initialize_key_slots( );
6145 if( status != PSA_SUCCESS )
6146 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006147
Gilles Peskined9348f22019-10-01 15:22:29 +02006148#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6149 status = psa_init_all_se_drivers( );
6150 if( status != PSA_SUCCESS )
6151 goto exit;
6152#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6153
Gilles Peskine4b734222019-07-24 15:56:31 +02006154#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006155 status = psa_crypto_load_transaction( );
6156 if( status == PSA_SUCCESS )
6157 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006158 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6159 if( status != PSA_SUCCESS )
6160 goto exit;
6161 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006162 }
6163 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6164 {
6165 /* There's no transaction to complete. It's all good. */
6166 status = PSA_SUCCESS;
6167 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006168#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006169
Gilles Peskinec6b69072018-11-20 21:42:52 +01006170 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006171 global_data.initialized = 1;
6172
6173exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006174 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006175 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006176 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006177}
6178
6179#endif /* MBEDTLS_PSA_CRYPTO_C */